Remove-XenVMProperty

Last published : Nov 12, 2026
Removes values from fields of a VM object.
Related information
VM cmdlets

Syntax

Remove-XenVMProperty [-VM] <VM> [-PassThru] [-VCPUsParams <string>]
    [-HVMBootParams <string>] [-XenstoreData <string>] [-Tags <string>] [-NVRAM <string>]
    [-BlockedOperations {snapshot | clone | copy | create_template | revert | checkpoint | snapshot_with_quiesce | provision | start | start_on | pause | unpause | clean_shutdown | clean_reboot | hard_shutdown | power_state_reset | hard_reboot | suspend | csvm | resume | resume_on | pool_migrate | migrate_send | get_boot_record | send_sysrq | send_trigger | query_services | shutdown | call_plugin | changing_memory_live | awaiting_memory_live | changing_dynamic_range | changing_static_range | changing_memory_limits | changing_shadow_memory | changing_shadow_memory_live | changing_VCPUs | changing_VCPUs_live | changing_NVRAM | assert_operation_valid | data_source_op | update_allowed_operations | make_into_template | import | export | metadata_export | reverting | destroy | create_vtpm | sysprep | unknown}]
    [-OtherConfig <string>] [-Platform <string>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-XenVMProperty [-Ref] <XenRef[VM]> [-PassThru] [-VCPUsParams <string>]
    [-HVMBootParams <string>] [-XenstoreData <string>] [-Tags <string>] [-NVRAM <string>]
    [-BlockedOperations {snapshot | clone | copy | create_template | revert | checkpoint | snapshot_with_quiesce | provision | start | start_on | pause | unpause | clean_shutdown | clean_reboot | hard_shutdown | power_state_reset | hard_reboot | suspend | csvm | resume | resume_on | pool_migrate | migrate_send | get_boot_record | send_sysrq | send_trigger | query_services | shutdown | call_plugin | changing_memory_live | awaiting_memory_live | changing_dynamic_range | changing_static_range | changing_memory_limits | changing_shadow_memory | changing_shadow_memory_live | changing_VCPUs | changing_VCPUs_live | changing_NVRAM | assert_operation_valid | data_source_op | update_allowed_operations | make_into_template | import | export | metadata_export | reverting | destroy | create_vtpm | sysprep | unknown}]
    [-OtherConfig <string>] [-Platform <string>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-XenVMProperty [-Uuid] <guid> [-PassThru] [-VCPUsParams <string>]
    [-HVMBootParams <string>] [-XenstoreData <string>] [-Tags <string>] [-NVRAM <string>]
    [-BlockedOperations {snapshot | clone | copy | create_template | revert | checkpoint | snapshot_with_quiesce | provision | start | start_on | pause | unpause | clean_shutdown | clean_reboot | hard_shutdown | power_state_reset | hard_reboot | suspend | csvm | resume | resume_on | pool_migrate | migrate_send | get_boot_record | send_sysrq | send_trigger | query_services | shutdown | call_plugin | changing_memory_live | awaiting_memory_live | changing_dynamic_range | changing_static_range | changing_memory_limits | changing_shadow_memory | changing_shadow_memory_live | changing_VCPUs | changing_VCPUs_live | changing_NVRAM | assert_operation_valid | data_source_op | update_allowed_operations | make_into_template | import | export | metadata_export | reverting | destroy | create_vtpm | sysprep | unknown}]
    [-OtherConfig <string>] [-Platform <string>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-XenVMProperty [-Name] <string> [-PassThru] [-VCPUsParams <string>]
    [-HVMBootParams <string>] [-XenstoreData <string>] [-Tags <string>] [-NVRAM <string>]
    [-BlockedOperations {snapshot | clone | copy | create_template | revert | checkpoint | snapshot_with_quiesce | provision | start | start_on | pause | unpause | clean_shutdown | clean_reboot | hard_shutdown | power_state_reset | hard_reboot | suspend | csvm | resume | resume_on | pool_migrate | migrate_send | get_boot_record | send_sysrq | send_trigger | query_services | shutdown | call_plugin | changing_memory_live | awaiting_memory_live | changing_dynamic_range | changing_static_range | changing_memory_limits | changing_shadow_memory | changing_shadow_memory_live | changing_VCPUs | changing_VCPUs_live | changing_NVRAM | assert_operation_valid | data_source_op | update_allowed_operations | make_into_template | import | export | metadata_export | reverting | destroy | create_vtpm | sysprep | unknown}]
    [-OtherConfig <string>] [-Platform <string>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Removes values from the collection-valued fields of a VM. Each optional parameter listed below corresponds to a field that can be removed from.

Parameters

-Async

If set, the operation runs asynchronously and returns a Task object that can be used to track its progress. Available only for those fields whose underlying operation supports asynchronous invocation.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-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

-BlockedOperations

Update list of operations which have been explicitly blocked and an error code
Attribute Value
Type vm_operations
Required False
Position Named
Accepts pipeline input False
Accepted values snapshot, clone, copy, create_template, revert, checkpoint, snapshot_with_quiesce, provision, start, start_on, pause, unpause, clean_shutdown, clean_reboot, hard_shutdown, power_state_reset, hard_reboot, suspend, csvm, resume, resume_on, pool_migrate, migrate_send, get_boot_record, send_sysrq, send_trigger, query_services, shutdown, call_plugin, changing_memory_live, awaiting_memory_live, changing_dynamic_range, changing_static_range, changing_memory_limits, changing_shadow_memory, changing_shadow_memory_live, changing_VCPUs, changing_VCPUs_live, changing_NVRAM, assert_operation_valid, data_source_op, update_allowed_operations, make_into_template, import, export, metadata_export, reverting, destroy, create_vtpm, sysprep, unknown

-Confirm

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

-HVMBootParams

Remove the given key and its corresponding value from the HVM/boot\_params field of the given VM. If the key is not in that Map, then do nothing.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-NVRAM

This parameter has no documentation.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-Name

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

-OtherConfig

Remove the given key and its corresponding value from the other\_config field of the given VM. If the key is not in that Map, then do nothing.
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

-Platform

Remove the given key and its corresponding value from the platform field of the given VM. If the key is not in that Map, then do nothing.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-Ref

The VM object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[VM]
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

Remove the given value from the tags field of the given VM. If the value is not in that Set, then do nothing.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-Uuid

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

-VCPUsParams

Remove the given key and its corresponding value from the VCPUs/params field of the given VM. If the key is not in that Map, then do nothing.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-VM

The VM object to operate on.
Attribute Value
Type VM
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

-XenstoreData

Remove the given key and its corresponding value from the xenstore\_data field of the given VM. If the key is not in that Map, then do nothing.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

Inputs

  • VM
  • XenRef[VM]
  • guid
  • string

Outputs

  • VM
  • Task

Examples

Example 1: Remove from the VCPUsParams field

PS> Remove-XenVMProperty -VCPUsParams "value" -Name "Demo VM"
Removes a value from the VCPUsParams field of a VM.

Example 2: Remove from the HVMBootParams field

PS> Remove-XenVMProperty -HVMBootParams "value" -Name "Demo VM"
Removes a value from the HVMBootParams field of a VM.

Example 3: Remove from the XenstoreData field

PS> Remove-XenVMProperty -XenstoreData "value" -Name "Demo VM"
Removes a value from the XenstoreData field of a VM.
  • VM cmdlets
  • Class: VM
  • Using the XenServer PowerShell module