net45/VMware.VimAutomation.Vmc.Commands.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VmcSddcHost</command:name> <command:verb>Add</command:verb> <command:noun>VmcSddcHost</command:noun> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VmcSddcHost</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Cluster</maml:name> <maml:Description> <maml:para>Specifies the cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddcCluster[]</command:parameterValue> <dev:type> <maml:name>VmcSddcCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostCount</maml:name> <maml:Description> <maml:para>Specifies the number of the host that you want to add.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-VmcSddcHost</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostCount</maml:name> <maml:Description> <maml:para>Specifies the number of the host that you want to add.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Sddc</maml:name> <maml:Description> <maml:para>Specifies the SDDC.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddc[]</command:parameterValue> <dev:type> <maml:name>VmcSddc[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Cluster</maml:name> <maml:Description> <maml:para>Specifies the cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddcCluster[]</command:parameterValue> <dev:type> <maml:name>VmcSddcCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostCount</maml:name> <maml:Description> <maml:para>Specifies the number of the host that you want to add.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Sddc</maml:name> <maml:Description> <maml:para>Specifies the SDDC.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddc[]</command:parameterValue> <dev:type> <maml:name>VmcSddc[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-VmcSddcHost -Sddc $sddc -HostCount 2</dev:code> <dev:remarks> <maml:para>Adds two hosts to the default cluster of the specified $sddc SDDC.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Add-VmcSddcHost -Sddc $sddc -HostCount 2 -RunAsync</dev:code> <dev:remarks> <maml:para>Adds asynchronously two hosts to the default cluster of the specified $sddc SDDC.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Add-VmcSddcHost -Cluster $cluster -HostCount 2</dev:code> <dev:remarks> <maml:para>Adds two hosts to the specified $cluster cluster.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-VmcSddc</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VmcSddc</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VmcSddcHost</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Connect-Vmc</command:name> <command:verb>Connect</command:verb> <command:noun>Vmc</command:noun> <maml:description> <maml:para>This cmdlet establishes a connection to a VMware Cloud on AWS server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet establishes a connection to ? VMware managed cloud such as the VMware Cloud on AWS server. The cmdlet requires an OAuth security context in order to authenticate the user. If you want to specify an API token directly, use the -ApiToken parameter.</maml:para> <maml:para>When running, the cmdlet performs the following steps: 1. If the Menu parameter is specified, a list of the latest connected VMware Cloud on AWS servers appears. 2. If neither the Menu nor the server is specified, the default "vmc.vmware.com" value is used. 3. If neither the ApiToken parameter nor the OAuthSecurityContext parameter is specified, the local credential store is searched for a previously saved one. If an API token is not found, an error report is displayed. 4. When using the Server and ApiToken parameters, a new OAuth security context is created for the token and is used to authenticate the user. 5. If the OAuthSecurityContext parameter is specified, the security context is used to authenticate the user.</maml:para> <maml:para>Note: If PowerShell runs in non-interactive mode, you are not prompted for credentials.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-Vmc</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RefreshToken"> <maml:name>ApiToken</maml:name> <maml:Description> <maml:para>Specifies the API token you want to use for authentication with the VMware Cloud Services server. The token is obtained from the VMware Cloud Services web portal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NotDefault</maml:name> <maml:Description> <maml:para>Specifies that you do not want to save the specified servers as default servers (the $global:defaultVmcServers PowerShell variable).</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="SaveRefreshToken"> <maml:name>SaveApiToken</maml:name> <maml:Description> <maml:para>Indicates that the API token that you use for establishing the server session is saved to a local credential store and can be used automatically when connecting again to the same server.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-Vmc</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Menu</maml:name> <maml:Description> <maml:para>Indicates that you want to select a connection server from a list of recently connected servers. If the Menu parameter is set to $true, the cmdlet retrieves a list of the last visited servers and enters a nested command prompt, so that you can select a server from the list.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-Vmc</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the IP address or the DNS name of the VMware managed cloud service. If not specified, the cmdlet assumes that you are connecting to the public commercial instance and the default value of `vmc.vmware.com` is used.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NotDefault</maml:name> <maml:Description> <maml:para>Specifies that you do not want to save the specified servers as default servers (the $global:defaultVmcServers PowerShell variable).</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OAuthSecurityContext</maml:name> <maml:Description> <maml:para>Specifies the OAuth security context that you can use to authenticate the user. For more information about security contexts, see the about_security_context article (about_security_context.html) and the [New-VcsOAuthSecurityContext cmdlet](New-VcsOAuthSecurityContext.md).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">OAuth2SecurityContext</command:parameterValue> <dev:type> <maml:name>OAuth2SecurityContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="RefreshToken"> <maml:name>ApiToken</maml:name> <maml:Description> <maml:para>Specifies the API token you want to use for authentication with the VMware Cloud Services server. The token is obtained from the VMware Cloud Services web portal.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Menu</maml:name> <maml:Description> <maml:para>Indicates that you want to select a connection server from a list of recently connected servers. If the Menu parameter is set to $true, the cmdlet retrieves a list of the last visited servers and enters a nested command prompt, so that you can select a server from the list.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NotDefault</maml:name> <maml:Description> <maml:para>Specifies that you do not want to save the specified servers as default servers (the $global:defaultVmcServers PowerShell variable).</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OAuthSecurityContext</maml:name> <maml:Description> <maml:para>Specifies the OAuth security context that you can use to authenticate the user. For more information about security contexts, see the about_security_context article (about_security_context.html) and the [New-VcsOAuthSecurityContext cmdlet](New-VcsOAuthSecurityContext.md).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">OAuth2SecurityContext</command:parameterValue> <dev:type> <maml:name>OAuth2SecurityContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="SaveRefreshToken"> <maml:name>SaveApiToken</maml:name> <maml:Description> <maml:para>Indicates that the API token that you use for establishing the server session is saved to a local credential store and can be used automatically when connecting again to the same server.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the IP address or the DNS name of the VMware managed cloud service. If not specified, the cmdlet assumes that you are connecting to the public commercial instance and the default value of `vmc.vmware.com` is used.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.VmcServer</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Connect-Vmc -ApiToken $apiToken</dev:code> <dev:remarks> <maml:para>Connects to a VMware Cloud on AWS server.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Connect-Vmc -ApiToken $script:apiToken -SaveApiToken</dev:code> <dev:remarks> <maml:para>Connects to a VMware Cloud on AWS server by specifying the related secure connection token and saving it for later usage.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$oauthSecurityContext = New-VcsOAuthSecurityContext -ApiToken $script:apiToken Connect-Vmc -OAuthSecurityContext $oauthSecurityContext</dev:code> <dev:remarks> <maml:para>Connects to a VMware Cloud on AWS server by specifying an OAuth security context. In this case, you can create it by using the API token.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>$oauthSecurityContext = New-VcsOAuthSecurityContext -VcsServer "console.cloud.vmware.com" -ApiToken $script:apiToken Connect-Vmc -Server "vmc.vmware.com" -OAuthSecurityContext $oauthSecurityContext</dev:code> <dev:remarks> <maml:para>Connects to a VMware Cloud on AWS server by explicitly specifying the host name of the VMware Cloud Services and the VMware Cloud on AWS server for the commercial instance. If you want to use a different instance, you can find the corresponding host names in the Developer Center section of the web portal.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://developer.vmware.com/docs/powercli/latest/vmware.vimautomation.vmc/commands/connect-vmc</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-Vmc</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disconnect-Vmc</command:name> <command:verb>Disconnect</command:verb> <command:noun>Vmc</command:noun> <maml:description> <maml:para>This cmdlet closes the connection to the servers specified by the Server parameter.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet closes the connection to the servers specified by the Server parameter.</maml:para> <maml:para>When no servers are specified and if there is only one connected server in the $defaultVmcServers variable, this server is disconnected. If there is no connected server, the cmdlet throws a non-terminating error.</maml:para> <maml:para>This functionality is using the reference counting mechanism. For more information about the mechanism, see Connect-Vmc.</maml:para> <maml:para>When there are no more active connections to the server, it gets disconnected and then it is removed from the $defaultVmcServers variable (if it is present). For more information about this variable, see Connect-Vmc.</maml:para> <maml:para>If the Force parameter is specified, the server is disconnected even if there is more than one connection to it. The RefCount property of the object is incremented by one.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disconnect-Vmc</maml:name> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the VMware Cloud on AWS servers you want to disconnect from.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CisServer[]</command:parameterValue> <dev:type> <maml:name>CisServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Specifies that you want to remove all existing connections to the specified VMware Cloud on AWS servers.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Specifies that you want to remove all existing connections to the specified VMware Cloud on AWS servers.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the VMware Cloud on AWS servers you want to disconnect from.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CisServer[]</command:parameterValue> <dev:type> <maml:name>CisServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$connection = ConnectVmc -RefreshToken $myRefreshToken Disconnect-Vmc -Server $connection -Confirm:$false</dev:code> <dev:remarks> <maml:para>Disconnects the specified VMware Cloud on AWS server without asking for confirmation.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$connection = ConnectVmc -RefreshToken $myRefreshToken Disconnect-Vmc -Server '*' -Force -Confirm:$false</dev:code> <dev:remarks> <maml:para>Forces the disconnect operation for all connected VMware Cloud on AWS servers without asking for confirmation.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://developer.vmware.com/docs/powercli/latest/vmware.vimautomation.vmc/commands/disconnect-vmc</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-Vmc</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AwsAccount</command:name> <command:verb>Get</command:verb> <command:noun>AwsAccount</command:noun> <maml:description> <maml:para>This cmdlet retrieves VMware Cloud on AWS accounts.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves VMware Cloud on AWS accounts.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AwsAccount</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies VMware Cloud on AWS account ID.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CisServer[]</command:parameterValue> <dev:type> <maml:name>CisServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies VMware Cloud on AWS account ID.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CisServer[]</command:parameterValue> <dev:type> <maml:name>CisServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.CmdletObject.AwsAccount</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-AwsAccount -Server $server</dev:code> <dev:remarks> <maml:para>Retrieves all available VMware Cloud on AWS accounts on the $server server.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-AwsAccount -Id "AccountId"</dev:code> <dev:remarks> <maml:para>Retrieves a VMware Cloud on AWS account with an "AccountId" ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AwsVpcSubnet</command:name> <command:verb>Get</command:verb> <command:noun>AwsVpcSubnet</command:noun> <maml:description> <maml:para>Retrieves a private subnet's range for a concrete account and region.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves a private subnet's range for a concrete account and region.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AwsVpcSubnet</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AwsAccount</maml:name> <maml:Description> <maml:para>Specifies the VMware Cloud on AWS account.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AwsAccount</command:parameterValue> <dev:type> <maml:name>AwsAccount</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Region</maml:name> <maml:Description> <maml:para>Specifies the region.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AwsAccount</maml:name> <maml:Description> <maml:para>Specifies the VMware Cloud on AWS account.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AwsAccount</command:parameterValue> <dev:type> <maml:name>AwsAccount</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Region</maml:name> <maml:Description> <maml:para>Specifies the region.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.CmdletObject.AwsAccount</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-AwsVpcSubnet -Region "US_EAST_1" -AwsAccount $awsAccount</dev:code> <dev:remarks> <maml:para>Retrieves private subnets for the $awsAccount account in the US_EAST_1 region.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VmcClusterEdrsPolicy</command:name> <command:verb>Get</command:verb> <command:noun>VmcClusterEdrsPolicy</command:noun> <maml:description> <maml:para>This cmdlet retrieves EDRS policies of clusters.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves EDRS policies of clusters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VmcClusterEdrsPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Cluster</maml:name> <maml:Description> <maml:para>Specifies the cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddcCluster[]</command:parameterValue> <dev:type> <maml:name>VmcSddcCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Cluster</maml:name> <maml:Description> <maml:para>Specifies the cluster</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddcCluster[]</command:parameterValue> <dev:type> <maml:name>VmcSddcCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.CmdletObject.VmcSddcCluster[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.CmdletObject.IVmcEdrsPolicy</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VmcClusterEdrsPolicy -Cluster $CLUSTER</dev:code> <dev:remarks> <maml:para>Retrieves EDRS policy of the specified $CLUSTER cluster.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VmcOrganization</command:name> <command:verb>Get</command:verb> <command:noun>VmcOrganization</command:noun> <maml:description> <maml:para>This cmdlet retrieves an organization from the VMware Cloud environment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves an organization from the VMware Cloud environment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VmcOrganization</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the organizations you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VmcOrganization</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the SDDCs you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ListAvailable</maml:name> <maml:Description> <maml:para>Specifies that you want to retrieve the available organizations. By default, the cmdlet retrieves only the organizations that the user has an active connection to.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the organizations you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ListAvailable</maml:name> <maml:Description> <maml:para>Specifies that you want to retrieve the available organizations. By default, the cmdlet retrieves only the organizations that the user has an active connection to.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the SDDCs you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.CmdletObject.VmcOrganization</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VmcOrganization -Name "OrganizationName"</dev:code> <dev:remarks> <maml:para>Retrieves the organization named "SddcName".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VmcOrganization -Id "OrganizationId"</dev:code> <dev:remarks> <maml:para>Retrieves the organization with an "OrganizationId" ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VmcOrganization -ListAvailable</dev:code> <dev:remarks> <maml:para>Retrieves all available organizations.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VmcOutpost</command:name> <command:verb>Get</command:verb> <command:noun>VmcOutpost</command:noun> <maml:description> <maml:para>This cmdlet retrieves a list of AWS Outposts based on the specified criteria.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves a list of AWS Outposts registered with your VMC organization based on the specified criteria.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VmcOutpost</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies one or more IDs of outposts to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VmcOutpost</maml:name> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies one or more wildcard string filters. The retrieved outposts must have a name that matches at least one of those filters.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies one or more IDs of outposts to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies one or more wildcard string filters. The retrieved outposts must have a name that matches at least one of those filters.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.CmdletObject.VmcOutpost</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VmcOutpost</dev:code> <dev:remarks> <maml:para>Retrieves all the AWS Outposts in the organization.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VmcOutpost "my-outpost*"</dev:code> <dev:remarks> <maml:para>Retrieves all outposts with a name that begins with "my-outpost".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VmcOutpost -Id "9367fec4-0090-46f8-949d-b286c7e730c9"</dev:code> <dev:remarks> <maml:para>Retrieves the outpost with the specified ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VmcSddc</command:name> <command:verb>Get</command:verb> <command:noun>VmcSddc</command:noun> <maml:description> <maml:para>This cmdlet retrieves VMware Cloud on AWS software-defined data centers (SDDCs) from the VMware Cloud environment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves VMware Cloud on AWS software-defined data centers (SDDCs) from the VMware Cloud environment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VmcSddc</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the SDDCs you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CisServer[]</command:parameterValue> <dev:type> <maml:name>CisServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VmcSddc</maml:name> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the SDDCs you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeDeleted</maml:name> <maml:Description> <maml:para>Specifies if the deleted SDDCs are included in the result.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CisServer[]</command:parameterValue> <dev:type> <maml:name>CisServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VmcSddc</maml:name> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the SDDCs you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SddcGroup</maml:name> <maml:Description> <maml:para>Specifies the SDDC groups of the SDDCs you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddcGroup[]</command:parameterValue> <dev:type> <maml:name>VmcSddcGroup[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CisServer[]</command:parameterValue> <dev:type> <maml:name>CisServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the SDDCs you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeDeleted</maml:name> <maml:Description> <maml:para>Specifies if the deleted SDDCs are included in the result.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the SDDCs you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SddcGroup</maml:name> <maml:Description> <maml:para>Specifies the SDDC groups of the SDDCs you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddcGroup[]</command:parameterValue> <dev:type> <maml:name>VmcSddcGroup[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CisServer[]</command:parameterValue> <dev:type> <maml:name>CisServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.CmdletObject.VmcSddc</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VmcSddc -Name "SddcName" -IncludeDeleted</dev:code> <dev:remarks> <maml:para>Retrieves the deleted and non-deleted SDDCs named "SddcName".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VmcSddc -Id "SddcId"</dev:code> <dev:remarks> <maml:para>Retrieves the SDDCs with an "SddcId" ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VmcSddcCluster</command:name> <command:verb>Get</command:verb> <command:noun>VmcSddcCluster</command:noun> <maml:description> <maml:para>This cmdlet retrieves clusters of VMware Cloud on AWS software-defined data centers (SDDCs) from the VMware Cloud environment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves clusters of VMware Cloud on AWS software-defined data centers (SDDCs) from the VMware Cloud environment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VmcSddcCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>Specifies the IDs of the clusters you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VmcSddcCluster</maml:name> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the clusters you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Sddc</maml:name> <maml:Description> <maml:para>Specifies the SDDCs which clusters you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddc[]</command:parameterValue> <dev:type> <maml:name>VmcSddc[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ClusterId</maml:name> <maml:Description> <maml:para>Specifies the IDs of the clusters you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the clusters you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Sddc</maml:name> <maml:Description> <maml:para>Specifies the SDDCs which clusters you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddc[]</command:parameterValue> <dev:type> <maml:name>VmcSddc[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.CmdletObject.VmcSddc[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.CmdletObject.VmcSddcCluster</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VmcSddcCluster -Name "ClusterName" -Sddc $SDDC</dev:code> <dev:remarks> <maml:para>Retrieves the cluster named "ClusterName" from the $SDDC software-defined data center.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VmcSddcCluster -ClusterId "ClusterId"</dev:code> <dev:remarks> <maml:para>Retrieves the cluster with a "ClusterId" ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VmcSddcGroup</command:name> <command:verb>Get</command:verb> <command:noun>VmcSddcGroup</command:noun> <maml:description> <maml:para>This cmdlet retrieves groups of VMware Cloud on AWS software-defined data centers (SDDCs) from the VMware Cloud environment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves groups of VMware Cloud on AWS software-defined data centers (SDDCs) from the VMware Cloud environment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VmcSddcGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the SDDC groups you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CisServer[]</command:parameterValue> <dev:type> <maml:name>CisServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VmcSddcGroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the SDDC groups you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeDeleted</maml:name> <maml:Description> <maml:para>Specifies that you want to include deleted SDDC groups in the result.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CisServer[]</command:parameterValue> <dev:type> <maml:name>CisServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the SDDC groups you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeDeleted</maml:name> <maml:Description> <maml:para>Specifies that you want to include deleted SDDC groups in the result.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the names of the SDDC groups you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CisServer[]</command:parameterValue> <dev:type> <maml:name>CisServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.CmdletObject.VmcSddcGroup</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VmcSddcGroup</dev:code> <dev:remarks> <maml:para>Retrieves all SDDC groups in the organization.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VmcSddcGroup "MySddc*"</dev:code> <dev:remarks> <maml:para>Retrieves all SDDC groups in the organization whose name begins with "MySddc".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VmcSddcGroup "MySddc*" -IncludeDeleted</dev:code> <dev:remarks> <maml:para>Retrieves all SDDC groups, including deleted groups, in the organization whose name begins with "MySddc".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VmcSddcGroup -Id "SddcId"</dev:code> <dev:remarks> <maml:para>Retrieves the SDDC group with an "SddcId" ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VmcSddcNetworkService</command:name> <command:verb>Get</command:verb> <command:noun>VmcSddcNetworkService</command:noun> <maml:description> <maml:para>This cmdlet retrieves PSObjects that represent services for network configuration managment of an SDDC in VMware Cloud.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves PSObjects that represent services for network configuration managment of an SDDC in VMware Cloud. The operations of an SDDC network service can be invoked naturally by invoking the respective PSObject methods.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VmcSddcNetworkService</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the service type ID.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrgId</maml:name> <maml:Description> <maml:para>Specifies the id of the organization that the SDDC belongs to.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SddcId</maml:name> <maml:Description> <maml:para>Specifies the id of the SDDC whose network services are to be retrieved.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the VMC 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 Connect-Vmc.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CisServer[]</command:parameterValue> <dev:type> <maml:name>CisServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the service type ID.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrgId</maml:name> <maml:Description> <maml:para>Specifies the id of the organization that the SDDC belongs to.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SddcId</maml:name> <maml:Description> <maml:para>Specifies the id of the SDDC whose network services are to be retrieved.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the VMC 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 Connect-Vmc.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CisServer[]</command:parameterValue> <dev:type> <maml:name>CisServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>One or more PSObject objects</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$sddcNetworkServices = Get-VmcSddcNetworkService -OrgId $script:orgId -SddcId $script:sddcId</dev:code> <dev:remarks> <maml:para>Retrieves all available SDDC Network services for the specified SDDC.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$sddcNetworkService = Get-VmcSddcNetworkService -OrgId $script:orgId -SddcId $script:sddcId -Name 'com.vmware.nsx.policy.api.v1.cluster.nodes'</dev:code> <dev:remarks> <maml:para>Retrieves a specified SDDC Network services by Name for the specified SDDC.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://developer.vmware.com/docs/powercli/latest/vmware.vimautomation.vmc/commands/get-vmcsddcnetworkservice</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VmcSddcSiteRecovery</command:name> <command:verb>Get</command:verb> <command:noun>VmcSddcSiteRecovery</command:noun> <maml:description> <maml:para>This cmdlet retrieves the site recovery parameters of VMware Cloud on AWS software-defined data centers (SDDCs).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the site recovery parameters of VMware Cloud on AWS software-defined data centers (SDDCs).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VmcSddcSiteRecovery</maml:name> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Sddc</maml:name> <maml:Description> <maml:para>Specifies the SDDCs for which you want to retrieve site recovery parameters.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddc[]</command:parameterValue> <dev:type> <maml:name>VmcSddc[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Sddc</maml:name> <maml:Description> <maml:para>Specifies the SDDCs for which you want to retrieve site recovery parameters.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddc[]</command:parameterValue> <dev:type> <maml:name>VmcSddc[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.CmdletObject.VmcSddc[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.CmdletObject.IVmcSddcSiteRecovery</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VmcSddcSiteRecovery -Sddc $SDDC</dev:code> <dev:remarks> <maml:para>Retrieves the site recovery parameters for the selected SDDC.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VmcSddcSiteRecoveryInstance</command:name> <command:verb>Get</command:verb> <command:noun>VmcSddcSiteRecoveryInstance</command:noun> <maml:description> <maml:para>This cmdlet retrieves the site recovery instances for VMware Cloud on AWS software-defined data centers (SDDCs) that have site recovery enabled.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the site recovery instances for VMware Cloud on AWS software-defined data centers (SDDCs) that have site recovery enabled.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VmcSddcSiteRecoveryInstance</maml:name> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Sddc</maml:name> <maml:Description> <maml:para>Specifies the SDDCs for which you want to retrieve site recovery instances.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddc[]</command:parameterValue> <dev:type> <maml:name>VmcSddc[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Sddc</maml:name> <maml:Description> <maml:para>Specifies the SDDCs for which you want to retrieve site recovery instances.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddc[]</command:parameterValue> <dev:type> <maml:name>VmcSddc[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.CmdletObject.VmcSddc[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.CmdletObject.IVmcSddcSiteRecoveryInstance</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VmcSddcSiteRecoveryInstance -Sddc $SDDC</dev:code> <dev:remarks> <maml:para>Retrieves the site recovery instances for the selected SDDC.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VmcService</command:name> <command:verb>Get</command:verb> <command:noun>VmcService</command:noun> <maml:description> <maml:para>This cmdlet retrieves PSObject objects that represent a proxy to a VMware Cloud on AWS API service.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves PSObject objects that represent a proxy to a VMware Cloud on AWS API service and can be used to invoke the operations of the VMware Cloud on AWS API service.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VmcService</maml:name> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the service type ID.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the VMC 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 Connect-Vmc.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CisServer[]</command:parameterValue> <dev:type> <maml:name>CisServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the service type ID.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the VMC 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 Connect-Vmc.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CisServer[]</command:parameterValue> <dev:type> <maml:name>CisServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>One or more PSObject objects</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VmcService</dev:code> <dev:remarks> <maml:para>Retrieves all available VMware Cloud on AWS services on the connected VMware Cloud on AWS server.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VmcService -Name 'com.vmware.vmc.orgs'</dev:code> <dev:remarks> <maml:para>Retrieves a specific VMware Cloud on AWS service by a specific name.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://developer.vmware.com/docs/powercli/latest/vmware.vimautomation.vmc/commands/get-vmcservice</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-VmcSddc</command:name> <command:verb>New</command:verb> <command:noun>VmcSddc</command:noun> <maml:description> <maml:para>This cmdlet creates a new VMware Cloud on AWS software-defined data center (SDDC).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates a new VMware Cloud on AWS software-defined data center (SDDC).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-VmcSddc</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AwsAccount</maml:name> <maml:Description> <maml:para>Specifies the VMware Cloud on AWS account that you want to link to the SDDC.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AwsAccount</command:parameterValue> <dev:type> <maml:name>AwsAccount</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AwsVpcSubnet</maml:name> <maml:Description> <maml:para>Specifies a private subnet range (RFC 1918) that you want to use for vCenter Server, NSX Manager, and the ESXi hosts. Choose a range that does not conflict with other networks that you want to connect to this SDDC. If the SDDC is stretched cluster, you should choose more than one private subnet range.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AwsVpcSubnet[]</command:parameterValue> <dev:type> <maml:name>AwsVpcSubnet[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostCount</maml:name> <maml:Description> <maml:para>Specifies the number of the hosts that you want to create.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostType</maml:name> <maml:Description> <maml:para>Specifies the type of the hosts. The availale host types are: "I3EN" and "I3". If the host type is not specified, the default type "I3" is set.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">I3</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">I3EN</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">VmcHostTypeEnum</command:parameterValue> <dev:type> <maml:name>VmcHostTypeEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ManagementSubnetCidr</maml:name> <maml:Description> <maml:para>Specifies the IP subnet in a classless inter-domain routing (CIDR) format for the compute gateway.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the created SDDC.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Outpost</maml:name> <maml:Description> <maml:para>Specifies the AWS Outpost on which you want to host this SDDC.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcOutpost</command:parameterValue> <dev:type> <maml:name>VmcOutpost</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Provider</maml:name> <maml:Description> <maml:para>Specifies the cloud provider (e.g. VMware Cloud on AWS) that you use to provide the physical resources for the newly created SDDC.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Unknown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Aws</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Zerocloud</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">VmcProvider</command:parameterValue> <dev:type> <maml:name>VmcProvider</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Region</maml:name> <maml:Description> <maml:para>Specifies the geographical region where you want to create the SDDC. You can find a list of the VMware Cloud on AWS regions in the table below.</maml:para> <maml:para></maml:para> <maml:para>| Region Name | Region |</maml:para> <maml:para>|--------------------------|---------------|</maml:para> <maml:para>|US East (Ohio) |US_EAST_2 |</maml:para> <maml:para>|US East (N. Virginia) |US_EAST_1 |</maml:para> <maml:para>|US West (N. California) |US_WEST_1 |</maml:para> <maml:para>|US West (Oregon) |US_WEST_2 |</maml:para> <maml:para>|Asia Pacific (Hong Kong) |AP_EAST_1 |</maml:para> <maml:para>|Asia Pacific (Mumbai) |AP_SOUTH_1 |</maml:para> <maml:para>|Asia Pacific (Osaka-Local)|AP_NORTHEAST_3 |</maml:para> <maml:para>|Asia Pacific (Seoul) |AP_NORTHEAST_2 |</maml:para> <maml:para>|Asia Pacific (Singapore) |AP_SOUTHEAST_1 |</maml:para> <maml:para>|Asia Pacific (Sydney) |AP_SOUTHEAST_2 |</maml:para> <maml:para>|Asia Pacific (Tokyo) |AP_NORTHEAST_1 |</maml:para> <maml:para>|Canada (Central) |CA_CENTRAL_1 |</maml:para> <maml:para>|China (Beijing) |CN_NORTH_1 |</maml:para> <maml:para>|China (Ningxia) |CN_NORTHWEST_1 |</maml:para> <maml:para>|EU (Frankfurt) |EU_CENTRAL_1 |</maml:para> <maml:para>|EU (Ireland) |EU_WEST_1 |</maml:para> <maml:para>|EU (London) |EU_WEST_2 |</maml:para> <maml:para>|EU (Paris) |EU_WEST_3 |</maml:para> <maml:para>|EU (Stockholm) |EU_NORTH_1 |</maml:para> <maml:para>|Middle East (Bahrain) |ME_SOUTH_1 |</maml:para> <maml:para>|South America (Sao Paulo) |SA_EAST_1 |</maml:para> <maml:para>|AWS GovCloud (US-East) |US_GOV_EAST_1 |</maml:para> <maml:para>|AWS GovCloud (US-West) |US_GOV_WEST_1 |</maml:para> <maml:para></maml:para> <maml:para>Please note that VMware Cloud on AWS may not be supported in all regions.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AppliancesSize"> <maml:name>SddcAppliancesSize</maml:name> <maml:Description> <maml:para>Specifies the SDDC appliances size.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Unknown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Large</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Medium</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">VmcSddcSizeEnum</command:parameterValue> <dev:type> <maml:name>VmcSddcSizeEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SddcType</maml:name> <maml:Description> <maml:para>Specifies if the SDDC is single or multi-host.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Unknown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SingleHost</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MultiHost</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">SddcType</command:parameterValue> <dev:type> <maml:name>SddcType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the VMware Cloud on AWS servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-Vmc cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StretchedCluster</maml:name> <maml:Description> <maml:para>Specifies if you want to stretch out the SDDC to two availability zones in order to be highly available.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-VmcSddc</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostCount</maml:name> <maml:Description> <maml:para>Specifies the number of the hosts that you want to create.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostType</maml:name> <maml:Description> <maml:para>Specifies the type of the hosts. The availale host types are: "I3EN" and "I3". If the host type is not specified, the default type "I3" is set.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">I3</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">I3EN</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">VmcHostTypeEnum</command:parameterValue> <dev:type> <maml:name>VmcHostTypeEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ManagementSubnetCidr</maml:name> <maml:Description> <maml:para>Specifies the IP subnet in a classless inter-domain routing (CIDR) format for the compute gateway.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the created SDDC.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Outpost</maml:name> <maml:Description> <maml:para>Specifies the AWS Outpost on which you want to host this SDDC.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcOutpost</command:parameterValue> <dev:type> <maml:name>VmcOutpost</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Provider</maml:name> <maml:Description> <maml:para>Specifies the cloud provider (e.g. VMware Cloud on AWS) that you use to provide the physical resources for the newly created SDDC.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Unknown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Aws</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Zerocloud</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">VmcProvider</command:parameterValue> <dev:type> <maml:name>VmcProvider</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Region</maml:name> <maml:Description> <maml:para>Specifies the geographical region where you want to create the SDDC. You can find a list of the VMware Cloud on AWS regions in the table below.</maml:para> <maml:para></maml:para> <maml:para>| Region Name | Region |</maml:para> <maml:para>|--------------------------|---------------|</maml:para> <maml:para>|US East (Ohio) |US_EAST_2 |</maml:para> <maml:para>|US East (N. Virginia) |US_EAST_1 |</maml:para> <maml:para>|US West (N. California) |US_WEST_1 |</maml:para> <maml:para>|US West (Oregon) |US_WEST_2 |</maml:para> <maml:para>|Asia Pacific (Hong Kong) |AP_EAST_1 |</maml:para> <maml:para>|Asia Pacific (Mumbai) |AP_SOUTH_1 |</maml:para> <maml:para>|Asia Pacific (Osaka-Local)|AP_NORTHEAST_3 |</maml:para> <maml:para>|Asia Pacific (Seoul) |AP_NORTHEAST_2 |</maml:para> <maml:para>|Asia Pacific (Singapore) |AP_SOUTHEAST_1 |</maml:para> <maml:para>|Asia Pacific (Sydney) |AP_SOUTHEAST_2 |</maml:para> <maml:para>|Asia Pacific (Tokyo) |AP_NORTHEAST_1 |</maml:para> <maml:para>|Canada (Central) |CA_CENTRAL_1 |</maml:para> <maml:para>|China (Beijing) |CN_NORTH_1 |</maml:para> <maml:para>|China (Ningxia) |CN_NORTHWEST_1 |</maml:para> <maml:para>|EU (Frankfurt) |EU_CENTRAL_1 |</maml:para> <maml:para>|EU (Ireland) |EU_WEST_1 |</maml:para> <maml:para>|EU (London) |EU_WEST_2 |</maml:para> <maml:para>|EU (Paris) |EU_WEST_3 |</maml:para> <maml:para>|EU (Stockholm) |EU_NORTH_1 |</maml:para> <maml:para>|Middle East (Bahrain) |ME_SOUTH_1 |</maml:para> <maml:para>|South America (Sao Paulo) |SA_EAST_1 |</maml:para> <maml:para>|AWS GovCloud (US-East) |US_GOV_EAST_1 |</maml:para> <maml:para>|AWS GovCloud (US-West) |US_GOV_WEST_1 |</maml:para> <maml:para></maml:para> <maml:para>Please note that VMware Cloud on AWS may not be supported in all regions.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AppliancesSize"> <maml:name>SddcAppliancesSize</maml:name> <maml:Description> <maml:para>Specifies the SDDC appliances size.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Unknown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Large</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Medium</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">VmcSddcSizeEnum</command:parameterValue> <dev:type> <maml:name>VmcSddcSizeEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SddcType</maml:name> <maml:Description> <maml:para>Specifies if the SDDC is single or multi-host.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Unknown</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SingleHost</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MultiHost</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">SddcType</command:parameterValue> <dev:type> <maml:name>SddcType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the VMware Cloud on AWS servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-Vmc cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipAccountLinking</maml:name> <maml:Description> <maml:para>Specifies that the account linking is delayed.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StretchedCluster</maml:name> <maml:Description> <maml:para>Specifies if you want to stretch out the SDDC to two availability zones in order to be highly available.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AwsAccount</maml:name> <maml:Description> <maml:para>Specifies the VMware Cloud on AWS account that you want to link to the SDDC.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AwsAccount</command:parameterValue> <dev:type> <maml:name>AwsAccount</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AwsVpcSubnet</maml:name> <maml:Description> <maml:para>Specifies a private subnet range (RFC 1918) that you want to use for vCenter Server, NSX Manager, and the ESXi hosts. Choose a range that does not conflict with other networks that you want to connect to this SDDC. If the SDDC is stretched cluster, you should choose more than one private subnet range.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">AwsVpcSubnet[]</command:parameterValue> <dev:type> <maml:name>AwsVpcSubnet[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostCount</maml:name> <maml:Description> <maml:para>Specifies the number of the hosts that you want to create.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostType</maml:name> <maml:Description> <maml:para>Specifies the type of the hosts. The availale host types are: "I3EN" and "I3". If the host type is not specified, the default type "I3" is set.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcHostTypeEnum</command:parameterValue> <dev:type> <maml:name>VmcHostTypeEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ManagementSubnetCidr</maml:name> <maml:Description> <maml:para>Specifies the IP subnet in a classless inter-domain routing (CIDR) format for the compute gateway.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the created SDDC.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Outpost</maml:name> <maml:Description> <maml:para>Specifies the AWS Outpost on which you want to host this SDDC.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcOutpost</command:parameterValue> <dev:type> <maml:name>VmcOutpost</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Provider</maml:name> <maml:Description> <maml:para>Specifies the cloud provider (e.g. VMware Cloud on AWS) that you use to provide the physical resources for the newly created SDDC.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcProvider</command:parameterValue> <dev:type> <maml:name>VmcProvider</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Region</maml:name> <maml:Description> <maml:para>Specifies the geographical region where you want to create the SDDC. You can find a list of the VMware Cloud on AWS regions in the table below.</maml:para> <maml:para></maml:para> <maml:para>| Region Name | Region |</maml:para> <maml:para>|--------------------------|---------------|</maml:para> <maml:para>|US East (Ohio) |US_EAST_2 |</maml:para> <maml:para>|US East (N. Virginia) |US_EAST_1 |</maml:para> <maml:para>|US West (N. California) |US_WEST_1 |</maml:para> <maml:para>|US West (Oregon) |US_WEST_2 |</maml:para> <maml:para>|Asia Pacific (Hong Kong) |AP_EAST_1 |</maml:para> <maml:para>|Asia Pacific (Mumbai) |AP_SOUTH_1 |</maml:para> <maml:para>|Asia Pacific (Osaka-Local)|AP_NORTHEAST_3 |</maml:para> <maml:para>|Asia Pacific (Seoul) |AP_NORTHEAST_2 |</maml:para> <maml:para>|Asia Pacific (Singapore) |AP_SOUTHEAST_1 |</maml:para> <maml:para>|Asia Pacific (Sydney) |AP_SOUTHEAST_2 |</maml:para> <maml:para>|Asia Pacific (Tokyo) |AP_NORTHEAST_1 |</maml:para> <maml:para>|Canada (Central) |CA_CENTRAL_1 |</maml:para> <maml:para>|China (Beijing) |CN_NORTH_1 |</maml:para> <maml:para>|China (Ningxia) |CN_NORTHWEST_1 |</maml:para> <maml:para>|EU (Frankfurt) |EU_CENTRAL_1 |</maml:para> <maml:para>|EU (Ireland) |EU_WEST_1 |</maml:para> <maml:para>|EU (London) |EU_WEST_2 |</maml:para> <maml:para>|EU (Paris) |EU_WEST_3 |</maml:para> <maml:para>|EU (Stockholm) |EU_NORTH_1 |</maml:para> <maml:para>|Middle East (Bahrain) |ME_SOUTH_1 |</maml:para> <maml:para>|South America (Sao Paulo) |SA_EAST_1 |</maml:para> <maml:para>|AWS GovCloud (US-East) |US_GOV_EAST_1 |</maml:para> <maml:para>|AWS GovCloud (US-West) |US_GOV_WEST_1 |</maml:para> <maml:para></maml:para> <maml:para>Please note that VMware Cloud on AWS may not be supported in all regions.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AppliancesSize"> <maml:name>SddcAppliancesSize</maml:name> <maml:Description> <maml:para>Specifies the SDDC appliances size.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddcSizeEnum</command:parameterValue> <dev:type> <maml:name>VmcSddcSizeEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SddcType</maml:name> <maml:Description> <maml:para>Specifies if the SDDC is single or multi-host.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SddcType</command:parameterValue> <dev:type> <maml:name>SddcType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the VMware Cloud on AWS servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-Vmc cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipAccountLinking</maml:name> <maml:Description> <maml:para>Specifies that the account linking is delayed.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StretchedCluster</maml:name> <maml:Description> <maml:para>Specifies if you want to stretch out the SDDC to two availability zones in order to be highly available.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.CmdletObject.VmcSddc</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>New-VmcSddc -Name "SddcName" -Provider Aws -HostCount 1 -Region "US_EAST_1" -SddcType SingleHost -SkipAccountLinking</dev:code> <dev:remarks> <maml:para>Creates a new SDDC with the name "SddcName" with one host. The SDDC provider is Aws, the region is US_EAST_1. The SDDC is not linked to an account. Sddc type is a single host.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>New-VmcSddc -Name "SddcName" -Provider Aws -HostCount 3 -Region "US_EAST_1" -ManagementSubnetCidr $vpcir -SddcType MultiHost -SkipAccountLinking -RunAsync</dev:code> <dev:remarks> <maml:para>Creates a new SDDC with the name "SddcName" with three hosts. The SDDC provider is Aws, the region is US_EAST_1, the IP subnet is set to $vpcir. The SDDC is not linked to an account. Sddc type is multi-host. The operation is performed asynchronously.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>New-VmcSddc -Name "SddcName" -Provider Aws -HostCount 3 -Region "US_EAST_1" -SddcType MultiHost -HostType "I3EN" -AwsAccount $awsAccount -AwsVpcSubnet $awsVpcSubnet</dev:code> <dev:remarks> <maml:para>Creates the SDDC which is linked to the $awsAccount account and to the $awsVpcSubnet VMware Cloud on AWS subnet with hosts of type "I3EN".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>New-VmcSddc -Name "SddcName" -Provider Aws -HostCount 3 -Region "US_EAST_1" -SddcType MultiHost -AwsAccount $awsAccount -AwsVpcSubnet $awsVpcSubnet -SddcAppliancesSize Large -StretchedCluster</dev:code> <dev:remarks> <maml:para>Creates the large SDDC which is linked to the $awsAccount account and the $awsVpcSubnet VMware Cloud on AWS subnet which is stretched.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-VmcSddcCluster</command:name> <command:verb>New</command:verb> <command:noun>VmcSddcCluster</command:noun> <maml:description> <maml:para>This cmdlet creates ? cluster and adds it to a VMware Cloud on AWS software-defined data center (SDDC).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates ? cluster and adds it to a VMware Cloud on AWS software-defined data center (SDDC).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-VmcSddcCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostCount</maml:name> <maml:Description> <maml:para>Specifies the number of the hosts that you want to create.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostCpuCoresCount</maml:name> <maml:Description> <maml:para>Specifies the number of cores that you want to enable on the hosts in a cluster. The valid values are 8, 16, and so on.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostType</maml:name> <maml:Description> <maml:para>Specifies the type of the hosts. The availale host types are: "I3EN" and "I3". If the host type is not specified, the default type "I3" is set.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">I3</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">I3EN</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">VmcHostTypeEnum</command:parameterValue> <dev:type> <maml:name>VmcHostTypeEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Sddc</maml:name> <maml:Description> <maml:para>Specifies the SDDC.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddc[]</command:parameterValue> <dev:type> <maml:name>VmcSddc[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the VMware Cloud on AWS servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-Vmc cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostCount</maml:name> <maml:Description> <maml:para>Specifies the number of the hosts that you want to create.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostCpuCoresCount</maml:name> <maml:Description> <maml:para>Specifies the number of cores that you want to enable on the hosts in a cluster. The valid values are 8, 16, and so on.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostType</maml:name> <maml:Description> <maml:para>Specifies the type of the hosts. The availale host types are: "I3EN" and "I3". If the host type is not specified, the default type "I3" is set.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcHostTypeEnum</command:parameterValue> <dev:type> <maml:name>VmcHostTypeEnum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Sddc</maml:name> <maml:Description> <maml:para>Specifies the SDDC.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddc[]</command:parameterValue> <dev:type> <maml:name>VmcSddc[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the VMware Cloud on AWS servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-Vmc cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.CmdletObject.VmcSddc[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.CmdletObject.VmcSddcCluster</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>New-VmcSddcCluster -Sddc $sddc -HostCount 1</dev:code> <dev:remarks> <maml:para>Creates a new cluster to the $sddc software-defined data center with one host.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>New-VmcSddcCluster -Sddc $sddc -HostCount 1 -HostCpuCoresCount 16</dev:code> <dev:remarks> <maml:para>Creates a new cluster to the $sddc software-defined data center with one host and 16 CPU cores.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>New-VmcSddcCluster -Sddc $sddc -HostCount 1 -HostType I3</dev:code> <dev:remarks> <maml:para>Creates a new cluster to the $sddc software-defined data center with one host and host type "I3".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-VmcSddcSiteRecoveryInstance</command:name> <command:verb>New</command:verb> <command:noun>VmcSddcSiteRecoveryInstance</command:noun> <maml:description> <maml:para>This cmdlet creates ? new site recovery instance for a VMware Cloud on AWS software-defined data center (SDDC) that has site recovery activated.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates ? new site recovery instance for a VMware Cloud on AWS software-defined data center (SDDC) that has site recovery activated.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-VmcSddcSiteRecoveryInstance</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Sddc</maml:name> <maml:Description> <maml:para>Specifies the SDDC.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddc[]</command:parameterValue> <dev:type> <maml:name>VmcSddc[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the VMware Cloud on AWS servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-Vmc cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SrmExtensionSuffix</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Sddc</maml:name> <maml:Description> <maml:para>Specifies the SDDC.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddc[]</command:parameterValue> <dev:type> <maml:name>VmcSddc[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the VMware Cloud on AWS servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-Vmc cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SrmExtensionSuffix</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.CmdletObject.VmcSddc[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.CmdletObject.IVmcSddcSrmInstance</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>New-VmcSddcSiteRecoveryInstance -Sddc $sddc -EnableSiteRecovery -SrmExtensionSuffix 'suffix'</dev:code> <dev:remarks> <maml:para>Creates a new site recovery instance for the selected SDDC with an SRM extension suffix specified.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VmcSddc</command:name> <command:verb>Remove</command:verb> <command:noun>VmcSddc</command:noun> <maml:description> <maml:para>This cmdlet removes a VMware Cloud on AWS software-defined data center (SDDC) from the VMware Cloud environment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes a VMware Cloud on AWS software-defined data center (SDDC) from the VMware Cloud environment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VmcSddc</maml:name> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Sddc</maml:name> <maml:Description> <maml:para>Specifies the SDDC that you want to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddc[]</command:parameterValue> <dev:type> <maml:name>VmcSddc[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>If specified will forcefully delete the SDDC. Beware: do not use the force flag if there is a chance an active provisioning or deleting task is running against this SDDC.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>If specified will forcefully delete the SDDC. Beware: do not use the force flag if there is a chance an active provisioning or deleting task is running against this SDDC.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Sddc</maml:name> <maml:Description> <maml:para>Specifies the SDDC that you want to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddc[]</command:parameterValue> <dev:type> <maml:name>VmcSddc[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.CmdletObject.VmcSddc[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-VmcSddc -Sddc $SDDC</dev:code> <dev:remarks> <maml:para>Removes the specified $Sddc SDDC from the VMware Cloud environment.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Remove-VmcSddc -Sddc $SDDC -RunAsync</dev:code> <dev:remarks> <maml:para>Removes asynchronously the specified $SDDC from the VMware Cloud environment.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VmcSddcCluster</command:name> <command:verb>Remove</command:verb> <command:noun>VmcSddcCluster</command:noun> <maml:description> <maml:para>This cmdlet removes clusters from a VMware Cloud on AWS software-defined data center (SDDC).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes clusters from a VMware Cloud on AWS software-defined data center (SDDC).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VmcSddcCluster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="Cluster"> <maml:name>VmcSddcCluster</maml:name> <maml:Description> <maml:para>Specifies the clusters you want to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddcCluster[]</command:parameterValue> <dev:type> <maml:name>VmcSddcCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="Cluster"> <maml:name>VmcSddcCluster</maml:name> <maml:Description> <maml:para>Specifies the clusters you want to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddcCluster[]</command:parameterValue> <dev:type> <maml:name>VmcSddcCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.CmdletObject.VmcSddcCluster[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-VmcSddcCluster -VmcSddcCluster $cluster</dev:code> <dev:remarks> <maml:para>Removes the specified $cluster cluster.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VmcSddcHost</command:name> <command:verb>Remove</command:verb> <command:noun>VmcSddcHost</command:noun> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VmcSddcHost</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Cluster</maml:name> <maml:Description> <maml:para>Specifies the cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddcCluster[]</command:parameterValue> <dev:type> <maml:name>VmcSddcCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostCount</maml:name> <maml:Description> <maml:para>Specifies the number of the host that you want to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-VmcSddcHost</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostCount</maml:name> <maml:Description> <maml:para>Specifies the number of the host that you want to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Sddc</maml:name> <maml:Description> <maml:para>Specifies the SDDC.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddc[]</command:parameterValue> <dev:type> <maml:name>VmcSddc[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Cluster</maml:name> <maml:Description> <maml:para>Specifies the cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddcCluster[]</command:parameterValue> <dev:type> <maml:name>VmcSddcCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>HostCount</maml:name> <maml:Description> <maml:para>Specifies the number of the host that you want to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Sddc</maml:name> <maml:Description> <maml:para>Specifies the SDDC.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddc[]</command:parameterValue> <dev:type> <maml:name>VmcSddc[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-VmcSddcHost -Sddc $SDDC -HostCount 2</dev:code> <dev:remarks> <maml:para>Removes two hosts from the default cluster of the $SDDC SDDC.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Remove-VmcSddcHost -Sddc $SDDC -HostCount 2 -RunAsync</dev:code> <dev:remarks> <maml:para>Removes asynchronously two hosts from the default cluster of the $SDDC SDDC.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Remove-VmcSddcHost -Cluster $CLUSTER -HostCount 2</dev:code> <dev:remarks> <maml:para>Removes two hosts from the specified $CLUSTER cluster.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VmcSddcSiteRecoveryInstance</command:name> <command:verb>Remove</command:verb> <command:noun>VmcSddcSiteRecoveryInstance</command:noun> <maml:description> <maml:para>This cmdlet removes site recovery instances from a VMware Cloud on AWS software-defined data center (SDDC) that has site recovery activated.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes site recovery instances from a VMware Cloud on AWS software-defined data center (SDDC) that has site recovery activated.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VmcSddcSiteRecoveryInstance</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the VMware Cloud on AWS servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-Vmc cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>SiteRecoveryInstance</maml:name> <maml:Description> <maml:para>Specifies the site recovery instance to be removed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IVmcSddcSrmInstance[]</command:parameterValue> <dev:type> <maml:name>IVmcSddcSrmInstance[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the VMware Cloud on AWS servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-Vmc cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>SiteRecoveryInstance</maml:name> <maml:Description> <maml:para>Specifies the site recovery instance to be removed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IVmcSddcSrmInstance[]</command:parameterValue> <dev:type> <maml:name>IVmcSddcSrmInstance[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.CmdletObject.IVmcSddcSrmInstance[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-VmcSddcSiteRecoveryInstance -SiteRecoveryInstance $srmInstance</dev:code> <dev:remarks> <maml:para>Removes the specified site recovery instance.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-VmcClusterEdrsPolicy</command:name> <command:verb>Set</command:verb> <command:noun>VmcClusterEdrsPolicy</command:noun> <maml:description> <maml:para>This cmdlet modifies the Elastic Distributed Resource Scheduler (EDRS) policy of ? cluster in a software-defined data center (SDDC).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet modifies the Elastic Distributed Resource Scheduler (EDRS) policy of ? cluster in a software-defined data center (SDDC).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VmcClusterEdrsPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Cluster</maml:name> <maml:Description> <maml:para>Specifies the cluster whose policy you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddcCluster[]</command:parameterValue> <dev:type> <maml:name>VmcSddcCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Disable</maml:name> <maml:Description> <maml:para>Specifies if the EDRS policy is deactivated. By default, the policy is activated. When you deactivate the policy, it will be set to the default "storage-scaleup" policy. You cannot deactivate the default policy.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-VmcClusterEdrsPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Cluster</maml:name> <maml:Description> <maml:para>Specifies the cluster whose policy you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddcCluster[]</command:parameterValue> <dev:type> <maml:name>VmcSddcCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxHostCount</maml:name> <maml:Description> <maml:para>Specifies the maximum number of hosts which you can assign to the cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MinHostCount</maml:name> <maml:Description> <maml:para>Specifies the minimum number of hosts which you can assign to the cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PolicyType</maml:name> <maml:Description> <maml:para>The possible EDRS policies are as follows: - "cost": Based on the cluster utilization, you can remove the hosts more quickly (and add them more slowly) to keep the cost as low as possible.</maml:para> <maml:para>- "performance": Based on the cluster utilization, you can add the hosts more quickly (and removed them more slowly) to ensure the best possible performance.</maml:para> <maml:para>- "rapid-scaleup": Based on the cluster CPU and memory utilization, you can add multiple hosts at the same time. You must remove the hosts manually when you no longer need them. Based on the cluster storage utilization, you can add one host at a time when the storage utilization becomes critical.</maml:para> <maml:para>- "storage-scaleup": You can add the host when the cluster storage utilization becomes critical.</maml:para> <maml:para>The default EDRS policy type is "storage-scaleup".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScaleUpHostIncrement</maml:name> <maml:Description> <maml:para>Specifies the number of hosts that will be added to the cluster in parallel when a scale-up operation is triggered. The supported values are 4, 8 and 12. This is only supported when used along with the "rapid-scaleup" EDRS policy. The number of hosts you can add depends on the minimum and maximum cluster size you have configured. You can use the scale-up feature for additional flexibility and for rapid burst-case scenarios. By default, hosts are added two at a time. Beginning with SDDC version 1.14, you can specify a larger increment of hosts for faster disaster recovery scaling and other use cases. Scale-up time increases with the number of hosts added and can take up to 40 minutes for an increment of 12 hosts.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Cluster</maml:name> <maml:Description> <maml:para>Specifies the cluster whose policy you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddcCluster[]</command:parameterValue> <dev:type> <maml:name>VmcSddcCluster[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Disable</maml:name> <maml:Description> <maml:para>Specifies if the EDRS policy is deactivated. By default, the policy is activated. When you deactivate the policy, it will be set to the default "storage-scaleup" policy. You cannot deactivate the default policy.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxHostCount</maml:name> <maml:Description> <maml:para>Specifies the maximum number of hosts which you can assign to the cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MinHostCount</maml:name> <maml:Description> <maml:para>Specifies the minimum number of hosts which you can assign to the cluster.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PolicyType</maml:name> <maml:Description> <maml:para>The possible EDRS policies are as follows: - "cost": Based on the cluster utilization, you can remove the hosts more quickly (and add them more slowly) to keep the cost as low as possible.</maml:para> <maml:para>- "performance": Based on the cluster utilization, you can add the hosts more quickly (and removed them more slowly) to ensure the best possible performance.</maml:para> <maml:para>- "rapid-scaleup": Based on the cluster CPU and memory utilization, you can add multiple hosts at the same time. You must remove the hosts manually when you no longer need them. Based on the cluster storage utilization, you can add one host at a time when the storage utilization becomes critical.</maml:para> <maml:para>- "storage-scaleup": You can add the host when the cluster storage utilization becomes critical.</maml:para> <maml:para>The default EDRS policy type is "storage-scaleup".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScaleUpHostIncrement</maml:name> <maml:Description> <maml:para>Specifies the number of hosts that will be added to the cluster in parallel when a scale-up operation is triggered. The supported values are 4, 8 and 12. This is only supported when used along with the "rapid-scaleup" EDRS policy. The number of hosts you can add depends on the minimum and maximum cluster size you have configured. You can use the scale-up feature for additional flexibility and for rapid burst-case scenarios. By default, hosts are added two at a time. Beginning with SDDC version 1.14, you can specify a larger increment of hosts for faster disaster recovery scaling and other use cases. Scale-up time increases with the number of hosts added and can take up to 40 minutes for an increment of 12 hosts.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.CmdletObject.VmcSddcCluster[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.CmdletObject.IVmcEdrsPolicy</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-VmcClusterEdrsPolicy -Cluster $cluster -PolicyType "cost" -MinHostCount 6 -MaxHostCount 15</dev:code> <dev:remarks> <maml:para>Modifies the EDRS policy type of the selected $cluster cluster. The policy type is set to "cost" with the minimum number of hosts 6 and the maximum number of hosts 15.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Set-VmcClusterEdrsPolicy -Cluster $cluster -Disable</dev:code> <dev:remarks> <maml:para>Deactivates the EDRS policy type of the specified cluster. The policy type is reset to the default "storage-scaleup" policy type.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Set-VmcClusterEdrsPolicy -Cluster $cluster -PolicyType "rapid-scaleup" -MinHostCount 6 -MaxHostCount 15 -ScaleUpHostIncrement 4</dev:code> <dev:remarks> <maml:para>Modifies the EDRS policy type of the specified cluster. The policy type is set to "rapid-scaleup" with the minimum number of hosts set to six and the maximum number of hosts set to 15 and a scale-up host increment of four.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-VmcSddc</command:name> <command:verb>Set</command:verb> <command:noun>VmcSddc</command:noun> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VmcSddc</maml:name> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Sddc</maml:name> <maml:Description> <maml:para>Specifies the SDDC you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddc[]</command:parameterValue> <dev:type> <maml:name>VmcSddc[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableSiteRecovery</maml:name> <maml:Description> <maml:para>Deactivates site recovery for the specified SDDC.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Deactivates site recovery forcefully.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-VmcSddc</maml:name> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Sddc</maml:name> <maml:Description> <maml:para>Specifies the SDDC you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddc[]</command:parameterValue> <dev:type> <maml:name>VmcSddc[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnableSiteRecovery</maml:name> <maml:Description> <maml:para>Enables site recovery for the specified SDDC.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SrmExtensionSuffix</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-VmcSddc</maml:name> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Sddc</maml:name> <maml:Description> <maml:para>Specifies the SDDC you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddc[]</command:parameterValue> <dev:type> <maml:name>VmcSddc[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies a new name for the SDDC.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-VmcSddc</maml:name> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Sddc</maml:name> <maml:Description> <maml:para>Specifies the SDDC you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddc[]</command:parameterValue> <dev:type> <maml:name>VmcSddc[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Upsize</maml:name> <maml:Description> <maml:para>Upsizes an SDDC from the default medium appliance configuration to a large appliance configuration.</maml:para> <maml:para>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.</maml:para> <maml:para>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.</maml:para> <maml:para>Note: This operation cannot be performed while SDDC maintenance, including the addition or removal of hosts, is underway.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisableSiteRecovery</maml:name> <maml:Description> <maml:para>Deactivates site recovery for the specified SDDC.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EnableSiteRecovery</maml:name> <maml:Description> <maml:para>Enables site recovery for the specified SDDC.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Deactivates site recovery forcefully.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies a new name for the SDDC.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RunAsync</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Sddc</maml:name> <maml:Description> <maml:para>Specifies the SDDC you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcSddc[]</command:parameterValue> <dev:type> <maml:name>VmcSddc[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VmcServer[]</command:parameterValue> <dev:type> <maml:name>VmcServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SrmExtensionSuffix</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Upsize</maml:name> <maml:Description> <maml:para>Upsizes an SDDC from the default medium appliance configuration to a large appliance configuration.</maml:para> <maml:para>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.</maml:para> <maml:para>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.</maml:para> <maml:para>Note: This operation cannot be performed while SDDC maintenance, including the addition or removal of hosts, is underway.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Vmc.Types.V1.CmdletObject.VmcSddc[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-VmcSddc -Sddc $sddc -Name 'VmcSddc'</dev:code> <dev:remarks> <maml:para>Modifies the name of the selected SDDC.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Set-VmcSddc -Sddc $sddc -EnableSiteRecovery -SrmExtensionSuffix 'suffix'</dev:code> <dev:remarks> <maml:para>Enables site recovery for the selected SDDC with an SRM extension suffix specified.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Set-VmcSddc -Sddc $sddc -DisableSiteRecovery</dev:code> <dev:remarks> <maml:para>Deactivates site recovery for the selected SDDC.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Set-VmcSddc -Sddc $sddc -Upsize</dev:code> <dev:remarks> <maml:para>Upsizes the selected SDDC.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |