Add-XenVMSS
Adds to fields of a VMSS object.
Syntax
Add-XenVMSS [-VMSS] <VMSS> [-PassThru] [-Schedule <KeyValuePair[string, string]>]
[-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenVMSS [-Ref] <XenRef[VMSS]> [-PassThru] [-Schedule <KeyValuePair[string, string]>]
[-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenVMSS [-Uuid] <guid> [-PassThru] [-Schedule <KeyValuePair[string, string]>]
[-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-XenVMSS [-Name] <string> [-PassThru] [-Schedule <KeyValuePair[string, string]>]
[-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Description
Adds values to the collection-valued fields of a VMSS. Each optional parameter listed below corresponds to a field that can be added to.
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 VMSS to operate on.
| Attribute | Value |
|---|---|
| Type | string |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByPropertyName) |
| Aliases | name_label |
-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 VMSS object to operate on, specified by its opaque reference.
| Attribute | Value |
|---|---|
| Type | XenRef[VMSS] |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByPropertyName) |
| Aliases | opaque_ref |
-Schedule
This parameter has no documentation.
| Attribute | Value |
|---|---|
| Type | KeyValuePair[string, string] |
| Required | False |
| 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 |
-Uuid
The UUID of the VMSS to operate on.
| Attribute | Value |
|---|---|
| Type | guid |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByPropertyName) |
-VMSS
The VMSS object to operate on.
| Attribute | Value |
|---|---|
| Type | VMSS |
| 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
-
VMSS -
XenRef[VMSS] -
guid -
string
Outputs
-
VMSS -
void
Examples
Example 1: Add a schedule
PS> $entry = [System.Collections.Generic.KeyValuePair[string,string]]::new("region", "emea")
PS> Add-XenVMSS -Schedule $entry -Name "Demo VMSS"
Example 2: Add a schedule piped from the getter
PS> $entry = [System.Collections.Generic.KeyValuePair[string,string]]::new("region", "emea")
PS> Get-XenVMSS -Name "Demo VMSS" | Add-XenVMSS -Schedule $entry
The object is piped in, which is the usual way once you already have it.
Example 3: Add a schedule by uuid
PS> $entry = [System.Collections.Generic.KeyValuePair[string,string]]::new("region", "emea")
PS> Add-XenVMSS -Schedule $entry -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
-Uuid is the way to be sure of exactly one object.
Related links
-
Class: VMSS
-
Using the XenServer PowerShell module