Set-VmcSddc
This cmdlet modifies a specified VMware Cloud on AWS software-defined data center (SDDC). This cmdlet can activate or deactivate site recovery for a specified SDDC, and upsize an SDDC.
Syntax
Parameters
Required | Parameter Name | Type | Position | Features | Description |
---|---|---|---|---|---|
required
|
Name | String | named |
|
Specifies a new name for the SDDC. |
required
|
Sddc | VmcSddc[] | named |
|
Specifies the SDDC you want to modify. |
optional | ProgressAction | ActionPreference | named |
|
|
optional | Server | VmcServer[] | named |
|
Specifies the VMware Cloud on AWS servers on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-Vmc cmdlet. |
Parameters
Required | Parameter Name | Type | Position | Features | Description |
---|---|---|---|---|---|
required
|
DisableSiteRecovery | SwitchParameter | named |
|
Deactivates site recovery for the specified SDDC. |
required
|
Sddc | VmcSddc[] | named |
|
Specifies the SDDC you want to modify. |
optional | Force | SwitchParameter | named |
|
Deactivates site recovery forcefully. |
optional | ProgressAction | ActionPreference | named |
|
|
optional | RunAsync | SwitchParameter | named |
|
Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter, run "help About_RunAsync" in the VMware PowerCLI console. |
optional | Server | VmcServer[] | named |
|
Specifies the VMware Cloud on AWS servers on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-Vmc cmdlet. |
Parameters
Required | Parameter Name | Type | Position | Features | Description |
---|---|---|---|---|---|
required
|
EnableSiteRecovery | SwitchParameter | named |
|
Enables site recovery for the specified SDDC. |
required
|
Sddc | VmcSddc[] | named |
|
Specifies the SDDC you want to modify. |
optional | ProgressAction | ActionPreference | named |
|
|
optional | RunAsync | SwitchParameter | named |
|
Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter, run "help About_RunAsync" in the VMware PowerCLI console. |
optional | Server | VmcServer[] | named |
|
Specifies the VMware Cloud on AWS servers on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-Vmc cmdlet. |
optional | SrmExtensionSuffix | String | named |
|
Specifies a custom extension key suffix for the site recovery instance. If not specified, the default extension ID (com.vmware.vcDr) is used. The custom suffix must be composed of not more than 13 characters. You can use letters, numbers, periods (.), hyphens (-), and underscores (_). The first and last symbol of the custom suffix must be a letter or a number. The suffix is appended to com.vmware.vcDr- to form the full extension ID. |
Parameters
Required | Parameter Name | Type | Position | Features | Description |
---|---|---|---|---|---|
required
|
Sddc | VmcSddc[] | named |
|
Specifies the SDDC you want to modify. |
required
|
Upsize | SwitchParameter | named |
|
Upsizes an SDDC from the default medium appliance configuration to a large appliance configuration. Large-sized appliances are recommended for deployments with more than 30 hosts or 3000 VMs or in any other situation where management cluster resources might be oversubscribed. Large-sized appliances are also required if you want to configure a Multi-Edge SDDC with traffic groups. This change is permanent and cannot be undone. The operation incurs about an hour of SDDC downtime, and requires a vCenter re-start and an NSX failover. If there aren't enough free resources available, the operation adds a host to the SDDC. Note: This operation cannot be performed while SDDC maintenance, including the addition or removal of hosts, is underway. |
optional | ProgressAction | ActionPreference | named |
|
|
optional | RunAsync | SwitchParameter | named |
|
Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter, run "help About_RunAsync" in the VMware PowerCLI console. |
optional | Server | VmcServer[] | named |
|
Specifies the VMware Cloud on AWS servers on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-Vmc cmdlet. |
Output
Examples
Example 1
Set-VmcSddc -Sddc $sddc -Name 'VmcSddc'
Modifies the name of the selected SDDC.
Example 2
Set-VmcSddc -Sddc $sddc -EnableSiteRecovery -SrmExtensionSuffix 'suffix'
Enables site recovery for the selected SDDC with an SRM extension suffix specified.
Example 3
Set-VmcSddc -Sddc $sddc -DisableSiteRecovery
Deactivates site recovery for the selected SDDC.
Example 4
Set-VmcSddc -Sddc $sddc -Upsize
Upsizes the selected SDDC.
Related Commands
VmcSddc
This cmdlet retrieves VMware Cloud on AWS software-defined data centers (SDDCs) from the VMware Cloud environment.
This cmdlet creates a new VMware Cloud on AWS software-defined data center (SDDC).
This cmdlet removes a VMware Cloud on AWS software-defined data center (SDDC) from the VMware Cloud environment.
This cmdlet modifies a specified VMware Cloud on AWS software-defined data center (SDDC). This cmdlet can activate or deactivate site recovery for a specified SDDC, and upsize an SDDC.
VmcSddcCluster
This cmdlet retrieves clusters of VMware Cloud on AWS software-defined data centers (SDDCs) from the VMware Cloud environment.
This cmdlet creates а cluster and adds it to a VMware Cloud on AWS software-defined data center (SDDC).
This cmdlet removes clusters from a VMware Cloud on AWS software-defined data center (SDDC).
VmcSddcGroup
This cmdlet retrieves groups of VMware Cloud on AWS software-defined data centers (SDDCs) from the VMware Cloud environment.
VmcSddcHost
This cmdlet adds hosts to a VMware Cloud on AWS software-defined data center (SDDC). If no cluster is specified, the host is added to the default cluster of the SDDC. If the cluster is specified, the host is added to that cluster.
This cmdlet removes hosts from a VMware Cloud on AWS software-defined data center (SDDC). If no cluster is specified, the hosts are removed from the default cluster of the SDDC. If a cluster is passed, the hosts are removed from the specified cluster.
VmcSddcNetworkService
This cmdlet retrieves PSObjects that represent services for network configuration managment of an SDDC in VMware Cloud.
VmcSddcSiteRecovery
This cmdlet retrieves the site recovery parameters of VMware Cloud on AWS software-defined data centers (SDDCs).
VmcSddcSiteRecoveryInstance
This cmdlet retrieves the site recovery instances for VMware Cloud on AWS software-defined data centers (SDDCs) that have site recovery enabled.
This cmdlet creates а new site recovery instance for a VMware Cloud on AWS software-defined data center (SDDC) that has site recovery activated.
This cmdlet removes site recovery instances from a VMware Cloud on AWS software-defined data center (SDDC) that has site recovery activated.