New-XenCluster
Creates a new Cluster object.
Syntax
New-XenCluster -HashTable <hashtable> [-PassThru] [-BestEffort]
[-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
New-XenCluster -Record <Cluster> [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>]
[-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
New-XenCluster [-PassThru] [-PIF <XenRef[PIF]>] [-ClusterStack <string>]
[-PoolAutoJoin <bool>] [-TokenTimeout <double>] [-TokenTimeoutCoefficient <double>]
[-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
[<CommonParameters>]
Description
Creates a new Cluster object.
Cluster.create: Creates a Cluster object and one Cluster\_host object as its first member.
Cluster: Cluster-wide Cluster metadata.
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 |
-ClusterStack
simply the string 'corosync'. No other cluster stacks are currently supported
| Attribute | Value |
|---|---|
| Type | string |
| 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 |
-HashTable
A hashtable of field names to values, from which to create the Cluster.
| Attribute | Value |
|---|---|
| Type | hashtable |
| Required | True |
| Position | Named |
| Accepts pipeline input | False |
-PIF
The PIF to connect the cluster's first cluster\_host to
| Attribute | Value |
|---|---|
| Type | XenRef[PIF] |
| 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 |
-PoolAutoJoin
true if xapi is automatically joining new pool members to the cluster
| Attribute | Value |
|---|---|
| Type | bool |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Record
An existing Cluster record whose fields are used to create the new object.
| Attribute | Value |
|---|---|
| Type | Cluster |
| Required | True |
| Position | Named |
| Accepts pipeline input | False |
-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 |
-TokenTimeout
Corosync token timeout in seconds
| Attribute | Value |
|---|---|
| Type | double |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-TokenTimeoutCoefficient
Corosync token timeout coefficient in seconds
| Attribute | Value |
|---|---|
| Type | double |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-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
-
None
Outputs
-
Cluster -
Task -
void
Examples
Example 1: Create a Cluster
PS> $pif = Get-XenPIF | Select-Object -First 1
PS> New-XenCluster -PIF $pif -ClusterStack "value" -PoolAutoJoin $true -TokenTimeout 0.0 -TokenTimeoutCoefficient 0.0 -PassThru
New-XenCluster takes the arguments of the create call rather than a record of fields, and needs all of them. -PassThru returns the new Cluster.
Example 2: Create a Cluster and wait for the task
PS> $pif = Get-XenPIF | Select-Object -First 1
PS> New-XenCluster -PIF $pif -ClusterStack "value" -PoolAutoJoin $true -TokenTimeout 0.0 -TokenTimeoutCoefficient 0.0 -Async -PassThru |
Wait-XenTask -ShowProgress
-Async hands the work to the server and returns the Task that represents it, which pipes into Wait-XenTask.
Example 3: See what would be created
PS> $pif = Get-XenPIF | Select-Object -First 1
PS> New-XenCluster -PIF $pif -ClusterStack "value" -PoolAutoJoin $true -TokenTimeout 0.0 -TokenTimeoutCoefficient 0.0 -WhatIf
Reports what would be created without creating it. Every cmdlet that changes the server takes -WhatIf and -Confirm.
Related links
-
Class: Cluster
-
Using the XenServer PowerShell module