New-XenVMGroup
Creates a new VMGroup object.
Syntax
New-XenVMGroup -HashTable <hashtable> [-PassThru] [-BestEffort]
[-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
New-XenVMGroup -Record <VM_group> [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>]
[-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
New-XenVMGroup [-PassThru] [-NameLabel <string>] [-NameDescription <string>]
[-Placement {anti_affinity | normal | unknown}] [-BestEffort]
[-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
Description
Creates a new VMGroup object.
VMGroup: A VM group.
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 |
-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 VMGroup.
| Attribute | Value |
|---|---|
| Type | hashtable |
| Required | True |
| Position | Named |
| Accepts pipeline input | False |
-NameDescription
a notes field containing human-readable description
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-NameLabel
a human-readable name
| 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 |
-Placement
The placement policy of the VM group
| Attribute | Value |
|---|---|
| Type | placement_policy |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
| Accepted values | anti_affinity, normal, unknown |
-Record
An existing VMGroup record whose fields are used to create the new object.
| Attribute | Value |
|---|---|
| Type | VM_group |
| 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 |
-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
-
VM_group -
Task -
void
Examples
Example 1: Create a VMGroup from a table of fields
PS> New-XenVMGroup -HashTable @{ name_label = "Demo VMGroup" } -PassThru
The keys are the API's field names, so this form reads the same for every class whatever fields it happens to have. -PassThru returns the new VMGroup.
Example 2: Create a VMGroup from parameters
PS> New-XenVMGroup -NameLabel "new value" -PassThru
The same thing with one parameter per field, which is the form that tab-completes. Get-Help New-XenVMGroup -Full lists them all.
Example 3: Create a VMGroup from an existing one
PS> $record = Get-XenVMGroup | Select-Object -First 1
PS> New-XenVMGroup -Record $record -PassThru
-Record takes a whole VMGroup record, so an existing object can be used as the template for a new one.
Related links
-
Class: VMGroup
-
Using the XenServer PowerShell module