Add-XenUSBGroup

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

Syntax

Add-XenUSBGroup [-USBGroup] <USB_group> [-PassThru]
    [-OtherConfig <KeyValuePair[string, string]>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenUSBGroup [-Ref] <XenRef[USB_group]> [-PassThru]
    [-OtherConfig <KeyValuePair[string, string]>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenUSBGroup [-Uuid] <guid> [-PassThru] [-OtherConfig <KeyValuePair[string, string]>]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenUSBGroup [-Name] <string> [-PassThru] [-OtherConfig <KeyValuePair[string, string]>]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

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

-Name

The name of the USBGroup 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 USB\_group.
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 USBGroup object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[USB_group]
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

-USBGroup

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

-Uuid

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

  • USB_group
  • XenRef[USB_group]
  • guid
  • string

Outputs

  • USB_group
  • void

Examples

Example 1: Add to the OtherConfig field

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

Example 2: Add to the OtherConfig field piped from the getter

PS> $entry = [System.Collections.Generic.KeyValuePair[string,string]]::new("region", "emea")
PS> Get-XenUSBGroup -Name "Demo USBGroup" | Add-XenUSBGroup -OtherConfig $entry
Adds a value to the OtherConfig field of a USBGroup. The parameter takes one entry of the map; a hashtable does not bind to it. The object is piped in, which is the usual way once you already have it.

Example 3: Add to the OtherConfig field by uuid

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