Add-XenHost

Last published : Nov 12, 2026
Adds to fields of a Host object.
Related information
Host cmdlets

Syntax

Add-XenHost [-XenHost] <Host> [-PassThru] [-OtherConfig <KeyValuePair[string, string]>]
    [-Logging <KeyValuePair[string, string]>] [-Tags <string>]
    [-LicenseServer <KeyValuePair[string, string]>]
    [-GuestVCPUsParams <KeyValuePair[string, string]>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenHost [-Ref] <XenRef[Host]> [-PassThru]
    [-OtherConfig <KeyValuePair[string, string]>]
    [-Logging <KeyValuePair[string, string]>] [-Tags <string>]
    [-LicenseServer <KeyValuePair[string, string]>]
    [-GuestVCPUsParams <KeyValuePair[string, string]>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenHost [-Uuid] <guid> [-PassThru] [-OtherConfig <KeyValuePair[string, string]>]
    [-Logging <KeyValuePair[string, string]>] [-Tags <string>]
    [-LicenseServer <KeyValuePair[string, string]>]
    [-GuestVCPUsParams <KeyValuePair[string, string]>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenHost [-Name] <string> [-PassThru] [-OtherConfig <KeyValuePair[string, string]>]
    [-Logging <KeyValuePair[string, string]>] [-Tags <string>]
    [-LicenseServer <KeyValuePair[string, string]>]
    [-GuestVCPUsParams <KeyValuePair[string, string]>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Adds values to the collection-valued fields of a Host. 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

-GuestVCPUsParams

Add the given key-value pair to the guest\_VCPUs\_params field of the given host.
Attribute Value
Type KeyValuePair[string, string]
Required False
Position Named
Accepts pipeline input False

-LicenseServer

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

-Logging

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

-Name

The name of the Host to operate on.
Attribute Value
Type string
Required True
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases name_label

-OtherConfig

Add the given key-value pair to the other\_config field of the given host.
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 Host object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[Host]
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

-Tags

Add the given value to the tags field of the given host. If the value is already in that Set, then do nothing.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-Uuid

The UUID of the Host 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

-XenHost

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

Inputs

  • Host
  • XenRef[Host]
  • guid
  • string

Outputs

  • Host
  • void

Examples

Example 1: Add to the OtherConfig field

PS> $entry = [System.Collections.Generic.KeyValuePair[string,string]]::new("region", "emea")
PS> Add-XenHost -OtherConfig $entry -Name "Demo Host"
Adds a value to the OtherConfig field of a Host. The parameter takes one entry of the map; a hashtable does not bind to it.

Example 2: Add to the Logging field

PS> $entry = [System.Collections.Generic.KeyValuePair[string,string]]::new("region", "emea")
PS> Add-XenHost -Logging $entry -Name "Demo Host"
Adds a value to the Logging field of a Host. The parameter takes one entry of the map; a hashtable does not bind to it.

Example 3: Add to the Tags field

PS> Add-XenHost -Tags "value" -Name "Demo Host"
Adds a value to the Tags field of a Host.
  • Host cmdlets
  • Class: Host
  • Using the XenServer PowerShell module