Add-XenUser

Last published : Nov 12, 2026
\[Deprecated\] Adds to fields of a User object.
Related information
User cmdlets

Syntax

Add-XenUser [-User] <User> [-PassThru] [-OtherConfig <KeyValuePair[string, string]>]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenUser [-Ref] <XenRef[User]> [-PassThru]
    [-OtherConfig <KeyValuePair[string, string]>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenUser [-Uuid] <guid> [-PassThru] [-OtherConfig <KeyValuePair[string, string]>]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

DEPRECATED. This class has been deprecated.
Adds values to the collection-valued fields of a User. Each optional parameter listed below corresponds to a field that can be added to.

Parameters

-BestEffort

If set, the cmdlet continues processing further objects instead of throwing a terminating error when an operation fails for one object.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-Confirm

Prompts for confirmation before running the cmdlet.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False
Aliases cf

-OtherConfig

Add the given key-value pair to the other\_config field of the given user.
Attribute Value
Type KeyValuePair[string, string]
Required False
Position Named
Accepts pipeline input False

-PassThru

If set, the cmdlet returns the affected object. By default the cmdlet does not generate any output.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-Ref

The User object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[User]
Required True
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases opaque_ref

-SessionOpaqueRef

The session object on which to run the cmdlet. This overrides the default session and lets you target a specific open XenServer connection.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-User

The User object to operate on.
Attribute Value
Type User
Required True
Position 0
Accepts pipeline input True (ByValue)

-Uuid

The UUID of the User to operate on.
Attribute Value
Type guid
Required True
Position 0
Accepts pipeline input True (ByPropertyName)

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False
Aliases wi

Inputs

  • User
  • XenRef[User]
  • guid

Outputs

  • User
  • void

Examples

Example 1: Add to the OtherConfig field

PS> $entry = [System.Collections.Generic.KeyValuePair[string,string]]::new("region", "emea")
PS> Add-XenUser -OtherConfig $entry -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Adds a value to the OtherConfig field of a User. The parameter takes one entry of the map; a hashtable does not bind to it.

Example 2: Add to the OtherConfig field by reference

PS> $entry = [System.Collections.Generic.KeyValuePair[string,string]]::new("region", "emea")
PS> Add-XenUser -OtherConfig $entry -Ref OpaqueRef:f433bf7b-2b0c-5f53-7018-7d195addb3ca
Adds a value to the OtherConfig field of a User. The parameter takes one entry of the map; a hashtable does not bind to it. -Ref takes the opaque reference, which is what the API itself uses and what the records hold.

Example 3: Run against a particular session

PS> $entry = [System.Collections.Generic.KeyValuePair[string,string]]::new("region", "emea")
PS> Add-XenUser -OtherConfig $entry -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff -SessionOpaqueRef $session.opaque_ref
Every cmdlet takes -SessionOpaqueRef, which runs it against a session opened with Connect-XenServer rather than the default one. It is how a script drives more than one server at a time.
  • User cmdlets
  • Class: User
  • Using the XenServer PowerShell module