Set-XenVMAppliance

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

Syntax

Set-XenVMAppliance [-VMAppliance] <VM_appliance> [-PassThru] [-NameLabel <string>]
    [-NameDescription <string>] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf]
    [-Confirm] [<CommonParameters>]
Set-XenVMAppliance [-Ref] <XenRef[VM_appliance]> [-PassThru] [-NameLabel <string>]
    [-NameDescription <string>] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf]
    [-Confirm] [<CommonParameters>]
Set-XenVMAppliance [-Uuid] <guid> [-PassThru] [-NameLabel <string>]
    [-NameDescription <string>] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf]
    [-Confirm] [<CommonParameters>]
Set-XenVMAppliance [-Name] <string> [-PassThru] [-NameLabel <string>]
    [-NameDescription <string>] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf]
    [-Confirm] [<CommonParameters>]

Description

Changes writable fields of a VMAppliance. 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

-Name

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

-NameDescription

Set the name/description field of the given VM\_appliance.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-NameLabel

Set the name/label field of the given VM\_appliance.
Attribute Value
Type 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 VMAppliance object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[VM_appliance]
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 VMAppliance to operate on.
Attribute Value
Type guid
Required True
Position 0
Accepts pipeline input True (ByPropertyName)

-VMAppliance

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

-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

  • VM_appliance
  • XenRef[VM_appliance]
  • guid
  • string

Outputs

  • VM_appliance
  • void

Examples

Example 1: Set the NameLabel field

PS> Get-XenVMAppliance -Name "Demo VMAppliance" | Set-XenVMAppliance -NameLabel "new value"
Sets the NameLabel field of a VMAppliance.

Example 2: Set the NameDescription field

PS> Get-XenVMAppliance -Name "Demo VMAppliance" | Set-XenVMAppliance -NameDescription "new value"
Sets the NameDescription field of a VMAppliance.

Example 3: Set the NameLabel field by name

PS> Set-XenVMAppliance -NameLabel "new value" -Name "Demo VMAppliance"
Sets the NameLabel field of a VMAppliance. -Name matches on name\_label, which is not unique, so every match is operated on.