Set-XenConsole

Last published : Nov 12, 2026
Sets fields of a Console object.
Related information
Console cmdlets

Syntax

Set-XenConsole [-Console] <Console> [-PassThru] [-OtherConfig <hashtable>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenConsole [-Ref] <XenRef[Console]> [-PassThru] [-OtherConfig <hashtable>]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-XenConsole [-Uuid] <guid> [-PassThru] [-OtherConfig <hashtable>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Changes writable fields of a Console. Each optional parameter listed below corresponds to a field that can be set.

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

-Console

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

-OtherConfig

Set the other\_config field of the given console.
Attribute Value
Type hashtable
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 Console object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[Console]
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

-Uuid

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

  • Console
  • XenRef[Console]
  • guid

Outputs

  • Console
  • void

Examples

Example 1: Set the OtherConfig field

PS> Get-XenConsole -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Set-XenConsole -OtherConfig @{ "key" = "value" }
Sets the OtherConfig field of a Console.

Example 2: Set the OtherConfig field by uuid

PS> Set-XenConsole -OtherConfig @{ "key" = "value" } -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Sets the OtherConfig field of a Console. -Uuid is the way to be sure of exactly one object.

Example 3: Set the OtherConfig field by reference

PS> Set-XenConsole -OtherConfig @{ "key" = "value" } -Ref OpaqueRef:f433bf7b-2b0c-5f53-7018-7d195addb3ca
Sets the OtherConfig field of a Console. -Ref takes the opaque reference, which is what the API itself uses and what the records hold.