Invoke-XenClusterHost

Last published : Nov 12, 2026
Invokes an operation on a ClusterHost object.
Related information
ClusterHost cmdlets

Syntax

Invoke-XenClusterHost [-ClusterHost] <Cluster_host>
    -XenAction {Enable | ForceDestroy | Disable} [-PassThru] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
Invoke-XenClusterHost [-Ref] <XenRef[Cluster_host]>
    -XenAction {Enable | ForceDestroy | Disable} [-PassThru] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
Invoke-XenClusterHost [-Uuid] <guid> -XenAction {Enable | ForceDestroy | Disable}
    [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
    [<CommonParameters>]

Description

Invokes an operation on a ClusterHost object. Use the -XenAction parameter to select which operation to perform.
Enable: Enable cluster membership for a disabled cluster host.
ForceDestroy: Remove a host from an existing cluster forcefully.
Disable: Disable cluster membership for an enabled cluster host.

Parameters

-Async

If set, the operation runs asynchronously and returns a Task object that can be used to track its progress.
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

-ClusterHost

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

-Confirm

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

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

-Uuid

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

-XenAction

Selects which action to use.
Attribute Value
Type XenClusterHostAction
Required True
Position Named
Accepts pipeline input False
Accepted values Enable, ForceDestroy, Disable

Inputs

  • Cluster_host
  • XenRef[Cluster_host]
  • guid

Outputs

  • System.Object

Examples

Example 1: Run the Enable operation

PS> Get-XenClusterHost -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Invoke-XenClusterHost -XenAction Enable
Invokes the Enable operation on a ClusterHost.

Example 2: Run the Enable operation by uuid

PS> Invoke-XenClusterHost -XenAction Enable -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Invokes the Enable operation on a ClusterHost. -Uuid is the way to be sure of exactly one object.

Example 3: Run Enable asynchronously

PS> Invoke-XenClusterHost -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff -XenAction Enable -Async -PassThru | Wait-XenTask -ShowProgress
Runs the same operation asynchronously and follows the task it returns.