netcoreapp2.0/VMware.VimAutomation.Hcx.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>Connect-HCXServer</command:name> <command:verb>Connect</command:verb> <command:noun>HCXServer</command:noun> <maml:description> <maml:para>This cmdlet establishes a connection to a HCX server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet establishes a connection to the HCX server specified by the -Server parameter.</maml:para> <maml:para>The connect and disconnect operations for a server are using a reference counting mechanism. Every server is identified by its connection string which contains server, user name, and port. If there is an existing connection to the server for a specific user name and port, you cannot establish a new connection. Instead, the cmdlet returns the object which represents the existing connection. The RefCount property of the object is incremented by one. Note that the returned object is the same as the one previously returned. Therefore, the RefCount of the previously returned object will be updated as well. When a server is disconnected, its RefCount property is decreased by one. If this number becomes equal to zero, the server is disconnected.</maml:para> <maml:para>PowerCLI for HCX (Hybrid Cloud Extension) supports a list of default servers. When an operation is performed, if the target servers cannot be determined from the specified parameters, the cmdlet runs against the servers in the default server list. They are kept in a global variable called $DefaultHCXServers. It is of an array type and its initial value is an empty array. When you connect to a server, the server is added at the beginning of the array, unless the -NotDefault parameter is specified. When you disconnect from a server, the server is removed from the $DefaultHCXServers variable. When all servers are removed from the variable, its value is an empty array. You can modify the value of the $DefaultHCXServers variable manually.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-HCXServer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the IP or DNS addresses of the HCX servers you want to connect 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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>Specifies a PSCredential object that contains credentials for authenticating with the server. For more information about the server authentication logic of PowerCLI, run "help about_server_authentication".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</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>Suppresses all user interface prompts during the cmdlet execution. Currently, these include 'Multiple default servers' and 'Invalid certificate action'.</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>NotDefault</maml:name> <maml:Description> <maml:para>Indicates that you do not want to save the specified servers as default 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="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>Specifies the password you want to use for authenticating with the server. If the Credential parameter is also specified, this parameter is ignored. For more information about the server authentication logic of PowerCLI, run "help about_server_authentication".</maml:para> <maml:para>Note: If the password contains special characters, enclose the entire string in single quotes (').</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>Port</maml:name> <maml:Description> <maml:para>Specifies the port on the server you want to use for the connection.</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>SaveCredentials</maml:name> <maml:Description> <maml:para>Indicates that you want to save the specified credentials in the local credential store.</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="Username"> <maml:name>User</maml:name> <maml:Description> <maml:para>Specifies the user name you want to use for authenticating with the server. If the Credential parameter is also specified, this parameter is ignored. For more information about the server authentication logic of PowerCLI, run "help about_server_authentication".</maml:para> <maml:para>Note: If the user name contains special characters, enclose the entire string in single quotes (').</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:syntaxItem> <command:syntaxItem> <maml:name>Connect-HCXServer</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 Menu 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:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:Description> <maml:para>Specifies a PSCredential object that contains credentials for authenticating with the server. For more information about the server authentication logic of PowerCLI, run "help about_server_authentication".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</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>Suppresses all user interface prompts during the cmdlet execution. Currently, these include 'Multiple default servers' and 'Invalid certificate action'.</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>Menu</maml:name> <maml:Description> <maml:para>Indicates that you want to select a connection server from a list of recently connected servers. If Menu 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>Indicates that you do not want to save the specified servers as default 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="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>Specifies the password you want to use for authenticating with the server. If the Credential parameter is also specified, this parameter is ignored. For more information about the server authentication logic of PowerCLI, run "help about_server_authentication".</maml:para> <maml:para>Note: If the password contains special characters, enclose the entire string in single quotes (').</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>Port</maml:name> <maml:Description> <maml:para>Specifies the port on the server you want to use for the connection.</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>SaveCredentials</maml:name> <maml:Description> <maml:para>Indicates that you want to save the specified credentials in the local credential store.</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="0" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the IP or DNS addresses of the HCX servers you want to connect 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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Username"> <maml:name>User</maml:name> <maml:Description> <maml:para>Specifies the user name you want to use for authenticating with the server. If the Credential parameter is also specified, this parameter is ignored. For more information about the server authentication logic of PowerCLI, run "help about_server_authentication".</maml:para> <maml:para>Note: If the user name contains special characters, enclose the entire string in single quotes (').</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: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>CisServer</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-HCXServer -Server $serverAddress -User $user -Password $pass</dev:code> <dev:remarks> <maml:para>Connects to an HCX server by using the User and Password parameters.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$credential = Get-Credential Connect-HCXServer -Server $serverAddress -Credential $credential</dev:code> <dev:remarks> <maml:para>Connects to an HCX server by using the Credential parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Connect-HCXServer -Server $serverAddress -Credential -User $user -Password $pass -SaveCredential</dev:code> <dev:remarks> <maml:para>Connects to an HCX server and stores the credentials in the credential store.</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>Disconnect-HCXServer</command:name> <command:verb>Disconnect</command:verb> <command:noun>HCXServer</command:noun> <maml:description> <maml:para>This cmdlet closes the connection to one or more HCX servers.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet closes the connection to one or more HCX servers.</maml:para> <maml:para>When no servers and no user name are specified, and if there is only one connected server in $DefaultHCXServers variable, this server is disconnected. If there is no connected server, the cmdlet throws a terminating error.</maml:para> <maml:para>This functionality uses the reference counting mechanism. For more information about the mechanism, see the Connect-HCXServer cmdlet.</maml:para> <maml:para>When there are no active connections to the server, it gets disconnected and is removed from the $DefaultHCXServers variable. For more information about this variable, see the Connect-HCXServer cmdlet.</maml:para> <maml:para>If the -Force parameter is specified, the server disconnects even if there is more than one connection to it.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disconnect-HCXServer</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the HCX 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> <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>Indicates that you want to close all active connections to the specified server and disconnect from it.</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="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="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Indicates that you want to close all active connections to the specified server and disconnect from it.</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="True (ByValue)" position="0" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the HCX 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="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.Cis.Core.Types.V1.CisServer[]</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.Void</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>$server = Connect-HCXServer -Server 'server_name' -User 'user@domain' -Password 'user_password' Disconnect-HCXServer $server -Confirm:$false</dev:code> <dev:remarks> <maml:para>Disconnects the specified HCX server without asking for confirmation.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Connect-HCXServer -Server 'server_name' -User 'user@domain' -Password 'user_password' Connect-HCXServer -Server 'server2_name' -User 'user@domain' -Password 'user_password' Disconnect-HCXServer * -Confirm:$false</dev:code> <dev:remarks> <maml:para>Disconnects the specified HCX server without asking for confirmation.</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-HCXAppliance</command:name> <command:verb>Get</command:verb> <command:noun>HCXAppliance</command:noun> <maml:description> <maml:para>This cmdlet retrieves the appliances of type Interconnect, WAN Optimization, and Network Extension that are available on the HCX Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the appliances of type Interconnect, WAN Optimization, and L2Concentrator (Network Extension).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HCXAppliance</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 appliances you want to retrieve. </maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in the list.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HCXAppliance</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 appliance 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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Type</maml:name> <maml:Description> <maml:para>Specifies the type of the appliances you want to retrieve. The valid values are L2Concentrator, Interconnect, and WANOptimization.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">L2Concentrator</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Interconnect</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WANOptimization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">HXCApplianceType</command:parameterValue> <dev:type> <maml:name>HXCApplianceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HCXAppliance</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 appliance 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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Type</maml:name> <maml:Description> <maml:para>Specifies the type of the appliances you want to retrieve. The valid values are L2Concentrator, Interconnect, and WANOptimization.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">L2Concentrator</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Interconnect</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WANOptimization</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">HXCApplianceType</command:parameterValue> <dev:type> <maml:name>HXCApplianceType</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>ServiceMesh</maml:name> <maml:Description> <maml:para>Specifies the Service Mesh for which you want to retrieve the appliances.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXServiceMesh</command:parameterValue> <dev:type> <maml:name>HCXServiceMesh</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 appliances you want to retrieve. </maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in the list.</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 appliance 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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Type</maml:name> <maml:Description> <maml:para>Specifies the type of the appliances you want to retrieve. The valid values are L2Concentrator, Interconnect, and WANOptimization.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HXCApplianceType</command:parameterValue> <dev:type> <maml:name>HXCApplianceType</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>ServiceMesh</maml:name> <maml:Description> <maml:para>Specifies the Service Mesh for which you want to retrieve the appliances.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXServiceMesh</command:parameterValue> <dev:type> <maml:name>HCXServiceMesh</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.Hcx.Types.V1.HCXAppliance</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-HCXAppliance</dev:code> <dev:remarks> <maml:para>Retrieves the available appliances of type Interconnect, WAN Optimization, and L2Concentrator.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-HCXAppliance -Type L2Concentrator</dev:code> <dev:remarks> <maml:para>Retrieves the available appliances of type L2Concentrator.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-HCXAppliance -Name "myName"</dev:code> <dev:remarks> <maml:para>Retrieves available appliances that match the "myName" name.</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-HCXComputeProfile</command:name> <command:verb>Get</command:verb> <command:noun>HCXComputeProfile</command:noun> <maml:description> <maml:para>This cmdlet retrieves a list of the HCX Compute Profiles.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves a list of the HCX Compute Profiles. These Compute Profiles are required for creating a service mesh which enables Interconnect, Network Extension, and other services.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HCXComputeProfile</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 name of the Compute Profile.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Site</maml:name> <maml:Description> <maml:para>Specifies the HCX site for which you want to list the Compute Profiles. If this parameter is not specified, the default one is selected from the source site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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 name of the Compute Profile.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Site</maml:name> <maml:Description> <maml:para>Specifies the HCX site for which you want to list the Compute Profiles. If this parameter is not specified, the default one is selected from the source site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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.Hcx.Types.V1.HCXSite</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.Hcx.Types.V1.HCXComputeProfile</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-HCXComputeProfile</dev:code> <dev:remarks> <maml:para>Retrieves a list of the HCX Compute Profiles.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-HCXComputeProfile -Name "myComputeProfile"</dev:code> <dev:remarks> <maml:para>Retrieves a list of the HCX Compute Profiles filtered by name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$destination = Get-HCXSite -Destination Get-HCXComputeProfile -Site $destination</dev:code> <dev:remarks> <maml:para>Retrieves a list of the HCX Compute Profiles from the destination site.</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-HCXContainer</command:name> <command:verb>Get</command:verb> <command:noun>HCXContainer</command:noun> <maml:description> <maml:para>This cmdlet retrieves the list of HCX containers.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves a list of HCX containers of type ComputeContainer, Host, Datacenter, Folder, Cluster, ResourcePool, and ComputeResource at the HCXSite. If the HCXSite is not passed as input, then source site containers are listed. You can create new HCX migration and replication requests by using the output of the cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HCXContainer</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 name of the HCX container.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Site</maml:name> <maml:Description> <maml:para>Specifies the HCX site for which you want to list the containers. If this parameter is not specified, the default one is selected from the source site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite[]</command:parameterValue> <dev:type> <maml:name>HCXSite[]</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>Type</maml:name> <maml:Description> <maml:para>Specifies the type of the HCX container. The valid values are ComputeContainer, Host, Datacenter, Folder, Cluster, ResourcePool, and ComputeResource.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">ComputeContainer</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Host</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Datacenter</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Folder</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Cluster</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ResourcePool</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ComputeResource</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ContainerType</command:parameterValue> <dev:type> <maml:name>ContainerType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HCXContainer</maml:name> <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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Uid</maml:name> <maml:Description> <maml:para>Specifies the Uid of the HCX container.</maml:para> <maml:para>Note: When a list of values is specified for the Uid parameter, the returned objects have a Uid that matches exactly one of the string values in the list.</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:syntaxItem> </command:syntax> <command:parameters> <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 name of the HCX container.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Site</maml:name> <maml:Description> <maml:para>Specifies the HCX site for which you want to list the containers. If this parameter is not specified, the default one is selected from the source site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite[]</command:parameterValue> <dev:type> <maml:name>HCXSite[]</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>Type</maml:name> <maml:Description> <maml:para>Specifies the type of the HCX container. The valid values are ComputeContainer, Host, Datacenter, Folder, Cluster, ResourcePool, and ComputeResource.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ContainerType</command:parameterValue> <dev:type> <maml:name>ContainerType</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>Uid</maml:name> <maml:Description> <maml:para>Specifies the Uid of the HCX container.</maml:para> <maml:para>Note: When a list of values is specified for the Uid parameter, the returned objects have a Uid that matches exactly one of the string values in the list.</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:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXSite</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.Hcx.Types.V1.HCXContainer</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-HCXContainer</dev:code> <dev:remarks> <maml:para>Retrieves the available HCX containers at the source site.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-HCXContainer -Type Folder</dev:code> <dev:remarks> <maml:para>Retrieves the available HCX containers of type Folder at the source site.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-HCXContainer -Name "onpremDC*"</dev:code> <dev:remarks> <maml:para>Retrieves the HCX containers by name at the source site.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>$myDestination = Get-HCXSite -Destination Get-HCXContainer -Site $myDestination</dev:code> <dev:remarks> <maml:para>Retrieves the HCX containers from the destination site.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>$myContainer = Get-HCXContainer -Name "myContainerName" Get-HCXContainer -Uid $myContainer.Uid</dev:code> <dev:remarks> <maml:para>Retrieves the HCX container by Uid.</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-HCXDatastore</command:name> <command:verb>Get</command:verb> <command:noun>HCXDatastore</command:noun> <maml:description> <maml:para>This cmdlet retrieves a list of HCX datastores.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves a list of HCX datastores. If the HCXSite is not passed as input, the source site datastores are listed. You can create new HCX migration, replication, and appliance requests by using the output of the cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HCXDatastore</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 name of the HCX datastore.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Site</maml:name> <maml:Description> <maml:para>Specifies the HCX site for which you want to list the datastores. If this parameter is not specified, the default one is selected from the source site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite[]</command:parameterValue> <dev:type> <maml:name>HCXSite[]</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>StorageProfile</maml:name> <maml:Description> <maml:para>Specifies the HCX storage profile matching which you want to list the datastores.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXStorageProfile</command:parameterValue> <dev:type> <maml:name>HCXStorageProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HCXDatastore</maml:name> <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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Uid</maml:name> <maml:Description> <maml:para>Specifies the Uid of the HCX datastore.</maml:para> <maml:para>Note: When a list of values is specified for the Uid parameter, the returned objects have a Uid that matches exactly one of the string values in the list.</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:syntaxItem> </command:syntax> <command:parameters> <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 name of the HCX datastore.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Site</maml:name> <maml:Description> <maml:para>Specifies the HCX site for which you want to list the datastores. If this parameter is not specified, the default one is selected from the source site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite[]</command:parameterValue> <dev:type> <maml:name>HCXSite[]</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>Uid</maml:name> <maml:Description> <maml:para>Specifies the Uid of the HCX datastore.</maml:para> <maml:para>Note: When a list of values is specified for the Uid parameter, the returned objects have a Uid that matches exactly one of the string values in the list.</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>StorageProfile</maml:name> <maml:Description> <maml:para>Specifies the HCX storage profile matching which you want to list the datastores.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXStorageProfile</command:parameterValue> <dev:type> <maml:name>HCXStorageProfile</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.Hcx.Types.V1.HCXSite</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXStorageProfile</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.Hcx.Types.V1.HCXDatastore</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-HCXDatastore</dev:code> <dev:remarks> <maml:para>Retrieves the available HCX datastore at the source site.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-HCXDatastore -Name "myDatastoreName"</dev:code> <dev:remarks> <maml:para>Retrieves the HCX datastore by name at the source site.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$myDestination = Get-HCXSite -Destination -Name "myDestinationName" Get-HCXDatastore -Site $myDestination</dev:code> <dev:remarks> <maml:para>Retrieves the HCX datastore by destination site.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>$myDestination = Get-HCXSite -Destination -Name "myDestinationName" $myStorageProfile = Get-HCXStorageProfile -Site $myDestination -Name "myStorageProfileName" Get-HCXDatastore -Site $myDestination -StorageProfile $myStorageProfile</dev:code> <dev:remarks> <maml:para>Retrieves the HCX datastore by destination site and storage profile.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>$myDatastore = Get-HCXDatastore -Name "myDatastoreName" Get-HCXDatastore -Uid $myDatastore.Uid</dev:code> <dev:remarks> <maml:para>Retrieves the HCX datastore by Uid.</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-HCXGateway</command:name> <command:verb>Get</command:verb> <command:noun>HCXGateway</command:noun> <maml:description> <maml:para>This cmdlet retrieves a list of HCX gateways.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves a list of HCX gateways. This retrieves the gateways from the destination site. You can create a new HCX network extension request by using the output of the cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HCXGateway</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 name of the HCX 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="True (ByValue)" position="named" aliases="none"> <maml:name>DestinationSite</maml:name> <maml:Description> <maml:para>Specifies the destination site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite[]</command:parameterValue> <dev:type> <maml:name>HCXSite[]</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>DestinationSite</maml:name> <maml:Description> <maml:para>Specifies the destination site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite[]</command:parameterValue> <dev:type> <maml:name>HCXSite[]</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 name of the HCX 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="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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.Hcx.Types.V1.HCXSite[]</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.Hcx.Types.V1.HCXGateway</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>$myDestination = Get-HCXSite -Destination -Name "myDestinationName" Get-HCXGateway -DestinationSite $myDestination</dev:code> <dev:remarks> <maml:para>Retrieves the HCX gateway by destination site.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$myDestination = Get-HCXSite -Destination -Name "myDestinationName" Get-HCXGateway -DestinationSite $myDestination -Name "myGatewayName"</dev:code> <dev:remarks> <maml:para>Retrieves the HCX gateway by name.</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-HCXInterconnectStatus</command:name> <command:verb>Get</command:verb> <command:noun>HCXInterconnectStatus</command:noun> <maml:description> <maml:para>This cmdlet retrieves a list of the HCX Interconnect status.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves a list of the HCX Interconnect status and the status of the appliances of type Interconnect and L2Concentrator.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HCXInterconnectStatus</maml:name> <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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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.Hcx.Types.V1.HCXInterconnectStatus</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-HCXInterconnectStatus</dev:code> <dev:remarks> <maml:para>Retrieves the status of the applainces of type Interconnect and L2Concentrator.</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-HCXInventoryCompute</command:name> <command:verb>Get</command:verb> <command:noun>HCXInventoryCompute</command:noun> <maml:description> <maml:para>This cmdlet retrieves a list of vCenter Server compute resources from the connected HCX server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves a list of vCenter Server compute resources. You can use the output of the cmdlet for creating ? Compute Profile and an HCX Appliance request.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HCXInventoryCompute</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 name of the vCenter Server compute.</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="True (ByValue)" position="named" aliases="none"> <maml:name>Cluster</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server cluster filter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceCompute[]</command:parameterValue> <dev:type> <maml:name>HCXApplianceCompute[]</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HCXInventoryCompute</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 name of the vCenter Server compute.</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>ClusterComputeResource</maml:name> <maml:Description> <maml:para>Indicates that you want to fetch clusters.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HCXInventoryCompute</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 name of the vCenter Server compute.</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="True (ByValue)" position="named" aliases="none"> <maml:name>DVS</maml:name> <maml:Description> <maml:para>Specifies the DVS filter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceDVS</command:parameterValue> <dev:type> <maml:name>HCXApplianceDVS</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HCXInventoryCompute</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 name of the vCenter Server compute.</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="True (ByValue)" position="named" aliases="none"> <maml:name>Network</maml:name> <maml:Description> <maml:para>Specifies the HCX networks. These include networks of type Network, DistributedVirtualPortgroup, VirtualWire, and VirtualNetwork.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetwork</command:parameterValue> <dev:type> <maml:name>HCXNetwork</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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 vCenter Server cluster filter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceCompute[]</command:parameterValue> <dev:type> <maml:name>HCXApplianceCompute[]</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>ClusterComputeResource</maml:name> <maml:Description> <maml:para>Indicates that you want to fetch clusters.</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>DVS</maml:name> <maml:Description> <maml:para>Specifies the DVS filter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceDVS</command:parameterValue> <dev:type> <maml:name>HCXApplianceDVS</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 name of the vCenter Server compute.</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="True (ByValue)" position="named" aliases="none"> <maml:name>Network</maml:name> <maml:Description> <maml:para>Specifies the HCX networks. These include networks of type Network, DistributedVirtualPortgroup, VirtualWire, and VirtualNetwork.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetwork</command:parameterValue> <dev:type> <maml:name>HCXNetwork</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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.Hcx.Types.V1.HCXNetwork</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXApplianceDVS</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXApplianceCompute[]</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.Hcx.Types.V1.HCXApplianceCompute</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>$myNetwork = Get-HCXNetwork -Name "myName" Get-HCXInventoryCompute -Network $myNetwork</dev:code> <dev:remarks> <maml:para>Retrieves a list of vCenter Server compute resources filtered by network.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$myDvs = Get-HCXInventoryDVS -Name "myDvs" Get-HCXInventoryCompute -DVS $myDvs</dev:code> <dev:remarks> <maml:para>Retrieves ? list of vCenter Server compute resources filtered by DVS (Distributed Virtual Switch).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$myDvs = Get-HCXInventoryDVS -Name "myDvs" Get-HCXInventoryCompute -DVS $myDvs -Name "myName"</dev:code> <dev:remarks> <maml:para>Retrieves a list of vCenter Server compute resources filtered by name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-HCXInventoryCompute -ClusterComputeResource</dev:code> <dev:remarks> <maml:para>Retrieves a list of vCenter Server ClusterComputeResource.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>$myCluster = Get-HCXInventoryCompute -ClusterComputeResource Get-HCXInventoryCompute -Cluster $myCluster</dev:code> <dev:remarks> <maml:para>Retrieves a list of vCenter Server compute resources filtered by 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-HCXInventoryDatastore</command:name> <command:verb>Get</command:verb> <command:noun>HCXInventoryDatastore</command:noun> <maml:description> <maml:para>This cmdlet retrieves a list of the vCenter Server datastore from the connected HCX server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves a list of the vCenter Server datastore. You can use the output of the cmdlet for creating a Compute Profile and an HCX Appliance request.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HCXInventoryDatastore</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 name of the vCenter Server datastore.</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="True (ByValue)" position="named" aliases="none"> <maml:name>Compute</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server compute filter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceCompute[]</command:parameterValue> <dev:type> <maml:name>HCXApplianceCompute[]</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Compute</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server compute filter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceCompute[]</command:parameterValue> <dev:type> <maml:name>HCXApplianceCompute[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 name of the vCenter Server datastore.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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.Hcx.Types.V1.HCXApplianceCompute[]</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.Hcx.Types.V1.HCXApplianceDatastore</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>$myNetwork = Get-HCXNetwork -Name "myNetworkName" $myCompute = Get-HCXInventoryCompute -Network $myNetwork Get-HCXInventoryDatastore -Compute $myCompute</dev:code> <dev:remarks> <maml:para>Retrieves a list of the vCenter Server datastore filtered by compute.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$myNetwork = Get-HCXNetwork -Name "myNetworkName" $myCompute = Get-HCXInventoryCompute -Network $myNetwork Get-HCXInventoryDatastore -Compute $myCompute -Name "myDatastoreName"</dev:code> <dev:remarks> <maml:para>Retrieves a list of the vCenter Server datastore filtered by name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$myCluster = Get-HCXInventoryCompute -ClusterComputeResource -Name 'myCluster' Get-HCXInventoryDatastore -Compute $myCluster</dev:code> <dev:remarks> <maml:para>Retrieves a list of the vCenter Server datastore filtered by compute.</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-HCXInventoryDVS</command:name> <command:verb>Get</command:verb> <command:noun>HCXInventoryDVS</command:noun> <maml:description> <maml:para>This cmdlet retrieves a list of the vCenter Server Distributed Virtual Switch (DVS) from the connected HCX server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves a list of the vCenter Server DVS. You can use the output of the cmdlet for creating a Compute Profile and an HCX Appliance request.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HCXInventoryDVS</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 name of the vCenter Server DVS.</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="True (ByValue)" position="named" aliases="none"> <maml:name>Compute</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server compute.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceCompute[]</command:parameterValue> <dev:type> <maml:name>HCXApplianceCompute[]</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HCXInventoryDVS</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 name of the vCenter Server DVS.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HCXInventoryDVS</maml:name> <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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Uid</maml:name> <maml:Description> <maml:para>Specifies the Uid of the vCenter Server DVS.</maml:para> <maml:para>Note: When a list of values is specified for the Uid parameter, the returned objects have a Uid that matches exactly one of the string values in the list.</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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Compute</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server compute.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceCompute[]</command:parameterValue> <dev:type> <maml:name>HCXApplianceCompute[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</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 name of the vCenter Server DVS.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Uid</maml:name> <maml:Description> <maml:para>Specifies the Uid of the vCenter Server DVS.</maml:para> <maml:para>Note: When a list of values is specified for the Uid parameter, the returned objects have a Uid that matches exactly one of the string values in the list.</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:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXApplianceCompute[]</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.Hcx.Types.V1.HCXApplianceDVS</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-HCXInventoryDVS</dev:code> <dev:remarks> <maml:para>Retrieves a list of the vCenter Server DVS.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-HCXInventoryDVS -Name "myDvs"</dev:code> <dev:remarks> <maml:para>Retrieves a list of the vCenter Server DVS filtered by name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$myDvs = Get-HCXInventoryDVS Get-HCXInventoryDVS -Uid $myDvs.Uid</dev:code> <dev:remarks> <maml:para>Retrieves a list of the vCenter Server DVS filtered by Uid.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>$myCompute = Get-HCXInventoryCompute -ClusterComputeResource -Name "myCompute" Get-HCXInventoryDVS -Compute $myCompute</dev:code> <dev:remarks> <maml:para>Retrieves a list of the vCenter Server DVS filtered by compute.</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-HCXInventoryNetwork</command:name> <command:verb>Get</command:verb> <command:noun>HCXInventoryNetwork</command:noun> <maml:description> <maml:para>This cmdlet retrieves a list of the vCenter Server network from the connected HCX server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves a list of the vCenter Server network. You can use the output of the cmdlet for creating a new HCX Appliance request.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HCXInventoryNetwork</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 name of the vCenter Server network.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HCXInventoryNetwork</maml:name> <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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Uid</maml:name> <maml:Description> <maml:para>Specifies the Uid of the vCenter Server network.</maml:para> <maml:para>Note: When a list of values is specified for the Uid parameter, the returned objects have a Uid that matches exactly one of the string values in the list.</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: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 name of the vCenter Server network.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Uid</maml:name> <maml:Description> <maml:para>Specifies the Uid of the vCenter Server network.</maml:para> <maml:para>Note: When a list of values is specified for the Uid parameter, the returned objects have a Uid that matches exactly one of the string values in the list.</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: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.Hcx.Types.V1.HCXApplianceNetwork</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-HCXInventoryNetwork</dev:code> <dev:remarks> <maml:para>Retrieves a list of the vCenter Server network.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-HCXInventoryNetwork -Name "myName"</dev:code> <dev:remarks> <maml:para>Retrieves a list of the vCenter Server network filtered by name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$myNetwork = Get-HCXInventoryNetwork Get-HCXInventoryNetwork -Uid $myNetwork.Uid</dev:code> <dev:remarks> <maml:para>Retrieves a list of the vCenter Server network filtered by Uid.</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-HCXJob</command:name> <command:verb>Get</command:verb> <command:noun>HCXJob</command:noun> <maml:description> <maml:para>This cmdlet retrieves a list of the HCX job.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves a list of the HCX job.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HCXJob</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 Id of the Job.</maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have a Uid that matches exactly one of the string values in the list.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Job</maml:name> <maml:Description> <maml:para>Specifies the Job.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXJob[]</command:parameterValue> <dev:type> <maml:name>HCXJob[]</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 Id of the Job.</maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have a Uid that matches exactly one of the string values in the list.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Job</maml:name> <maml:Description> <maml:para>Specifies the Job.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXJob[]</command:parameterValue> <dev:type> <maml:name>HCXJob[]</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.Hcx.Types.V1.HCXJob</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-HCXJob -Id "myJobId"</dev:code> <dev:remarks> <maml:para>Retrieves the job details for 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-HCXMigration</command:name> <command:verb>Get</command:verb> <command:noun>HCXMigration</command:noun> <maml:description> <maml:para>This cmdlet retrieves the list of HCX migrations.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the list of HCX migrations.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HCXMigration</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EntityId</maml:name> <maml:Description> <maml:para>Specifies the virtual machine ID for which you want to retrieve a list of the HCX migrations.</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>MigrationType</maml:name> <maml:Description> <maml:para>Specifies the type of migration that you want to retrieve.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">vMotion</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Bulk</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Cold</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RAV</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OsAssistedMigration</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">MigrationType</command:parameterValue> <dev:type> <maml:name>MigrationType</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>NumberOfMigration</maml:name> <maml:Description> <maml:para>Specifies the number of migrations that you want to retrieve.</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>Server</maml:name> <maml:Description> <maml:para>Specifies the HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>State</maml:name> <maml:Description> <maml:para>Specifies the state of migrations that you want to retrieve.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">MIGRATED</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MIGRATE_CANCELED</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MIGRATE_FAILED</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MIGRATING</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">MigrationState</command:parameterValue> <dev:type> <maml:name>MigrationState</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>Username</maml:name> <maml:Description> <maml:para>Filters the retrieved list of migrations by the username of the user.</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:syntaxItem> <command:syntaxItem> <maml:name>Get-HCXMigration</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 ID of the migration that 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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>EntityId</maml:name> <maml:Description> <maml:para>Specifies the virtual machine ID for which you want to retrieve a list of the HCX migrations.</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>Id</maml:name> <maml:Description> <maml:para>Specifies the ID of the migration that 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>MigrationType</maml:name> <maml:Description> <maml:para>Specifies the type of migration that you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">MigrationType</command:parameterValue> <dev:type> <maml:name>MigrationType</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>NumberOfMigration</maml:name> <maml:Description> <maml:para>Specifies the number of migrations that you want to retrieve.</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>Server</maml:name> <maml:Description> <maml:para>Specifies the HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>State</maml:name> <maml:Description> <maml:para>Specifies the state of migrations that you want to retrieve.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">MigrationState</command:parameterValue> <dev:type> <maml:name>MigrationState</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>Username</maml:name> <maml:Description> <maml:para>Filters the retrieved list of migrations by the username of the user.</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.Hcx.Types.V1.HCXMigration[]</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-HCXMigration -NumberOfMigration 10 -Username abc -State MIGRATE_FAILED -MigrationType Bulk -EntityId vm-101</dev:code> <dev:remarks> <maml:para>Retrieves 10 HCX migrations where username is abc, state is failed, migration type is bulk, and entityId is vm-101.</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-HCXMobilityGroup</command:name> <command:verb>Get</command:verb> <command:noun>HCXMobilityGroup</command:noun> <maml:description> <maml:para>This cmdlet retrieves a list of HCX mobility groups.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves a list of HCX mobility groups.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HCXMobilityGroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Detailed</maml:name> <maml:Description> <maml:para>Indicates whether you can retrieve the full definition of a mobility group when using the Detailed parameter.</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>Id</maml:name> <maml:Description> <maml:para>Retrieves group details for the given mobility group 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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HCXMobilityGroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Detailed</maml:name> <maml:Description> <maml:para>Indicates whether you can retrieve the full definition of a mobility group when using the Detailed parameter.</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>Name</maml:name> <maml:Description> <maml:para>Retrieves group details for the given mobility group name.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Detailed</maml:name> <maml:Description> <maml:para>Indicates whether you can retrieve the full definition of a mobility group when using the Detailed parameter.</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>Id</maml:name> <maml:Description> <maml:para>Retrieves group details for the given mobility group 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>Name</maml:name> <maml:Description> <maml:para>Retrieves group details for the given mobility group name.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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.Hcx.Types.V1.HCXMobilityGroup</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-HCXMobilityGroup</dev:code> <dev:remarks> <maml:para>Retrieves list of all HCX Mobility Group.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-HCXMobilityGroup -Name "myMobilityGroup" -Detailed</dev:code> <dev:remarks> <maml:para>Retrieves a mobility group with the "myMobilityGroup" name. By adding the Detailed parameter, you can retrieve all migrations and configurations.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-HCXMobilityGroup -Id "myMobilityGroupId"</dev:code> <dev:remarks> <maml:para>Retrieves a mobility group 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-HCXNetwork</command:name> <command:verb>Get</command:verb> <command:noun>HCXNetwork</command:noun> <maml:description> <maml:para>This cmdlet retrieves a list of HCX networks.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves a list of HCX networks. If the HCXSite is not passed as input, the source site networks are listed. You can create new HCX migration, replication, network extension, and appliance requests by using the output of the cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HCXNetwork</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 name of the HCX network.</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>Appliance</maml:name> <maml:Description> <maml:para>Specifies the L2Concentrator appliance to filter networks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXAppliance</command:parameterValue> <dev:type> <maml:name>HCXAppliance</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>DVSName</maml:name> <maml:Description> <maml:para>{{ Fill DVSName Description }}</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>ForExtension</maml:name> <maml:Description> <maml:para>{{ Fill ForExtension Description }}</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Site</maml:name> <maml:Description> <maml:para>Specifies the HCX site for which you want to list the networks. If this parameter is not specified, the default one is selected from the source site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite[]</command:parameterValue> <dev:type> <maml:name>HCXSite[]</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>Type</maml:name> <maml:Description> <maml:para>Specifies the type of the HCX network. The valid values are Network, DistributedVirtualPortgroup, VirtualWire, NsxtSegment, OpaqueNetwork, OrgVdcNetwork and VirtualNetwork.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Network</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DistributedVirtualPortgroup</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">VirtualWire</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">VirtualNetwork</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OrgVdcNetwork</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NsxtSegment</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OpaqueNetwork</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">NetworkType</command:parameterValue> <dev:type> <maml:name>NetworkType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HCXNetwork</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 name of the HCX network.</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>DVSName</maml:name> <maml:Description> <maml:para>{{ Fill DVSName Description }}</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Site</maml:name> <maml:Description> <maml:para>Specifies the HCX site for which you want to list the networks. If this parameter is not specified, the default one is selected from the source site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite[]</command:parameterValue> <dev:type> <maml:name>HCXSite[]</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>Type</maml:name> <maml:Description> <maml:para>Specifies the type of the HCX network. The valid values are Network, DistributedVirtualPortgroup, VirtualWire, NsxtSegment, OpaqueNetwork, OrgVdcNetwork and VirtualNetwork.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Network</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DistributedVirtualPortgroup</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">VirtualWire</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">VirtualNetwork</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OrgVdcNetwork</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NsxtSegment</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OpaqueNetwork</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">NetworkType</command:parameterValue> <dev:type> <maml:name>NetworkType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HCXNetwork</maml:name> <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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Uid</maml:name> <maml:Description> <maml:para>Specifies the Uid of the HCX network.</maml:para> <maml:para>Note: When a list of values is specified for the Uid parameter, the returned objects have a Uid that matches exactly one of the string values in the list.</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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Appliance</maml:name> <maml:Description> <maml:para>Specifies the L2Concentrator appliance to filter networks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXAppliance</command:parameterValue> <dev:type> <maml:name>HCXAppliance</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>DVSName</maml:name> <maml:Description> <maml:para>{{ Fill DVSName Description }}</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>ForExtension</maml:name> <maml:Description> <maml:para>{{ Fill ForExtension Description }}</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 name of the HCX network.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Site</maml:name> <maml:Description> <maml:para>Specifies the HCX site for which you want to list the networks. If this parameter is not specified, the default one is selected from the source site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite[]</command:parameterValue> <dev:type> <maml:name>HCXSite[]</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>Type</maml:name> <maml:Description> <maml:para>Specifies the type of the HCX network. The valid values are Network, DistributedVirtualPortgroup, VirtualWire, NsxtSegment, OpaqueNetwork, OrgVdcNetwork and VirtualNetwork.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NetworkType</command:parameterValue> <dev:type> <maml:name>NetworkType</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>Uid</maml:name> <maml:Description> <maml:para>Specifies the Uid of the HCX network.</maml:para> <maml:para>Note: When a list of values is specified for the Uid parameter, the returned objects have a Uid that matches exactly one of the string values in the list.</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:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXSite</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.Hcx.Types.V1.HCXNetwork</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-HCXNetwork</dev:code> <dev:remarks> <maml:para>Retrieves the available HCX network at the source site.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-HCXNetwork -Name "myNetworkName"</dev:code> <dev:remarks> <maml:para>Retrieves the HCX network by name at the source site.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-HCXNetwork -Type DistributedVirtualPortgroup</dev:code> <dev:remarks> <maml:para>Retrieves the HCX network by type at the source site.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>$myDestination = Get-HCXSite -Destination -Name "myDestinationName" Get-HCXNetwork -Site $myDestination</dev:code> <dev:remarks> <maml:para>Retrieves the HCX network by destination site.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>$myL2concentrator = Get-HCXAppliance -Type L2Concentrator -Name "myL2ConcentratorName" Get-HCXNetwork -ForExtension -Appliance $myL2concentrator</dev:code> <dev:remarks> <maml:para>Retrieves the HCX network by L2Concentrator.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <dev:code>$myNetwork = Get-HCXNetwork -Name "myNetworkName" Get-HCXNetwork -Uid $myNetwork.Uid</dev:code> <dev:remarks> <maml:para>Retrieves the HCX network by Uid.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 7 --------------------------</maml:title> <dev:code>$myNetwork = Get-HCXNetwork -Type NsxtSegment</dev:code> <dev:remarks> <maml:para>Retrieves the HCX network by type NsxtSegment present in Nsxt sites.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 8 --------------------------</maml:title> <dev:code>$myL2concentrator = Get-HCXAppliance -Type L2Concentrator -Name "myL2ConcentratorName" Get-HCXNetwork -ForExtension -Appliance $myL2concentrator -DVSName "myDvs"</dev:code> <dev:remarks> <maml:para>Retrieves the HCX network by L2Concentrator and filtered by DvsName.</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-HCXNetworkBacking</command:name> <command:verb>Get</command:verb> <command:noun>HCXNetworkBacking</command:noun> <maml:description> <maml:para>This cmdlet retrieves a list of HCX Network Backings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves ? list of HCX Network Backings. These Network Backings are required for creating a network profile.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HCXNetworkBacking</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 name of the network backing.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Type</maml:name> <maml:Description> <maml:para>Specifies the type of the HCX network backing.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">DistributedVirtualPortgroup</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">StandardPortgroup</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">VirtualWire</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NsxtSegment</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">External</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OrgVdc</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">NetworkBackingType[]</command:parameterValue> <dev:type> <maml:name>NetworkBackingType[]</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 name of the network backing.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Type</maml:name> <maml:Description> <maml:para>Specifies the type of the HCX network backing.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">NetworkBackingType[]</command:parameterValue> <dev:type> <maml:name>NetworkBackingType[]</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.Hcx.Types.V1.HCXNetworkBacking</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-HCXNetworkBacking</dev:code> <dev:remarks> <maml:para>Retrieves a list of HCX network backings.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-HCXNetworkBacking -Name "myNetworkBacking"</dev:code> <dev:remarks> <maml:para>Retrieves a list of HCX network backings filtered by name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-HCXNetworkBacking -Type DistributedVirtualPortgroup</dev:code> <dev:remarks> <maml:para>Retrieves the available network backings of type DistributedVirtualPortgroup.</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-HCXNetworkExtension</command:name> <command:verb>Get</command:verb> <command:noun>HCXNetworkExtension</command:noun> <maml:description> <maml:para>This cmdlet retrieves a list of HCX Network Extension (HCX-NET-EXT).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves a list of HCX Network Extension (L2 extensions).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HCXNetworkExtension</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>DestinationSite</maml:name> <maml:Description> <maml:para>Specifies the destination site which refers to the cloud site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite[]</command:parameterValue> <dev:type> <maml:name>HCXSite[]</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HCXNetworkExtension</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 network extenstion you want to retrieve. </maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in that list.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="True (ByValue)" position="named" aliases="none"> <maml:name>DestinationSite</maml:name> <maml:Description> <maml:para>Specifies the destination site which refers to the cloud site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite[]</command:parameterValue> <dev:type> <maml:name>HCXSite[]</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>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the network extenstion you want to retrieve. </maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in that list.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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.Hcx.Types.V1.HCXSite[]</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.Hcx.Types.V1.HCXNetworkExtension</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-HCXNetworkExtension</dev:code> <dev:remarks> <maml:para>Retrieves a list of network extenstion.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$myDestination = Get-HCXSite -Destination Get-HCXNetworkExtension -DestinationSite $myDestination[0]</dev:code> <dev:remarks> <maml:para>Retrieves a list of network extenstion from the destination site.</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-HCXNetworkProfile</command:name> <command:verb>Get</command:verb> <command:noun>HCXNetworkProfile</command:noun> <maml:description> <maml:para>This cmdlet retrieves a list of HCX Network Profiles.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves a list of HCX Network Profiles.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HCXNetworkProfile</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 name of the HCX Network Profile.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Site</maml:name> <maml:Description> <maml:para>Specifies the HCX site for which you want to list the Network Profiles. If this parameter is not specified, the default one is selected from the source site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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 name of the HCX Network Profile.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Site</maml:name> <maml:Description> <maml:para>Specifies the HCX site for which you want to list the Network Profiles. If this parameter is not specified, the default one is selected from the source site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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.Hcx.Types.V1.HCXNetworkProfile</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-HCXNetworkProfile</dev:code> <dev:remarks> <maml:para>Retrieves a list of HCX Network Profiles.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-HCXNetworkProfile -Name "myNetworkProfile"</dev:code> <dev:remarks> <maml:para>Retrieves list of network profiles filtered by Name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$destination = Get-HCXSite -Destination Get-HCXNetworkProfile -Site $destination</dev:code> <dev:remarks> <maml:para>Retrieves a list of the HCX Network Profiles from the destination site.</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-HCXReplication</command:name> <command:verb>Get</command:verb> <command:noun>HCXReplication</command:noun> <maml:description> <maml:para>This cmdlet retrieves a list of HCX replications.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves a list of HCX replications.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HCXReplication</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 replication you want to retrieve. </maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in the list.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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 replication you want to retrieve. </maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in the list.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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.Hcx.Types.V1.HCXReplication</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-HCXReplication</dev:code> <dev:remarks> <maml:para>Retrieves a list of replications.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-HCXReplication -Id "myReplicationId"</dev:code> <dev:remarks> <maml:para>Retrieves a replication by the replication 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-HCXReplicationSnapshot</command:name> <command:verb>Get</command:verb> <command:noun>HCXReplicationSnapshot</command:noun> <maml:description> <maml:para>This cmdlet retrieves a list of HCX replication snapshots.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves a list of HCX replication snapshots.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HCXReplicationSnapshot</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Replication</maml:name> <maml:Description> <maml:para>Specifies the replication for which you want to retrieve the snapshot.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXReplication[]</command:parameterValue> <dev:type> <maml:name>HCXReplication[]</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>Id</maml:name> <maml:Description> <maml:para>Specifies the IDs of the replication snapshot you want to retrieve. </maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in the list.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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 replication snapshot you want to retrieve. </maml:para> <maml:para>Note: When a list of values is specified for the Id parameter, the returned objects have an ID that matches exactly one of the string values in the list.</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="True (ByValue)" position="0" aliases="none"> <maml:name>Replication</maml:name> <maml:Description> <maml:para>Specifies the replication for which you want to retrieve the snapshot.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXReplication[]</command:parameterValue> <dev:type> <maml:name>HCXReplication[]</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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.Hcx.Types.V1.HCXReplication[]</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.Hcx.Types.V1.HCXReplicationSnapshot</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-HCXReplicationSnapshot -Replication $myReplication</dev:code> <dev:remarks> <maml:para>Retrieves replication snapshots.</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-HCXService</command:name> <command:verb>Get</command:verb> <command:noun>HCXService</command:noun> <maml:description> <maml:para>This cmdlet retrieves PSObject objects that represent a proxy to an HCX API service.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves PSObject objects that represent a proxy to an HCX API service and can be used to invoke the operations of the HCX API service.</maml:para> <maml:para>Every service proxy has a top-level Help property that contains documentation about the service's methods, parameters, constants, and so on. The Help object is hierarchical and mirrors the rest of the service's methods, parameters, constants, and so on. You can use the Help object for easy creation of parameters that the service methods accept through a method named "Create".</maml:para> <maml:para>The "Create" method is available for the following objects: - A parameter.</maml:para> <maml:para>-Elements of a parameter that is of type List, Set, or Optional. - Key and Value of a parameter of type Map.</maml:para> <maml:para>- Fields of a parameter of type Structure.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HCXService</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 a name for the service type ID that 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 HCX 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-HCXServer 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="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies a name for the service type ID that 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 HCX 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-HCXServer 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>System.Management.Automation.PSObject</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-HCXService -Name 'com.vmware.hcx.migration.migration'</dev:code> <dev:remarks> <maml:para>Retrieves the binding for the specified service.</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-HCXServiceMesh</command:name> <command:verb>Get</command:verb> <command:noun>HCXServiceMesh</command:noun> <maml:description> <maml:para>This cmdlet retrieves a list of the HCX Service Mesh.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves a list of the HCX Service Mesh.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HCXServiceMesh</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 Id of the HCX Service Mesh.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HCXServiceMesh</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 name of the HCX Service Mesh.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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 Id of the HCX Service Mesh.</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="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the HCX Service Mesh.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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.Hcx.Types.V1.HCXServiceMesh</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-HCXServiceMesh</dev:code> <dev:remarks> <maml:para>Retrieves a list of the HCX Service Mesh.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-HCXServiceMesh -Name "myServiceMesh"</dev:code> <dev:remarks> <maml:para>Retrieves a list of the HCX service mesh filtered by name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-HCXServiceMesh -Id "servicemesh-013cc385-4af7-421f-a934-df628263b641"</dev:code> <dev:remarks> <maml:para>Retrieves a list of the HCX service mesh filtered by 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-HCXSite</command:name> <command:verb>Get</command:verb> <command:noun>HCXSite</command:noun> <maml:description> <maml:para>This cmdlet retrieves a list of HCX sites.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves a list of HCX sites and local/remote HCXSites according to the Source or Destination parameters. You can create new HCX migration, replication, and network extension requests by using the output of the cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HCXSite</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 name of the HCX site.</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>Destination</maml:name> <maml:Description> <maml:para>Specifies the destination site from which you can retrieve sites.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HCXSite</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 Id of the HCX site.</maml:para> <maml:para>Note: When a list of values is specified for the Uid parameter, the returned objects have a Uid that matches exactly one of the string values in the list.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HCXSite</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 name of the HCX site.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HCXSite</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 name of the HCX site.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Source</maml:name> <maml:Description> <maml:para>Specifies the sites that you want to retrieve from the source site.</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>Destination</maml:name> <maml:Description> <maml:para>Specifies the destination site from which you can retrieve sites.</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>Id</maml:name> <maml:Description> <maml:para>Specifies the Id of the HCX site.</maml:para> <maml:para>Note: When a list of values is specified for the Uid parameter, the returned objects have a Uid that matches exactly one of the string values in the list.</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 name of the HCX site.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Source</maml:name> <maml:Description> <maml:para>Specifies the sites that you want to retrieve from the source site.</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.Hcx.Types.V1.HCXSite</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-HCXSite</dev:code> <dev:remarks> <maml:para>Retrieves a list of the HCX site at the source site.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-HCXSite -Destination</dev:code> <dev:remarks> <maml:para>Retrieves a list of the HCX site at the destination site.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-HCXSite -Name "mySiteName"</dev:code> <dev:remarks> <maml:para>Retrieves a list of the HCX site by name.</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-HCXSitePairing</command:name> <command:verb>Get</command:verb> <command:noun>HCXSitePairing</command:noun> <maml:description> <maml:para>This cmdlet retrieves a list of site pairings from the HCX.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves a list of site pairings from the HCX (Hybrid Cloud Extension).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HCXSitePairing</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Url</maml:name> <maml:Description> <maml:para>Specifies the URL of the registered remote HCX site.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Server</maml:name> <maml:Description> <maml:para>Specifies the HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Url</maml:name> <maml:Description> <maml:para>Specifies the URL of the registered remote HCX site.</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: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.HCX.Types.V1.HCXSitePairing</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-HCXSitePairing</dev:code> <dev:remarks> <maml:para>Retrieves the list of already registered HCX sites.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-HCXSitePairing -Url $url</dev:code> <dev:remarks> <maml:para>Retrieves the site pairing with the specified URL.</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-HCXStorageProfile</command:name> <command:verb>Get</command:verb> <command:noun>HCXStorageProfile</command:noun> <maml:description> <maml:para>This cmdlet retrieves a list of HCX storage profiles.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves a list of HCX storage profiles. If the HCXSite is not passed as input, the source site storage profiles are listed. You can create new HCX migration, replication, and get datastores by using the output of the cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HCXStorageProfile</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 name of the HCX storage profile.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Site</maml:name> <maml:Description> <maml:para>Specifies the HCX site for which you want to list the storage profiles. If this parameter is not specified, the default one is selected from the source site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite[]</command:parameterValue> <dev:type> <maml:name>HCXSite[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HCXStorageProfile</maml:name> <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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Uid</maml:name> <maml:Description> <maml:para>Specifies the Uid of the HCX storage profile.</maml:para> <maml:para>Note: When a list of values is specified for the Uid parameter, the returned objects have a Uid that matches exactly one of the string values in the list.</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: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 name of the HCX storage profile.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Site</maml:name> <maml:Description> <maml:para>Specifies the HCX site for which you want to list the storage profiles. If this parameter is not specified, the default one is selected from the source site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite[]</command:parameterValue> <dev:type> <maml:name>HCXSite[]</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>Uid</maml:name> <maml:Description> <maml:para>Specifies the Uid of the HCX storage profile.</maml:para> <maml:para>Note: When a list of values is specified for the Uid parameter, the returned objects have a Uid that matches exactly one of the string values in the list.</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:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXSite[]</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.Hcx.Types.V1.HCXStorageProfile</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-HCXStorageProfile</dev:code> <dev:remarks> <maml:para>Retrieves the available HCX storage profiles at the source site.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-HCXStorageProfile -Name "myStorageProfileName"</dev:code> <dev:remarks> <maml:para>Retrieves the HCX storage profile by name at the source site.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$myDestination = Get-HCXSite -Destination -Name "myDestinationName" Get-HCXStorageProfile -Site $myDestination</dev:code> <dev:remarks> <maml:para>Retrieves the HCX storage profile by destination site.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>$myStorageProfile = Get-HCXStorageProfile -Name "myStorageProfileName" Get-HCXStorageProfile -Uid $myStorageProfile.Uid</dev:code> <dev:remarks> <maml:para>Retrieves the HCX storage profile by Uid.</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-HCXVM</command:name> <command:verb>Get</command:verb> <command:noun>HCXVM</command:noun> <maml:description> <maml:para>This cmdlet retrieves a list of virtual machines (VMs).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves a list of virtual machines. You can create new HCX migration and replication requests by using the output of the cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-HCXVM</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 name of the HCX virtual machine.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Site</maml:name> <maml:Description> <maml:para>Specifies the HCX site for which you want to list the virtual machines. If this parameter is not specified, the default one is selected from the source site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite[]</command:parameterValue> <dev:type> <maml:name>HCXSite[]</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>PowerState</maml:name> <maml:Description> <maml:para>Indicates the virtual machine power state. The valid values are PoweredOn and PoweredOff.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerState</command:parameterValue> <dev:type> <maml:name>PowerState</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>Container</maml:name> <maml:Description> <maml:para>Specifies the HCX container for which you want to list the virtual machines.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXContainer[]</command:parameterValue> <dev:type> <maml:name>HCXContainer[]</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>Offset</maml:name> <maml:Description> <maml:para>Specifies the pagination parameter. Offset and Limit both has to be set to an integer greater than 0 and used together.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Integer</command:parameterValue> <dev:type> <maml:name>Integer</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>Limit</maml:name> <maml:Description> <maml:para>Specifies the maximum number of Virtual Machines to be retrieved. Max of Limit or 500 will be used if the Limit and Offset both are set to integer greater than 0</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Integer</command:parameterValue> <dev:type> <maml:name>Integer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-HCXVM</maml:name> <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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Uid</maml:name> <maml:Description> <maml:para>Specifies the Uid of the HCX virtual machine.</maml:para> <maml:para>Note: When a list of values is specified for the Uid parameter, the returned objects have a Uid that matches exactly one of the string values in the list.</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:syntaxItem> </command:syntax> <command:parameters> <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 name of the HCX virtual machine.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Site</maml:name> <maml:Description> <maml:para>Specifies the HCX site for which you want to list the virtual machines. If this parameter is not specified, the default one is selected from the source site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite[]</command:parameterValue> <dev:type> <maml:name>HCXSite[]</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>PowerState</maml:name> <maml:Description> <maml:para>Indicates the virtual machine power state. The valid values are PoweredOn and PoweredOff.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PowerState</command:parameterValue> <dev:type> <maml:name>PowerState</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>Uid</maml:name> <maml:Description> <maml:para>Specifies the Uid of the HCX virtual machine.</maml:para> <maml:para>Note: When a list of values is specified for the Uid parameter, the returned objects have a Uid that matches exactly one of the string values in the list.</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>Container</maml:name> <maml:Description> <maml:para>Specifies the HCX container for which you want to list the virtual machines.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXContainer[]</command:parameterValue> <dev:type> <maml:name>HCXContainer[]</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>Offset</maml:name> <maml:Description> <maml:para>Specifies the pagination parameter. Offset and Limit both has to be set to an integer greater than 0 and used together.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Integer</command:parameterValue> <dev:type> <maml:name>Integer</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>Limit</maml:name> <maml:Description> <maml:para>Specifies the maximum number of Virtual Machines to be retrieved. Max of Limit or 500 will be used if the Limit and Offset both are set to integer greater than 0</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Integer</command:parameterValue> <dev:type> <maml:name>Integer</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.Hcx.Types.V1.HCXSite</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.Hcx.Types.V1.HCXVM</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-HCXVM</dev:code> <dev:remarks> <maml:para>Retrieves a list of the HCX virtual machines from the source site.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$myDestination = Get-HCXSite -Destination -Name "myDestinationName" Get-HCXVM -Site $myDestination</dev:code> <dev:remarks> <maml:para>Retrieves a list of the HCX virtual machines from the destination site.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-HCXVM -Name "myVmName"</dev:code> <dev:remarks> <maml:para>Retrieves a list of the HCX virtual machines filtered by name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-HCXVM -PowerState PoweredOn</dev:code> <dev:remarks> <maml:para>Retrieves a list of the HCX virtual machines filtered by the power state.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>$myVm = Get-HCXVM -Name "myVmName" Get-HCXVM -Uid $myVm.Uid</dev:code> <dev:remarks> <maml:para>Retrieves a list of the HCX virtual machines by Uid.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <dev:code>$container = Get-HCXContainer -Name "myContainerName" Get-HCXVM -Container $container</dev:code> <dev:remarks> <maml:para>Retrieves a list of the HCX virtual machines filtered by the hcx container.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 7 --------------------------</maml:title> <dev:code>PS C:\> Get-HCXVM -Offset 10 -Limit 100</dev:code> <dev:remarks> <maml:para>Retrieves a list of the HCX Virtual Machines using pagination</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 8 --------------------------</maml:title> <dev:code>PS C:\> Get-HCXVM -Name "MyVM-Name1","MyVM-Name2","MyVM-Name3"</dev:code> <dev:remarks> <maml:para>Retrieves a list of the HCX Virtual Machines filtered by names</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-HCXAppliance</command:name> <command:verb>New</command:verb> <command:noun>HCXAppliance</command:noun> <maml:description> <maml:para>This cmdlet creates an HCX Appliance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates an HCX Appliance which can be of type Interconnect, L2Concentrator, WANOptimization, and Redeploy. You can use the HCXJob output to retrieve job details by running the Get-HCXJob cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HCXAppliance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AdminPassword</maml:name> <maml:Description> <maml:para>Specifies the password by which you can log in to the appliance as an administrator.</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="True (ByValue)" position="named" aliases="none"> <maml:name>Compute</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server compute for the appliance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceCompute</command:parameterValue> <dev:type> <maml:name>HCXApplianceCompute</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>Datastore</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server datastore for the appliance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceDatastore</command:parameterValue> <dev:type> <maml:name>HCXApplianceDatastore</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>DestinationSite</maml:name> <maml:Description> <maml:para>Specifies the destination site where you want to deploy or redeploy the appliance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>Interconnect</maml:name> <maml:Description> <maml:para>Specifies that you want to deploy the Interconnect appliance.</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>NetworkDns</maml:name> <maml:Description> <maml:para>Specifies the DNS IP that you want to assign to the management network.</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>NetworkGateway</maml:name> <maml:Description> <maml:para>Specifies the gateway IP that you want to assign to the management network.</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="NetworkIp/PrefixLength"> <maml:name>NetworkIp</maml:name> <maml:Description> <maml:para>Specifies the network IP and prefix length of the management network provided in the <network-ip>/<prefix-length> format.</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>RootPassword</maml:name> <maml:Description> <maml:para>Specifies the password by which you can log in to the appliance as a root user.</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="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>ManagementNetwork</maml:name> <maml:Description> <maml:para>Specifies the management that you use for migration. This is a source site network.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetwork</command:parameterValue> <dev:type> <maml:name>HCXNetwork</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>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the appliance that you want to deploy.</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>VMotionNetwork</maml:name> <maml:Description> <maml:para>Specifies the vMotion network for the vMotion migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceNetwork</command:parameterValue> <dev:type> <maml:name>HCXApplianceNetwork</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="VMotionNetworkIp/PrefixLength"> <maml:name>VMotionNetworkIp</maml:name> <maml:Description> <maml:para>Specifies the vMotion network IP that you want to assign. This field is necessary when vMotion network is provided in the <network-ip>/<prefix-length> format.</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>StaticRoute</maml:name> <maml:Description> <maml:para>Specifies the static routes for an Interconnect appliance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXStaticRoute[]</command:parameterValue> <dev:type> <maml:name>HCXStaticRoute[]</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>New-HCXAppliance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AdminPassword</maml:name> <maml:Description> <maml:para>Specifies the password by which you can log in to the appliance as an administrator.</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="True (ByValue)" position="named" aliases="none"> <maml:name>Compute</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server compute for the appliance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceCompute</command:parameterValue> <dev:type> <maml:name>HCXApplianceCompute</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>DVS</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server DVS (Distributed Virtual Switch) for the appliance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceDVS</command:parameterValue> <dev:type> <maml:name>HCXApplianceDVS</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>Datastore</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server datastore for the appliance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceDatastore</command:parameterValue> <dev:type> <maml:name>HCXApplianceDatastore</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>DestinationSite</maml:name> <maml:Description> <maml:para>Specifies the destination site where you want to deploy or redeploy the appliance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>L2Concentrator</maml:name> <maml:Description> <maml:para>Specifies that you want to deploy the L2Concentrator appliance.</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>NetworkGateway</maml:name> <maml:Description> <maml:para>Specifies the gateway IP that you want to assign to the management network.</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="NetworkIp/PrefixLength"> <maml:name>NetworkIp</maml:name> <maml:Description> <maml:para>Specifies the network IP and prefix length of the management network provided in the <network-ip>/<prefix-length> format.</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>RootPassword</maml:name> <maml:Description> <maml:para>Specifies the password by which you can log in to the appliance as a root user.</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="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>ApplianceManagementNetwork</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server management network that you want to use for the L2Concentrator appliance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceNetwork</command:parameterValue> <dev:type> <maml:name>HCXApplianceNetwork</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>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the appliance that you want to deploy.</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>New-HCXAppliance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Appliance</maml:name> <maml:Description> <maml:para>Specifies the appliance that you want to redeploy.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXAppliance</command:parameterValue> <dev:type> <maml:name>HCXAppliance</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>DestinationSite</maml:name> <maml:Description> <maml:para>Specifies the destination site where you want to deploy or redeploy the appliance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>Indicates that you want to force and redeploy the appliance.</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>Redeploy</maml:name> <maml:Description> <maml:para>Specifies that you want to redeploy an existing appliance.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>New-HCXAppliance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Appliance</maml:name> <maml:Description> <maml:para>Specifies the appliance that you want to redeploy.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXAppliance</command:parameterValue> <dev:type> <maml:name>HCXAppliance</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>DestinationSite</maml:name> <maml:Description> <maml:para>Specifies the destination site where you want to deploy or redeploy the appliance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>Indicates that you want to force and redeploy the appliance.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Upgrade</maml:name> <maml:Description> <maml:para>Specifies that you want to upgrade an existing appliance.</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-HCXAppliance</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Bandwidth</maml:name> <maml:Description> <maml:para>Specifies the bandwidth that you use in the WANOptimization appliance in MB/s.</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="True (ByValue)" position="named" aliases="none"> <maml:name>DestinationSite</maml:name> <maml:Description> <maml:para>Specifies the destination site where you want to deploy or redeploy the appliance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>WANOptimization</maml:name> <maml:Description> <maml:para>Specifies that you want to deploy the WANOptimization appliance.</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>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the appliance that you want to deploy.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AdminPassword</maml:name> <maml:Description> <maml:para>Specifies the password by which you can log in to the appliance as an administrator.</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="True (ByValue)" position="named" aliases="none"> <maml:name>Appliance</maml:name> <maml:Description> <maml:para>Specifies the appliance that you want to redeploy.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXAppliance</command:parameterValue> <dev:type> <maml:name>HCXAppliance</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>Bandwidth</maml:name> <maml:Description> <maml:para>Specifies the bandwidth that you use in the WANOptimization appliance in MB/s.</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="True (ByValue)" position="named" aliases="none"> <maml:name>Compute</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server compute for the appliance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceCompute</command:parameterValue> <dev:type> <maml:name>HCXApplianceCompute</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>DVS</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server DVS (Distributed Virtual Switch) for the appliance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceDVS</command:parameterValue> <dev:type> <maml:name>HCXApplianceDVS</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>Datastore</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server datastore for the appliance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceDatastore</command:parameterValue> <dev:type> <maml:name>HCXApplianceDatastore</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>DestinationSite</maml:name> <maml:Description> <maml:para>Specifies the destination site where you want to deploy or redeploy the appliance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>Indicates that you want to force and redeploy the appliance.</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>Interconnect</maml:name> <maml:Description> <maml:para>Specifies that you want to deploy the Interconnect appliance.</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>L2Concentrator</maml:name> <maml:Description> <maml:para>Specifies that you want to deploy the L2Concentrator appliance.</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>NetworkDns</maml:name> <maml:Description> <maml:para>Specifies the DNS IP that you want to assign to the management network.</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>NetworkGateway</maml:name> <maml:Description> <maml:para>Specifies the gateway IP that you want to assign to the management network.</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="NetworkIp/PrefixLength"> <maml:name>NetworkIp</maml:name> <maml:Description> <maml:para>Specifies the network IP and prefix length of the management network provided in the <network-ip>/<prefix-length> format.</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>Redeploy</maml:name> <maml:Description> <maml:para>Specifies that you want to redeploy an existing appliance.</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>RootPassword</maml:name> <maml:Description> <maml:para>Specifies the password by which you can log in to the appliance as a root user.</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="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>WANOptimization</maml:name> <maml:Description> <maml:para>Specifies that you want to deploy the WANOptimization appliance.</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>ApplianceManagementNetwork</maml:name> <maml:Description> <maml:para>Specifies the vCenter Server management network that you want to use for the L2Concentrator appliance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceNetwork</command:parameterValue> <dev:type> <maml:name>HCXApplianceNetwork</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>ManagementNetwork</maml:name> <maml:Description> <maml:para>Specifies the management that you use for migration. This is a source site network.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetwork</command:parameterValue> <dev:type> <maml:name>HCXNetwork</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>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the appliance that you want to deploy.</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>VMotionNetwork</maml:name> <maml:Description> <maml:para>Specifies the vMotion network for the vMotion migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceNetwork</command:parameterValue> <dev:type> <maml:name>HCXApplianceNetwork</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="VMotionNetworkIp/PrefixLength"> <maml:name>VMotionNetworkIp</maml:name> <maml:Description> <maml:para>Specifies the vMotion network IP that you want to assign. This field is necessary when vMotion network is provided in the <network-ip>/<prefix-length> format.</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>StaticRoute</maml:name> <maml:Description> <maml:para>Specifies the static routes for an Interconnect appliance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXStaticRoute[]</command:parameterValue> <dev:type> <maml:name>HCXStaticRoute[]</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:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Upgrade</maml:name> <maml:Description> <maml:para>Specifies that you want to upgrade an existing appliance.</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.Hcx.Types.V1.HCXAppliance</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXSite</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXApplianceCompute</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXApplianceDatastore</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXApplianceDVS</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXApplianceNetwork</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXNetwork</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.Hcx.Types.V1.HCXJob</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-HCXAppliance -AdminPassword $myAdminPassword -Compute $myApplianceCompute -DVS $myDvs -Datastore $myApplianceDatastore -DestinationSite $myDestination -L2Concentrator -NetworkGateway 192.168.4.253 -NetworkIp 192.168.4.220/24 -RootPassword $myRootPassword -ApplianceManagementNetwork $myApplianceNetwork -Name $myApplianceName</dev:code> <dev:remarks> <maml:para>Deploys a new L2Concentrator appliance.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>New-HCXAppliance -AdminPassword $myAdminPassword -Compute $myApplianceCompute -Datastore $myApplianceDatastore -DestinationSite $myDestination -Interconnect -NetworkGateway 192.168.4.253 -NetworkIp 192.168.4.201/24 -RootPassword $myRootPassword -ManagementNetwork $myNetwork -Name $myApplianceName</dev:code> <dev:remarks> <maml:para>Deploys a new Interconnect appliance.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$destination = Get-HCXSite -Destination New-HCXAppliance -DestinationSite $destination -WANOptimization -Name "myApplianceName"</dev:code> <dev:remarks> <maml:para>Deploys a new WANOptimization appliance.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>$appliance = Get-HCXAppliance -Name "myAppliance" $destination = Get-HCXSite -Destination New-HCXAppliance -Appliance $appliance -DestinationSite $destination -Redeploy</dev:code> <dev:remarks> <maml:para>Redeploys an existing appliance.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>$appliance = Get-HCXAppliance -Name "myAppliance" $destination = Get-HCXSite -Destination New-HCXAppliance -Upgrade -Appliance $appliance -DestinationSite $destination</dev:code> <dev:remarks> <maml:para>Upgrades an existing appliance.</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-HCXComputeProfile</command:name> <command:verb>New</command:verb> <command:noun>HCXComputeProfile</command:noun> <maml:description> <maml:para>This cmdlet creates an HCX Compute Profile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates an HCX Compute Profile. You can use the HCXInterconnectTask output to retrieve task details by running the Get-HCXJob cmdlet. You can use the Compute Profile to create a Service Mesh.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HCXComputeProfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Datastore</maml:name> <maml:Description> <maml:para>Specifies the storage resource for deploying the HCX Interconnect appliances.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceDatastore[]</command:parameterValue> <dev:type> <maml:name>HCXApplianceDatastore[]</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>DeploymentResource</maml:name> <maml:Description> <maml:para>Specifies the compute resource for deploying the HCX Interconnect appliances.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceCompute[]</command:parameterValue> <dev:type> <maml:name>HCXApplianceCompute[]</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>DistributedSwitch</maml:name> <maml:Description> <maml:para>Specifies the Distributed Virtual Switches that you want to use for the HCX Network Extension services.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceDVS[]</command:parameterValue> <dev:type> <maml:name>HCXApplianceDVS[]</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>ManagementNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies the Network Profile by which you can reach the management interface of the vCenter Server system and the ESXi hosts.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile</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 HCX Compute Profile.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Service</maml:name> <maml:Description> <maml:para>Specifies the HCX services that you want to enable. Licenses must be enabled for the RAV and OSAssistedMigration services to work.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Interconnect</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NetworkExtension</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WANOptimization</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BulkMigration</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DisasterRecovery</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Vmotion</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RAV</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OSAssistedMigration</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">InterconnectServiceType[]</command:parameterValue> <dev:type> <maml:name>InterconnectServiceType[]</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>ServiceCluster</maml:name> <maml:Description> <maml:para>Specifies one or more clusters for which you want to enable the selected HCX services.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceCompute[]</command:parameterValue> <dev:type> <maml:name>HCXApplianceCompute[]</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>UplinkNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies one or more network profiles in such a way that one of the following is true: 1. The Interconnect appliances on the remote site can be reached by the network. 2. The remote site appliances can reach the local Interconnect Appliances by the network. If you have point-to-point networks such as Direct Connect which are not shared across multiple sites, you can skip this, since compute profiles are shared with multiple sites. In such cases, Uplink network profiles can be overridden and specified during the creation of the Interconnect Service Mesh.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile[]</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile[]</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>vMotionNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies the Network Profile for the vMotion network for HCX Appliances.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile</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>vSphereReplicationNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies a Network Profile by which you can reach the vSphere Replication interface of the ESXi hosts.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile</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>GuestNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies the Network Profile with a network that has access to the sentinel workloads.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile</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>Datastore</maml:name> <maml:Description> <maml:para>Specifies the storage resource for deploying the HCX Interconnect appliances.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceDatastore[]</command:parameterValue> <dev:type> <maml:name>HCXApplianceDatastore[]</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>DeploymentResource</maml:name> <maml:Description> <maml:para>Specifies the compute resource for deploying the HCX Interconnect appliances.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceCompute[]</command:parameterValue> <dev:type> <maml:name>HCXApplianceCompute[]</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>DistributedSwitch</maml:name> <maml:Description> <maml:para>Specifies the Distributed Virtual Switches that you want to use for the HCX Network Extension services.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceDVS[]</command:parameterValue> <dev:type> <maml:name>HCXApplianceDVS[]</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>ManagementNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies the Network Profile by which you can reach the management interface of the vCenter Server system and the ESXi hosts.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile</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 HCX Compute Profile.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Service</maml:name> <maml:Description> <maml:para>Specifies the HCX services that you want to enable. Licenses must be enabled for the RAV and OSAssistedMigration services to work.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">InterconnectServiceType[]</command:parameterValue> <dev:type> <maml:name>InterconnectServiceType[]</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>ServiceCluster</maml:name> <maml:Description> <maml:para>Specifies one or more clusters for which you want to enable the selected HCX services.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceCompute[]</command:parameterValue> <dev:type> <maml:name>HCXApplianceCompute[]</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>UplinkNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies one or more network profiles in such a way that one of the following is true: 1. The Interconnect appliances on the remote site can be reached by the network. 2. The remote site appliances can reach the local Interconnect Appliances by the network. If you have point-to-point networks such as Direct Connect which are not shared across multiple sites, you can skip this, since compute profiles are shared with multiple sites. In such cases, Uplink network profiles can be overridden and specified during the creation of the Interconnect Service Mesh.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile[]</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile[]</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>vMotionNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies the Network Profile for the vMotion network for HCX Appliances.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile</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>vSphereReplicationNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies a Network Profile by which you can reach the vSphere Replication interface of the ESXi hosts.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile</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>GuestNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies the Network Profile with a network that has access to the sentinel workloads.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile</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.Hcx.Types.V1.HCXNetworkProfile[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXNetworkProfile</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXApplianceDVS[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXApplianceDatastore[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXApplianceCompute[]</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.Hcx.Types.V1.HCXInterconnectTask</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>$managementNetworkProfile = Get-HCXNetworkProfile -Name "myManagementNetworkProfile" $vmotionNetworkProfile = Get-HCXNetworkProfile -Name "myVmotionNetworkProfile" $cluster = Get-HCXApplianceCompute -ClusterComputeResource $datastore = Get-HCXApplianceDatastore -Compute $cluster -Name "myDatastore" $dvs = Get-HCXInventoryDVS -Compute $cluster -Name "myDVS" New-HCXComputeProfile -ManagementNetworkProfile $managementNetworkProfile -Name "myComputeProfile" -Service BulkMigration,DisasterRecovery,Interconnect,NetworkExtension,Vmotion,WANOptimization -Datastore $datastore -DeploymentResource $cluster -ServiceCluster $cluster -DistributedSwitch $dvs -vMotionNetworkProfile $vmotionNetworkProfile</dev:code> <dev:remarks> <maml:para>Creates an HCX Compute Profile.</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-HCXComputeProfileDVS</command:name> <command:verb>New</command:verb> <command:noun>HCXComputeProfileDVS</command:noun> <maml:description> <maml:para>This cmdlet creates a Distributed Virtual Switch (DVS) configuration for a Compute Profile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates a DVS configuration for a Compute Profile. It configures the DVS with an appliance count for the Compute Profile. You can use the output of this cmdlet to create a Compute Profile.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HCXComputeProfileDVS</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ApplianceLimit</maml:name> <maml:Description> <maml:para>Specifies appliance limit for the DVS.</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="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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>DVS</maml:name> <maml:Description> <maml:para>Specifies the Distributed Virtual Switch.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceDVS</command:parameterValue> <dev:type> <maml:name>HCXApplianceDVS</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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>ApplianceLimit</maml:name> <maml:Description> <maml:para>Specifies appliance limit for the DVS.</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="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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>DVS</maml:name> <maml:Description> <maml:para>Specifies the Distributed Virtual Switch.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceDVS</command:parameterValue> <dev:type> <maml:name>HCXApplianceDVS</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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.Hcx.Types.V1.HCXApplianceDVS</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.Hcx.Types.V1.HCXComputeProfileDVS</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>$myCluster = Get-HCXInventoryCompute -ClusterComputeResource -Name "myCluster" $myDvs = Get-HCXInventoryDVS -Compute $myCluster -Name "myDVS" $computeProfileDVS = New-HCXComputeProfileDVS -DVS $myDvs -ApplianceLimit 3</dev:code> <dev:remarks> <maml:para>Creates a DVS configuration for ? Compute Profile.</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-HCXComputeProfileNetwork</command:name> <command:verb>New</command:verb> <command:noun>HCXComputeProfileNetwork</command:noun> <maml:description> <maml:para>This cmdlet creates a Network Profile configuration for the Compute Profile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates a Network Profile configuration for the Compute Profile. It configures the Network Profile with a static route for the Compute Profile. You can use the output of the cmdlet to create a Compute Profile.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HCXComputeProfileNetwork</maml:name> <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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Network</maml:name> <maml:Description> <maml:para>Specifies the Network Profile.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>StaticRoute</maml:name> <maml:Description> <maml:para>Specifies the static route.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXStaticRoute[]</command:parameterValue> <dev:type> <maml:name>HCXStaticRoute[]</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="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="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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Network</maml:name> <maml:Description> <maml:para>Specifies the Network Profile.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>StaticRoute</maml:name> <maml:Description> <maml:para>Specifies the static route.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXStaticRoute[]</command:parameterValue> <dev:type> <maml:name>HCXStaticRoute[]</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="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.Hcx.Types.V1.HCXNetworkProfile</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.Hcx.Types.V1.HCXNetworkProfile</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>$myNetworkProfile = Get-HCXNetworkProfile -Name "myNetworkProfile" $myStaticRoute = New-HCXStaticRoute -Network 192.168.100.0/24 -Gateway 192.168.0.1 $myManagementNetwork = New-HCXComputeProfileNetwork -Network $myNetworkProfile -StaticRoute $myStaticRoute</dev:code> <dev:remarks> <maml:para>Configures the Network Profile with a static route.</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-HCXMigration</command:name> <command:verb>New</command:verb> <command:noun>HCXMigration</command:noun> <maml:description> <maml:para>This cmdlet creates an HCX migration request.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates an HCX migration request that you can use to test or start a migration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HCXMigration</maml:name> <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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>DestinationSite</maml:name> <maml:Description> <maml:para>Specifies the site to which you want to migrate the virtual machine. If you want to retrieve a destination site, run "Get-HCXSite -Destination".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>DiskProvisionType</maml:name> <maml:Description> <maml:para>Specifies the type of the disk provisioning that you want to use.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">SameAsSource</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Thick</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Thin</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">DiskProvisionType</command:parameterValue> <dev:type> <maml:name>DiskProvisionType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SameAsSource</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Folder</maml:name> <maml:Description> <maml:para>Specifies the folder on the destination site. If you want to retrieve the folder, run Get-HCXContainer -Type Folder -Site $DestinationSite -Name "Folder name".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXFolderContainer</command:parameterValue> <dev:type> <maml:name>HCXFolderContainer</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>ForcePowerOffVm</maml:name> <maml:Description> <maml:para>Specifies whether you want the virtual machine to be in a powered off state after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>MigrationType</maml:name> <maml:Description> <maml:para>Specifies the type of migration that you want to perform.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">vMotion</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Bulk</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Cold</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RAV</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OsAssistedMigration</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">MigrationType</command:parameterValue> <dev:type> <maml:name>MigrationType</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>RemoveISOs</maml:name> <maml:Description> <maml:para>Specifies whether you want to remove the ISO files after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RemoveSnapshots</maml:name> <maml:Description> <maml:para>Specifies whether you want to remove the snapshots after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RetainMac</maml:name> <maml:Description> <maml:para>Specifies whether you want to retain the MAC address after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>ReplicateSecurityTags</maml:name> <maml:Description> <maml:para>Specifies whether you want to replicate the security tags after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>MigrateCustomAttributes</maml:name> <maml:Description> <maml:para>Specifies whether you want to migrate the custom attributes of the virtual machine undergoing migration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>vcpus</maml:name> <maml:Description> <maml:para>Specifies that you should use OSAM to override the vCPU setting of the migrated virtual machine.</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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>memory</maml:name> <maml:Description> <maml:para>Specifies that you should use OSAM to override the memory setting of the migrated virtual machine. The unit is MB.</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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScheduleEndTime</maml:name> <maml:Description> <maml:para>Specifies the end time of the schedule window in case of bulk migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</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>ScheduleStartTime</maml:name> <maml:Description> <maml:para>Specifies the start time of the schedule window in case of bulk migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>SourceSite</maml:name> <maml:Description> <maml:para>Specifies the site from which you want to migrate the virtual machine. If you want to retrieve a source site, use the Get-HCXSite cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>TargetComputeContainer</maml:name> <maml:Description> <maml:para>Specifies the container on the destination site. If you want to retrieve the container, run Get-HCXContainer -Type ComputeContainer -Site $DestinationSite -Name "Container name".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXComputeContainer</command:parameterValue> <dev:type> <maml:name>HCXComputeContainer</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>TargetDatastore</maml:name> <maml:Description> <maml:para>Specifies the datastore on the destination site. If you want to retrieve the datastore, run Get-HCXDatastore -Site $DestinationSite -Name "datastore name".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXDatastore</command:parameterValue> <dev:type> <maml:name>HCXDatastore</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>UpgradeHardware</maml:name> <maml:Description> <maml:para>Specifies whether you want to upgrade the hardware after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>UpgradeVMTools</maml:name> <maml:Description> <maml:para>Specifies whether you want to upgrade the VM tools after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>VM</maml:name> <maml:Description> <maml:para>Specifies the virtual machine on the source site. If you want to retrieve the virtual machine, use Get-HCXVM -Site $SourceSite -Name "vm name".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXVM</command:parameterValue> <dev:type> <maml:name>HCXVM</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="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:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NetworkMapping</maml:name> <maml:Description> <maml:para>Specifies the source and destination networks you want to use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkMapping[]</command:parameterValue> <dev:type> <maml:name>HCXNetworkMapping[]</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>TargetStorageProfile</maml:name> <maml:Description> <maml:para>Specifies the storage profile at the destination site that you want to use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXStorageProfile</command:parameterValue> <dev:type> <maml:name>HCXStorageProfile</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>EnableSeedCheckpoint</maml:name> <maml:Description> <maml:para>The Seed Checkpoint option captures migration progress when a failure is encountered. On a subsequent attempt, the migration will resume based on Seed Checkpoint data when it's available. Without Seed Checkpoint, migration progress is discarded when a failure is encountered. This option is available only for RAV and Bulk migration profiles.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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="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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>DestinationSite</maml:name> <maml:Description> <maml:para>Specifies the site to which you want to migrate the virtual machine. If you want to retrieve a destination site, run "Get-HCXSite -Destination".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>DiskProvisionType</maml:name> <maml:Description> <maml:para>Specifies the type of the disk provisioning that you want to use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DiskProvisionType</command:parameterValue> <dev:type> <maml:name>DiskProvisionType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>SameAsSource</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Folder</maml:name> <maml:Description> <maml:para>Specifies the folder on the destination site. If you want to retrieve the folder, run Get-HCXContainer -Type Folder -Site $DestinationSite -Name "Folder name".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXFolderContainer</command:parameterValue> <dev:type> <maml:name>HCXFolderContainer</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>ForcePowerOffVm</maml:name> <maml:Description> <maml:para>Specifies whether you want the virtual machine to be in a powered off state after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>MigrationType</maml:name> <maml:Description> <maml:para>Specifies the type of migration that you want to perform.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">MigrationType</command:parameterValue> <dev:type> <maml:name>MigrationType</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>RemoveISOs</maml:name> <maml:Description> <maml:para>Specifies whether you want to remove the ISO files after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RemoveSnapshots</maml:name> <maml:Description> <maml:para>Specifies whether you want to remove the snapshots after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RetainMac</maml:name> <maml:Description> <maml:para>Specifies whether you want to retain the MAC address after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>ReplicateSecurityTags</maml:name> <maml:Description> <maml:para>Specifies whether you want to replicate the security tags after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>MigrateCustomAttributes</maml:name> <maml:Description> <maml:para>Specifies whether you want to migrate the custom attributes of the virtual machine undergoing migration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>vcpus</maml:name> <maml:Description> <maml:para>Specifies that you should use OSAM to override the vCPU setting of the migrated virtual machine.</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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>memory</maml:name> <maml:Description> <maml:para>Specifies that you should use OSAM to override the memory setting of the migrated virtual machine. The unit is MB.</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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScheduleEndTime</maml:name> <maml:Description> <maml:para>Specifies the end time of the schedule window in case of bulk migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</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>ScheduleStartTime</maml:name> <maml:Description> <maml:para>Specifies the start time of the schedule window in case of bulk migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>SourceSite</maml:name> <maml:Description> <maml:para>Specifies the site from which you want to migrate the virtual machine. If you want to retrieve a source site, use the Get-HCXSite cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>TargetComputeContainer</maml:name> <maml:Description> <maml:para>Specifies the container on the destination site. If you want to retrieve the container, run Get-HCXContainer -Type ComputeContainer -Site $DestinationSite -Name "Container name".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXComputeContainer</command:parameterValue> <dev:type> <maml:name>HCXComputeContainer</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>TargetDatastore</maml:name> <maml:Description> <maml:para>Specifies the datastore on the destination site. If you want to retrieve the datastore, run Get-HCXDatastore -Site $DestinationSite -Name "datastore name".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXDatastore</command:parameterValue> <dev:type> <maml:name>HCXDatastore</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>UpgradeHardware</maml:name> <maml:Description> <maml:para>Specifies whether you want to upgrade the hardware after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>UpgradeVMTools</maml:name> <maml:Description> <maml:para>Specifies whether you want to upgrade the VM tools after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>VM</maml:name> <maml:Description> <maml:para>Specifies the virtual machine on the source site. If you want to retrieve the virtual machine, use Get-HCXVM -Site $SourceSite -Name "vm name".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXVM</command:parameterValue> <dev:type> <maml:name>HCXVM</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="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:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NetworkMapping</maml:name> <maml:Description> <maml:para>Specifies the source and destination networks you want to use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkMapping[]</command:parameterValue> <dev:type> <maml:name>HCXNetworkMapping[]</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>TargetStorageProfile</maml:name> <maml:Description> <maml:para>Specifies the storage profile at the destination site that you want to use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXStorageProfile</command:parameterValue> <dev:type> <maml:name>HCXStorageProfile</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>EnableSeedCheckpoint</maml:name> <maml:Description> <maml:para>The Seed Checkpoint option captures migration progress when a failure is encountered. On a subsequent attempt, the migration will resume based on Seed Checkpoint data when it's available. Without Seed Checkpoint, migration progress is discarded when a failure is encountered. This option is available only for RAV and Bulk migration profiles.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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.Hcx.Types.V1.HCXNetwork[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXSite</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXDatastore</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXVM</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXContainer</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXStorageProfile</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.Hcx.Types.V1.HCXMigration</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-HCXMigration -SourceSite $source -DestinationSite $destination -NetworkMapping $myNetworkMapping -TargetDatastore $datastore -TargetComputeContainer $container -VM $vm -MigrationType vMotion</dev:code> <dev:remarks> <maml:para>Creates a vMotion migration request object.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>New-HCXMigration -SourceSite $source -DestinationSite $dest -VM $vm -NetworkMapping $myNetworkMapping -TargetDatastore $Storage -TargetComputeContainer $Container -ScheduleStartTime '01/02/2019 7:50:40 PM' -ScheduleEndTime '01/02/2019 8:50:40 PM' -MigrationType Bulk</dev:code> <dev:remarks> <maml:para>Creates a bulk migration request object.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>New-HCXMigration -SourceSite $source -DestinationSite $dest -VM $vm -NetworkMapping $myNetworkMapping -TargetDatastore $Storage -TargetComputeContainer $Container -MigrationType Cold</dev:code> <dev:remarks> <maml:para>Creates a cold migration request object.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>$myDestination = Get-HCXSite -Destination -Name "myDestinationName" $myStorageProfile = Get-HCXStorageProfile -Site $myDestination -Name "myStorageProfileName" New-HCXMigration -SourceSite $source -DestinationSite $destination -NetworkMapping $myNetworkMapping -TargetDatastore $datastore -TargetComputeContainer $container -VM $vm -MigrationType vMotion -StorageProfile $myStorageProfile</dev:code> <dev:remarks> <maml:para>Creates a vMotion migration request object with a storage profile.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>New-HCXMigration -SourceSite $source -DestinationSite $destination -NetworkMapping $myNetworkMapping -TargetDatastore $datastore -TargetComputeContainer $container -VM $vm -MigrationType RAV</dev:code> <dev:remarks> <maml:para>Creates a RAV migration request object.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <dev:code>New-HCXMigration -SourceSite $source -DestinationSite $destination -NetworkMapping $myNetworkMapping -TargetDatastore $datastore -TargetComputeContainer $container -VM $vm -MigrationType OsAssistedMigration</dev:code> <dev:remarks> <maml:para>Creates an OSAssisted migration request object.</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-HCXMobilityGroup</command:name> <command:verb>New</command:verb> <command:noun>HCXMobilityGroup</command:noun> <maml:description> <maml:para>This cmdlet creates an HCX mobility group request.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates an HCX mobility group request.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HCXMobilityGroup</maml:name> <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="none"> <maml:name>GroupConfiguration</maml:name> <maml:Description> <maml:para>Specifies the common set of configurations that you want to apply to all virtual machines in a group while doing the migration. If not specified explicitly at Virtual Machine Configuration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMobilityGroupConfiguration</command:parameterValue> <dev:type> <maml:name>HCXMobilityGroupConfiguration</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>Migration</maml:name> <maml:Description> <maml:para>Specifies the array of a virtual machine and its configurations that are part of the HCX mobility group.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMobilityGroupMigration[]</command:parameterValue> <dev:type> <maml:name>HCXMobilityGroupMigration[]</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 an HCX mobility group.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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="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="none"> <maml:name>GroupConfiguration</maml:name> <maml:Description> <maml:para>Specifies the common set of configurations that you want to apply to all virtual machines in a group while doing the migration. If not specified explicitly at Virtual Machine Configuration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMobilityGroupConfiguration</command:parameterValue> <dev:type> <maml:name>HCXMobilityGroupConfiguration</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>Migration</maml:name> <maml:Description> <maml:para>Specifies the array of a virtual machine and its configurations that are part of the HCX mobility group.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMobilityGroupMigration[]</command:parameterValue> <dev:type> <maml:name>HCXMobilityGroupMigration[]</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 an HCX mobility group.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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.Hcx.Types.V1.HCXMobilityGroup</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-HCXMobilityGroup -Name "MyFirstMobilityGroup" -GroupConfiguration $mobilityGroupConfigiuration -Migration $migrations</dev:code> <dev:remarks> <maml:para>Creates a new mobility group request object with default mobility group configurations and a list of HCX migration objects.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>New-HCXMobilityGroup -Name "MyFirstMobilityGroup" -Migration $migrations</dev:code> <dev:remarks> <maml:para>Creates a new mobility group request object with an out-default group configuration.</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-HCXMobilityGroupConfiguration</command:name> <command:verb>New</command:verb> <command:noun>HCXMobilityGroupConfiguration</command:noun> <maml:description> <maml:para>This cmdlet creates an HCX mobility group configuration request.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates an HCX Mobility Group Configuration request.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HCXMobilityGroupConfiguration</maml:name> <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="True (ByValue)" position="named" aliases="none"> <maml:name>DestinationSite</maml:name> <maml:Description> <maml:para>Specifies the site to which you want to migrate the virtual machine. If you want to retrieve a destination site, run "Get-HCXSite -Destination".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>DiskProvisionType</maml:name> <maml:Description> <maml:para>Specifies the type of the disk provisioning that you want to use.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">SameAsSource</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Thick</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Thin</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">DiskProvisionType</command:parameterValue> <dev:type> <maml:name>DiskProvisionType</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>ForcePowerOffVm</maml:name> <maml:Description> <maml:para>Specifies whether you want the virtual machine to be in a powered off state after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>MigrationType</maml:name> <maml:Description> <maml:para>Specifies the type of migration that you want to perform.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">vMotion</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Bulk</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Cold</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RAV</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OsAssistedMigration</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">MigrationType</command:parameterValue> <dev:type> <maml:name>MigrationType</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>NetworkMapping</maml:name> <maml:Description> <maml:para>Specifies the source and destination networks you want to use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkMapping[]</command:parameterValue> <dev:type> <maml:name>HCXNetworkMapping[]</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>RemoveISOs</maml:name> <maml:Description> <maml:para>Specifies whether you want to remove the ISO files after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>RemoveSnapshots</maml:name> <maml:Description> <maml:para>Specifies whether you want to remove the snapshots after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>RetainMac</maml:name> <maml:Description> <maml:para>Specifies whether you want to retain the MAC address after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>ReplicateSecurityTags</maml:name> <maml:Description> <maml:para>Specifies whether you want to replicate the security tags after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>MigrateCustomAttributes</maml:name> <maml:Description> <maml:para>Specifies whether you want to migrate the custom attributes of the virtual machine undergoing migration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>ScheduleEndTime</maml:name> <maml:Description> <maml:para>Specifies the end time of the schedule window in case of bulk migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</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>ScheduleStartTime</maml:name> <maml:Description> <maml:para>Specifies the start time of the schedule window in case of bulk migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>SourceSite</maml:name> <maml:Description> <maml:para>Specifies the site from which you want to migrate the virtual machine. If you want to retrieve a source site, use the Get-HCXSite cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>TargetComputeContainer</maml:name> <maml:Description> <maml:para>Specifies the container on the destination site. If you want to retrieve the container, run Get-HCXContainer -Type ComputeContainer -Site $DestinationSite -Name "Container name".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXComputeContainer</command:parameterValue> <dev:type> <maml:name>HCXComputeContainer</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>TargetComputeFolder</maml:name> <maml:Description> <maml:para>Specifies the folder on the destination site. If you want to retrieve the folder, run Get-HCXContainer -Type Folder -Site $DestinationSite -Name "Folder name".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXFolderContainer</command:parameterValue> <dev:type> <maml:name>HCXFolderContainer</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>TargetDatastore</maml:name> <maml:Description> <maml:para>Specifies the datastore on the destination site. If you want to retrieve the datastore, run Get-HCXDatastore -Site $DestinationSite -Name "datastore name".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXDatastore</command:parameterValue> <dev:type> <maml:name>HCXDatastore</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>TargetStorageProfile</maml:name> <maml:Description> <maml:para>Specifies the storage profile at the destination site that you want to use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXStorageProfile</command:parameterValue> <dev:type> <maml:name>HCXStorageProfile</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>UpgradeHardware</maml:name> <maml:Description> <maml:para>Specifies whether you want to upgrade the hardware after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>UpgradeVMTools</maml:name> <maml:Description> <maml:para>Specifies whether you want to upgrade the VM tools after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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="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="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="True (ByValue)" position="named" aliases="none"> <maml:name>DestinationSite</maml:name> <maml:Description> <maml:para>Specifies the site to which you want to migrate the virtual machine. If you want to retrieve a destination site, run "Get-HCXSite -Destination".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>DiskProvisionType</maml:name> <maml:Description> <maml:para>Specifies the type of the disk provisioning that you want to use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DiskProvisionType</command:parameterValue> <dev:type> <maml:name>DiskProvisionType</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>ForcePowerOffVm</maml:name> <maml:Description> <maml:para>Specifies whether you want the virtual machine to be in a powered off state after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>MigrationType</maml:name> <maml:Description> <maml:para>Specifies the type of migration that you want to perform.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">MigrationType</command:parameterValue> <dev:type> <maml:name>MigrationType</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>NetworkMapping</maml:name> <maml:Description> <maml:para>Specifies the source and destination networks you want to use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkMapping[]</command:parameterValue> <dev:type> <maml:name>HCXNetworkMapping[]</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>RemoveISOs</maml:name> <maml:Description> <maml:para>Specifies whether you want to remove the ISO files after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>RemoveSnapshots</maml:name> <maml:Description> <maml:para>Specifies whether you want to remove the snapshots after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>RetainMac</maml:name> <maml:Description> <maml:para>Specifies whether you want to retain the MAC address after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>ReplicateSecurityTags</maml:name> <maml:Description> <maml:para>Specifies whether you want to replicate the security tags after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>MigrateCustomAttributes</maml:name> <maml:Description> <maml:para>Specifies whether you want to migrate the custom attributes of the virtual machine undergoing migration</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>ScheduleEndTime</maml:name> <maml:Description> <maml:para>Specifies the end time of the schedule window in case of bulk migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</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>ScheduleStartTime</maml:name> <maml:Description> <maml:para>Specifies the start time of the schedule window in case of bulk migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>SourceSite</maml:name> <maml:Description> <maml:para>Specifies the site from which you want to migrate the virtual machine. If you want to retrieve a source site, use the Get-HCXSite cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>TargetComputeContainer</maml:name> <maml:Description> <maml:para>Specifies the container on the destination site. If you want to retrieve the container, run Get-HCXContainer -Type ComputeContainer -Site $DestinationSite -Name "Container name".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXComputeContainer</command:parameterValue> <dev:type> <maml:name>HCXComputeContainer</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>TargetComputeFolder</maml:name> <maml:Description> <maml:para>Specifies the folder on the destination site. If you want to retrieve the folder, run Get-HCXContainer -Type Folder -Site $DestinationSite -Name "Folder name".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXFolderContainer</command:parameterValue> <dev:type> <maml:name>HCXFolderContainer</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>TargetDatastore</maml:name> <maml:Description> <maml:para>Specifies the datastore on the destination site. If you want to retrieve the datastore, run Get-HCXDatastore -Site $DestinationSite -Name "datastore name".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXDatastore</command:parameterValue> <dev:type> <maml:name>HCXDatastore</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>TargetStorageProfile</maml:name> <maml:Description> <maml:para>Specifies the storage profile at the destination site that you want to use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXStorageProfile</command:parameterValue> <dev:type> <maml:name>HCXStorageProfile</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>UpgradeHardware</maml:name> <maml:Description> <maml:para>Specifies whether you want to upgrade the hardware after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>UpgradeVMTools</maml:name> <maml:Description> <maml:para>Specifies whether you want to upgrade the VM tools after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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="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.Hcx.Types.V1.HCXSite</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXDatastore</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXStorageProfile</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXComputeContainer</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXFolderContainer</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.Hcx.Types.V1.HCXMobilityGroupConfiguration</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-HCXMobilityGroupConfiguration -SourceSite $source-DestinationSite $destination-TargetComputeContainer $targetCompute-TargetDatastore $destinationDataStore-NetworkMapping $networkMapping</dev:code> <dev:remarks> <maml:para>Creates ? mobility group configuration request object.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>New-HCXMobilityGroupConfiguration -SourceSite $source-DestinationSite $destination-TargetComputeContainer -ScheduleStartTime '01/02/2020 7:50:40 PM' -ScheduleEndTime '01/02/2020 8:50:40 PM' -MigrationType Bulk</dev:code> <dev:remarks> <maml:para>Creates ? mobility group configuration request object by setting default migration type to Bulk with ? schedule start and end time.</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-HCXNetworkExtension</command:name> <command:verb>New</command:verb> <command:noun>HCXNetworkExtension</command:noun> <maml:description> <maml:para>This cmdlet creates an HCX Network Extension (L2 extension).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates an HCX Network Extension (L2 extension) and you can perform a stretch operation on the provided network. You can retrieve job details by running the Get-HCXJob cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HCXNetworkExtension</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Appliance</maml:name> <maml:Description> <maml:para>Specifies the L2Concentrator Appliance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXAppliance</command:parameterValue> <dev:type> <maml:name>HCXAppliance</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>DestinationGateway</maml:name> <maml:Description> <maml:para>Specifies the gateway at the destination site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXGateway</command:parameterValue> <dev:type> <maml:name>HCXGateway</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>DestinationSite</maml:name> <maml:Description> <maml:para>Specifies the destination site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>EgressOptimization</maml:name> <maml:Description> <maml:para>Specifies the option which enables egress optimization.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>GatewayIp</maml:name> <maml:Description> <maml:para>Specifies the gateway IP address that can be provided in the format <gateway-IP>.</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>Netmask</maml:name> <maml:Description> <maml:para>Specifies the netmask.</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="True (ByValue)" position="named" aliases="none"> <maml:name>Network</maml:name> <maml:Description> <maml:para>Specifies the network that you want to extend.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetwork</command:parameterValue> <dev:type> <maml:name>HCXNetwork</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>ProximityRouting</maml:name> <maml:Description> <maml:para>Specifies the option that enables proximity routing.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>SourceSite</maml:name> <maml:Description> <maml:para>Specifies the source site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>Appliance</maml:name> <maml:Description> <maml:para>Specifies the L2Concentrator Appliance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXAppliance</command:parameterValue> <dev:type> <maml:name>HCXAppliance</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>DestinationGateway</maml:name> <maml:Description> <maml:para>Specifies the gateway at the destination site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXGateway</command:parameterValue> <dev:type> <maml:name>HCXGateway</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>DestinationSite</maml:name> <maml:Description> <maml:para>Specifies the destination site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>EgressOptimization</maml:name> <maml:Description> <maml:para>Specifies the option which enables egress optimization.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>GatewayIp</maml:name> <maml:Description> <maml:para>Specifies the gateway IP address that can be provided in the format <gateway-IP>.</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>Netmask</maml:name> <maml:Description> <maml:para>Specifies the netmask.</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="True (ByValue)" position="named" aliases="none"> <maml:name>Network</maml:name> <maml:Description> <maml:para>Specifies the network that you want to extend.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetwork</command:parameterValue> <dev:type> <maml:name>HCXNetwork</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>ProximityRouting</maml:name> <maml:Description> <maml:para>Specifies the option that enables proximity routing.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>SourceSite</maml:name> <maml:Description> <maml:para>Specifies the source site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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.Hcx.Types.V1.HCXSite</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXGateway</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXNetwork</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXAppliance</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.Hcx.Types.V1.HCXJob</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>$myL2CAppliance = Get-HCXAppliance -Type L2Concentrator -Name "myAppliance" New-HCXNetworkExtension -Appliance $myL2CAppliance -DestinationGateway $myGateway -DestinationSite $myDestination -GatewayIp 192.167.5.21 -Netmask 255.255.192.0 -Network $myNetwork -SourceSite $mySource</dev:code> <dev:remarks> <maml:para>Creates a network extension.</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-HCXNetworkMapping</command:name> <command:verb>New</command:verb> <command:noun>HCXNetworkMapping</command:noun> <maml:description> <maml:para>This cmdlet creates an HCX network mapping request.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates an HCX network mapping request. The cmdlet creates a list of network mapping from a source to destination site that you want to use for the new migration and replication requests.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HCXNetworkMapping</maml:name> <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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DestinationNetwork</maml:name> <maml:Description> <maml:para>Specifies a network at the destination site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetwork</command:parameterValue> <dev:type> <maml:name>HCXNetwork</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>SourceNetwork</maml:name> <maml:Description> <maml:para>Specifies a network at the source site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetwork</command:parameterValue> <dev:type> <maml:name>HCXNetwork</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="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="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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DestinationNetwork</maml:name> <maml:Description> <maml:para>Specifies a network at the destination site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetwork</command:parameterValue> <dev:type> <maml:name>HCXNetwork</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>SourceNetwork</maml:name> <maml:Description> <maml:para>Specifies a network at the source site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetwork</command:parameterValue> <dev:type> <maml:name>HCXNetwork</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="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.Hcx.Types.V1.HCXNetwork</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.Hcx.Types.V1.HCXNetworkMapping</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>$destinationSite = Get-HCXSite -Destination $mySourceNetwork = Get-HCXNetwork -Name 'sourceNetworkName' $myDestinationNetwork = Get-HCXNetwork -Site $destinationSite -Name 'destinationNetworkName' New-HCXNetworkMapping -SourceNetwork $mySourceNetwork -DestinationNetwork $myDestinationNetwork</dev:code> <dev:remarks> <maml:para>Creates a network mapping.</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-HCXNetworkProfile</command:name> <command:verb>New</command:verb> <command:noun>HCXNetworkProfile</command:noun> <maml:description> <maml:para>This cmdlet creates an HCX Network Profile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates an HCX Network Profile. You can use the HCXInterconnectTask output to retrieve task details by running the Get-HCXJob cmdlet. You can use the Network Profile to create the Compute Profile.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HCXNetworkProfile</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowEditingIPPool</maml:name> <maml:Description> <maml:para>Specifies if you can edit the IP Pool by using the Enterprise Administrator login.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>DNSSuffix</maml:name> <maml:Description> <maml:para>Specifies the DNS suffix for the IP Pool.</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>GatewayAddress</maml:name> <maml:Description> <maml:para>Specifies the Gateway IP address for the IP Pool.</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>IPPool</maml:name> <maml:Description> <maml:para>Specifies the IP ranges. The following formats are valid: 1. IP address (ex: 10.2.3.4) 2. IP range (ex: 10.2.3.4-10.2.3.5)</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>MTU</maml:name> <maml:Description> <maml:para>Specifies the maximum transmission unit (MTU).</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>1500</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 HCX Network Profile.</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="True (ByValue)" position="named" aliases="none"> <maml:name>Network</maml:name> <maml:Description> <maml:para>Specifies the Network backing.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkBacking</command:parameterValue> <dev:type> <maml:name>HCXNetworkBacking</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>PrefixLength</maml:name> <maml:Description> <maml:para>Specifies the prefix length for the Network Profile.</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>PrimaryDNS</maml:name> <maml:Description> <maml:para>Specifies the primary DNS for the Network Profile.</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>SecondaryDNS</maml:name> <maml:Description> <maml:para>Specifies the secondary DNS for the Network Profile.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>AllowEditingIPPool</maml:name> <maml:Description> <maml:para>Specifies if you can edit the IP Pool by using the Enterprise Administrator login.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>DNSSuffix</maml:name> <maml:Description> <maml:para>Specifies the DNS suffix for the IP Pool.</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>GatewayAddress</maml:name> <maml:Description> <maml:para>Specifies the Gateway IP address for the IP Pool.</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>IPPool</maml:name> <maml:Description> <maml:para>Specifies the IP ranges. The following formats are valid: 1. IP address (ex: 10.2.3.4) 2. IP range (ex: 10.2.3.4-10.2.3.5)</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>MTU</maml:name> <maml:Description> <maml:para>Specifies the maximum transmission unit (MTU).</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>1500</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 HCX Network Profile.</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="True (ByValue)" position="named" aliases="none"> <maml:name>Network</maml:name> <maml:Description> <maml:para>Specifies the Network backing.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkBacking</command:parameterValue> <dev:type> <maml:name>HCXNetworkBacking</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>PrefixLength</maml:name> <maml:Description> <maml:para>Specifies the prefix length for the Network Profile.</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>PrimaryDNS</maml:name> <maml:Description> <maml:para>Specifies the primary DNS for the Network Profile.</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>SecondaryDNS</maml:name> <maml:Description> <maml:para>Specifies the secondary DNS for the Network Profile.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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.Hcx.Types.V1.HCXNetworkBacking</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.Hcx.Types.V1.HCXNetworkProfileJob</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>$myNetworkBacking = Get-HCXNetworkBacking -Name "myNetworkBacking" New-HCXNetworkProfile -PrimaryDNS 10.2.3.4 -SecondaryDNS 10.2.3.5 -DNSSuffix "eng.vmware.com" -Name "myNetworkProfile" -GatewayAddress 10.2.3.253 -IPPool 10.2.3.7-10.2.3.10,10.2.3.15 -Network $myNetworkBacking -PrefixLength 24</dev:code> <dev:remarks> <maml:para>Creates a new HCX Network Profile.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$myNetworkBacking = Get-HCXNetworkBacking -Name "myNetworkBacking" New-HCXNetworkProfile -Name "myNetworkProfile" -Network $myNetworkBacking</dev:code> <dev:remarks> <maml:para>Creates a new VMware HCX Network Profile without specifying IP Pool.</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-HCXReplication</command:name> <command:verb>New</command:verb> <command:noun>HCXReplication</command:noun> <maml:description> <maml:para>This cmdlet creates an HCX replication request.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates an HCX replication request. You can use the output of the cmdlet in the Start-HCXReplication cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HCXReplication</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DestinationSeedVm</maml:name> <maml:Description> <maml:para>Specifies the virtual machine on the destination site that you want to use as a seed for replicating.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXVM</command:parameterValue> <dev:type> <maml:name>HCXVM</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>DestinationSite</maml:name> <maml:Description> <maml:para>Specifies the site to which you want to replicate the virtual machine.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>NetworkCompressionEnabled</maml:name> <maml:Description> <maml:para>Specifies the network compression enabled option.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>QuiesceGuestEnabled</maml:name> <maml:Description> <maml:para>Specifies the quiesce guest enabled option.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>RPOIntervalMinutes</maml:name> <maml:Description> <maml:para>Specifies the time interval in minutes for which the data should sync from source to destination.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>SnapshotIntervalMinutes</maml:name> <maml:Description> <maml:para>Specifies the time interval for which you can take the specified number of snapshots.</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>SnapshotNumber</maml:name> <maml:Description> <maml:para>Specifies the number of snapshots that you want to take.</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="True (ByValue)" position="named" aliases="none"> <maml:name>SourceSite</maml:name> <maml:Description> <maml:para>Specifies the site at which the virtual machine that you want to replicate resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>VM</maml:name> <maml:Description> <maml:para>Specifies the virtual machine at the source site that you want to protect.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXVM</command:parameterValue> <dev:type> <maml:name>HCXVM</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="True (ByValue)" position="named" aliases="none"> <maml:name>NetworkMapping</maml:name> <maml:Description> <maml:para>Specifies the list of network mapping from a source to destination site that you want to use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkMapping[]</command:parameterValue> <dev:type> <maml:name>HCXNetworkMapping[]</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="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-HCXReplication</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>DestinationSite</maml:name> <maml:Description> <maml:para>Specifies the site to which you want to replicate the virtual machine.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>NetworkCompressionEnabled</maml:name> <maml:Description> <maml:para>Specifies the network compression enabled option.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>QuiesceGuestEnabled</maml:name> <maml:Description> <maml:para>Specifies the quiesce guest enabled option.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>RPOIntervalMinutes</maml:name> <maml:Description> <maml:para>Specifies the time interval in minutes for which the data should sync from source to destination.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>SnapshotIntervalMinutes</maml:name> <maml:Description> <maml:para>Specifies the time interval for which you can take the specified number of snapshots.</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>SnapshotNumber</maml:name> <maml:Description> <maml:para>Specifies the number of snapshots that you want to take.</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="True (ByValue)" position="named" aliases="none"> <maml:name>SourceSite</maml:name> <maml:Description> <maml:para>Specifies the site at which the virtual machine that you want to replicate resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>TargetComputeContainer</maml:name> <maml:Description> <maml:para>Specifies the target compute container.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXComputeContainer</command:parameterValue> <dev:type> <maml:name>HCXComputeContainer</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>TargetDatastore</maml:name> <maml:Description> <maml:para>Specifies the target datastore.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXDatastore</command:parameterValue> <dev:type> <maml:name>HCXDatastore</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>VM</maml:name> <maml:Description> <maml:para>Specifies the virtual machine at the source site that you want to protect.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXVM</command:parameterValue> <dev:type> <maml:name>HCXVM</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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>NetworkMapping</maml:name> <maml:Description> <maml:para>Specifies the list of network mapping from a source to destination site that you want to use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkMapping[]</command:parameterValue> <dev:type> <maml:name>HCXNetworkMapping[]</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="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:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TargetDataCenter</maml:name> <maml:Description> <maml:para>Specifies the data center at the destination site that you want to use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXFolderContainer</command:parameterValue> <dev:type> <maml:name>HCXFolderContainer</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>TargetStorageProfile</maml:name> <maml:Description> <maml:para>Specifies the storage profile at the destination site that you want to use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXStorageProfile</command:parameterValue> <dev:type> <maml:name>HCXStorageProfile</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>DestinationSeedVm</maml:name> <maml:Description> <maml:para>Specifies the virtual machine on the destination site that you want to use as a seed for replicating.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXVM</command:parameterValue> <dev:type> <maml:name>HCXVM</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>DestinationSite</maml:name> <maml:Description> <maml:para>Specifies the site to which you want to replicate the virtual machine.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>NetworkCompressionEnabled</maml:name> <maml:Description> <maml:para>Specifies the network compression enabled option.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>QuiesceGuestEnabled</maml:name> <maml:Description> <maml:para>Specifies the quiesce guest enabled option.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>RPOIntervalMinutes</maml:name> <maml:Description> <maml:para>Specifies the time interval in minutes for which the data should sync from source to destination.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>SnapshotIntervalMinutes</maml:name> <maml:Description> <maml:para>Specifies the time interval for which you can take the specified number of snapshots.</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>SnapshotNumber</maml:name> <maml:Description> <maml:para>Specifies the number of snapshots that you want to take.</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="True (ByValue)" position="named" aliases="none"> <maml:name>SourceSite</maml:name> <maml:Description> <maml:para>Specifies the site at which the virtual machine that you want to replicate resides.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>TargetComputeContainer</maml:name> <maml:Description> <maml:para>Specifies the target compute container.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXComputeContainer</command:parameterValue> <dev:type> <maml:name>HCXComputeContainer</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>TargetDatastore</maml:name> <maml:Description> <maml:para>Specifies the target datastore.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXDatastore</command:parameterValue> <dev:type> <maml:name>HCXDatastore</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>VM</maml:name> <maml:Description> <maml:para>Specifies the virtual machine at the source site that you want to protect.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXVM</command:parameterValue> <dev:type> <maml:name>HCXVM</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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>NetworkMapping</maml:name> <maml:Description> <maml:para>Specifies the list of network mapping from a source to destination site that you want to use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkMapping[]</command:parameterValue> <dev:type> <maml:name>HCXNetworkMapping[]</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="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:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TargetDataCenter</maml:name> <maml:Description> <maml:para>Specifies the data center at the destination site that you want to use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXFolderContainer</command:parameterValue> <dev:type> <maml:name>HCXFolderContainer</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>TargetStorageProfile</maml:name> <maml:Description> <maml:para>Specifies the storage profile at the destination site that you want to use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXStorageProfile</command:parameterValue> <dev:type> <maml:name>HCXStorageProfile</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.Hcx.Types.V1.HCXDatastore</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXStorageProfile</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXVM</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXSite</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXComputeContainer</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXFolderContainer</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXNetwork[]</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.Hcx.Types.V1.HCXReplication</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-HCXReplication -DestinationSite $myDestination -NetworkMapping $myNetworkMapping -RPOIntervalMinutes 30 -SnapshotIntervalMinutes 180 -SnapshotNumber 3 -SourceSite $mySourceSite -TargetComputeContainer $myTargetComputeContainer -TargetDataCenter $myTargetDataCenter -TargetDatastore $myTargetDatastore -VM $myVm</dev:code> <dev:remarks> <maml:para>Creates a replication request.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>New-HCXReplication -DestinationSeedVm $myDestinationSeedVm -DestinationSite myDestination -RPOIntervalMinutes 30 -SnapshotIntervalMinutes 180 -SnapshotNumber 3 -SourceSite $mySourceSite -VM $myVm</dev:code> <dev:remarks> <maml:para>Creates a replication request with a seed virtual machine option.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$myDestination = Get-HCXSite -Destination -Name "myDestinationName" $myStorageProfile = Get-HCXStorageProfile -Site $myDestination -Name "myStorageProfileName" New-HCXReplication -DestinationSite $myDestination -NetworkMapping $myNetworkMapping -RPOIntervalMinutes 30 -SnapshotIntervalMinutes 180 -SnapshotNumber 3 -SourceSite $mySourceSite -TargetComputeContainer $myTargetComputeContainer -TargetDataCenter $myTargetDataCenter -TargetDatastore $myTargetDatastore -VM $myVm -StorageProfile $myStorageProfile</dev:code> <dev:remarks> <maml:para>Creates a replication request with a datastore matching storage profile on the destination site.</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-HCXSentinelBundle</command:name> <command:verb>New</command:verb> <command:noun>HCXSentinelBundle</command:noun> <maml:description> <maml:para>This cmdlet creates and downloads an HCX Sentinel bundle.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates and downloads an HCX Sentinel bundle. You need to install the Sentinel agent software on all virtual machines that you want to migrate by using the OS Assisted Migration service.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HCXSentinelBundle</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OSType</maml:name> <maml:Description> <maml:para>Specifies the OS type for which you want to generate the sentinel bundle.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Windows</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Linux</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OSType</command:parameterValue> <dev:type> <maml:name>OSType</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>SGWAppliance</maml:name> <maml:Description> <maml:para>Specifies the Sentinel Gateway (SGW) whose bundle is to be generated. You can obtain it from the Interconnect Service Mesh appliance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXInterconnectAppliance</command:parameterValue> <dev:type> <maml:name>HCXInterconnectAppliance</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Path</maml:name> <maml:Description> <maml:para>Specifies the local file path where you can store the downloaded file. If not specified, the current directory 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OSType</maml:name> <maml:Description> <maml:para>Specifies the OS type for which you want to generate the sentinel bundle.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">OSType</command:parameterValue> <dev:type> <maml:name>OSType</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>SGWAppliance</maml:name> <maml:Description> <maml:para>Specifies the Sentinel Gateway (SGW) whose bundle is to be generated. You can obtain it from the Interconnect Service Mesh appliance.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXInterconnectAppliance</command:parameterValue> <dev:type> <maml:name>HCXInterconnectAppliance</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Path</maml:name> <maml:Description> <maml:para>Specifies the local file path where you can store the downloaded file. If not specified, the current directory 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:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXInterconnectAppliance</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.Hcx.Types.V1.HCXSentinelBundle</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>$sgwAppliance = Get-HCXAppliance -Type SentinelGateway $fileInfo = New-HCXSentinelBundle -OSType Linux -SGWAppliance $sgwAppliance</dev:code> <dev:remarks> <maml:para>Creates a sentinel bundle for the specified OS and downloads it in the current directory.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$sgwAppliance = Get-HCXAppliance -Type SentinelGateway $fileInfo = New-HCXSentinelBundle -OSType Windows -SGWAppliance $sgwAppliance -Path "C:\\Documents\\sentinel-bundle.zip"</dev:code> <dev:remarks> <maml:para>Creates a sentinel bundle for the specified OS and downloads it in the specified location.</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-HCXServiceMesh</command:name> <command:verb>New</command:verb> <command:noun>HCXServiceMesh</command:noun> <maml:description> <maml:para>This cmdlet creates an HCX Service Mesh.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates an HCX Service Mesh. You can use the HCXInterconnectTask output to retrieve task details by running the Get-HCXJob cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HCXServiceMesh</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>DVS</maml:name> <maml:Description> <maml:para>Specifies the distributed virtual switch (DVS). The Service Mesh defaults to one Extension appliance per vSphere Distributed Switch.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXServiceMeshDVS[]</command:parameterValue> <dev:type> <maml:name>HCXServiceMeshDVS[]</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>Destination</maml:name> <maml:Description> <maml:para>Specifies the destination site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>DestinationComputeProfile</maml:name> <maml:Description> <maml:para>Specifies the destination site compute profile for enabling hybridity services.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXComputeProfile</command:parameterValue> <dev:type> <maml:name>HCXComputeProfile</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>DestinationUplinkNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies the destination uplink network profile that you can use to connect to the network and by which you can reach the remote site's Interconnect appliances. By default, the uplink network profile is used from the compute profile selected at the destination site. It is mandatory when the uplink network profile is not provided in the destination compute profile.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile[]</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile[]</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 HCX Service Mesh.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Service</maml:name> <maml:Description> <maml:para>Specifies the services that you want to enable. Licenses must be enabled for the RAV and OSAssistedMigration services to work.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Interconnect</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NetworkExtension</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WANOptimization</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BulkMigration</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DisasterRecovery</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Vmotion</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RAV</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OSAssistedMigration</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">InterconnectServiceType[]</command:parameterValue> <dev:type> <maml:name>InterconnectServiceType[]</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>SourceComputeProfile</maml:name> <maml:Description> <maml:para>Specifies the source site compute profile for enabling hybridity services.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXComputeProfile</command:parameterValue> <dev:type> <maml:name>HCXComputeProfile</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>SourceUplinkNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies the source uplink network profile that you can use to connect to the network and by which you can reach the remote site's Interconnect appliances. By default, the uplink network profile is used from the compute profile selected at the source site. It is mandatory when the uplink network profile is not provided in the source compute profile.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile[]</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile[]</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>WANOptimizationBandwidth</maml:name> <maml:Description> <maml:para>Specifies the maximum aggregate uplink bandwidth that you want to consume for migrations across all uplinks.</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:syntaxItem> <command:syntaxItem> <maml:name>New-HCXServiceMesh</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Destination</maml:name> <maml:Description> <maml:para>Specifies the destination site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>UpgradeFromFleet</maml:name> <maml:Description> <maml:para>Indicates that you want to upgrade the fleet appliances to the Service Mesh.</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-HCXServiceMesh</maml:name> <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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>ServiceMesh</maml:name> <maml:Description> <maml:para>Specifies the Service Mesh that you want to resync.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXServiceMesh</command:parameterValue> <dev:type> <maml:name>HCXServiceMesh</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="True (ByValue)" position="named" aliases="none"> <maml:name>DVS</maml:name> <maml:Description> <maml:para>Specifies the distributed virtual switch (DVS). The Service Mesh defaults to one Extension appliance per vSphere Distributed Switch.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXServiceMeshDVS[]</command:parameterValue> <dev:type> <maml:name>HCXServiceMeshDVS[]</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>Destination</maml:name> <maml:Description> <maml:para>Specifies the destination site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>DestinationComputeProfile</maml:name> <maml:Description> <maml:para>Specifies the destination site compute profile for enabling hybridity services.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXComputeProfile</command:parameterValue> <dev:type> <maml:name>HCXComputeProfile</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>DestinationUplinkNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies the destination uplink network profile that you can use to connect to the network and by which you can reach the remote site's Interconnect appliances. By default, the uplink network profile is used from the compute profile selected at the destination site. It is mandatory when the uplink network profile is not provided in the destination compute profile.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile[]</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile[]</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 HCX Service Mesh.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Service</maml:name> <maml:Description> <maml:para>Specifies the services that you want to enable. Licenses must be enabled for the RAV and OSAssistedMigration services to work.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">InterconnectServiceType[]</command:parameterValue> <dev:type> <maml:name>InterconnectServiceType[]</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>SourceComputeProfile</maml:name> <maml:Description> <maml:para>Specifies the source site compute profile for enabling hybridity services.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXComputeProfile</command:parameterValue> <dev:type> <maml:name>HCXComputeProfile</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>SourceUplinkNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies the source uplink network profile that you can use to connect to the network and by which you can reach the remote site's Interconnect appliances. By default, the uplink network profile is used from the compute profile selected at the source site. It is mandatory when the uplink network profile is not provided in the source compute profile.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile[]</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile[]</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>UpgradeFromFleet</maml:name> <maml:Description> <maml:para>Indicates that you want to upgrade the fleet appliances to the Service Mesh.</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>WANOptimizationBandwidth</maml:name> <maml:Description> <maml:para>Specifies the maximum aggregate uplink bandwidth that you want to consume for migrations across all uplinks.</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="True (ByValue)" position="named" aliases="none"> <maml:name>ServiceMesh</maml:name> <maml:Description> <maml:para>Specifies the Service Mesh that you want to resync.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXServiceMesh</command:parameterValue> <dev:type> <maml:name>HCXServiceMesh</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.Hcx.Types.V1.HCXNetworkProfile[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXComputeProfile</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXServiceMeshDVS[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXSite</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.Hcx.Types.V1.HCXInterconnectTask</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>$destination = Get-HCXSite -Destination $myLocalComputeProfile = Get-HCXComputeProfile -Name "myLocalComputeProfile" $myRemoteComputeProfile = Get-HCXComputeProfile -Site $destination -Name "myRemoteComputeProfile" New-HCXServiceMesh -SourceComputeProfile $myLocalComputeProfile -Destination $destination -DestinationComputeProfile $myRemoteComputeProfile -Service BulkMigration,DisasterRecovery,Interconnect,NetworkExtension,Vmotion,WANOptimization -Name "myServiceMesh"</dev:code> <dev:remarks> <maml:para>Creates a new HCX Service Mesh.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$destination = Get-HCXSite -Destination New-HCXServiceMesh -UpgradeFromFleet -Destination $destination</dev:code> <dev:remarks> <maml:para>Upgrades the old fleet to a Service Mesh.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$myServiceMesh = Get-HCXServiceMesh New-HCXServiceMesh -ServiceMesh $myServiceMesh</dev:code> <dev:remarks> <maml:para>Indicates that you want to resync the Service Mesh.</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-HCXServiceMeshDVS</command:name> <command:verb>New</command:verb> <command:noun>HCXServiceMeshDVS</command:noun> <maml:description> <maml:para>This cmdlet creates a DVS configuration for the Service Mesh.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates a DVS configuration for the Service Mesh. You can use the output of the cmdlet to create a Service Mesh.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HCXServiceMeshDVS</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ApplianceCount</maml:name> <maml:Description> <maml:para>Specifies the appliance count for the Distributed Switch pair.</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="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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>LocalDVS</maml:name> <maml:Description> <maml:para>Specifies the local Compute Profile DVS.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceDVS</command:parameterValue> <dev:type> <maml:name>HCXApplianceDVS</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>RemoteDVS</maml:name> <maml:Description> <maml:para>Specifies a remote Compute Profile DVS.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceDVS</command:parameterValue> <dev:type> <maml:name>HCXApplianceDVS</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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>ApplianceCount</maml:name> <maml:Description> <maml:para>Specifies the appliance count for the Distributed Switch pair.</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="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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>LocalDVS</maml:name> <maml:Description> <maml:para>Specifies the local Compute Profile DVS.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceDVS</command:parameterValue> <dev:type> <maml:name>HCXApplianceDVS</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>RemoteDVS</maml:name> <maml:Description> <maml:para>Specifies a remote Compute Profile DVS.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceDVS</command:parameterValue> <dev:type> <maml:name>HCXApplianceDVS</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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.Hcx.Types.V1.HCXApplianceDVS</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.Hcx.Types.V1.HCXServiceMeshDVS</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>$myLocalComputeProfile = Get-HCXComputeProfile -Name "myLocalComputeProfile" $destination = Get-HCXSite -Destination $myRemoteComputeProfile = Get-HCXComputeProfile -Site $destination -Name "myRemoteComputeProfile" $serviceMeshDVS = New-HCXServiceMeshDVS -LocalDVS $myLocalComputeProfile.DVS[0] -RemoteDVS $myRemoteComputeProfile.DVS[0] -ApplianceCount 1</dev:code> <dev:remarks> <maml:para>Configures the DVS pair with an appliance count.</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-HCXSitePairing</command:name> <command:verb>New</command:verb> <command:noun>HCXSitePairing</command:noun> <maml:description> <maml:para>This cmdlet creates an HCX site pairing request.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates an HCX site pairing request. To use or deploy the HCX migration, mobility and extension services, you must register the remote site in the local/source HCX system. A single HCX source site can be connected with one or more HCX Cloud remote sites.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HCXSitePairing</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>Specifies the password you want to use for authenticating with the remote site.</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>Server</maml:name> <maml:Description> <maml:para>Specifies the HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Url</maml:name> <maml:Description> <maml:para>Specifies the URL of the remote site that you want to register.</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>Username</maml:name> <maml:Description> <maml:para>Specifies the user name for authenticating on the remote site.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>Specifies the password you want to use for authenticating with the remote site.</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>Server</maml:name> <maml:Description> <maml:para>Specifies the HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Url</maml:name> <maml:Description> <maml:para>Specifies the URL of the remote site that you want to register.</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>Username</maml:name> <maml:Description> <maml:para>Specifies the user name for authenticating on the remote site.</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>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.Hcx.Types.V1.HCXJob</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-HCXSitePairing -Url $myUrl -Username $myUsername -Password $myPassword</dev:code> <dev:remarks> <maml:para>Registers a new site pairing with the specified cloud URL.</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-HCXStaticRoute</command:name> <command:verb>New</command:verb> <command:noun>HCXStaticRoute</command:noun> <maml:description> <maml:para>This cmdlet creates a static route.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates a static route and provides a static route for the networks that are not reachable through the default gateway. You can create a new Interconnect appliance by using the output of the cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-HCXStaticRoute</maml:name> <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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Gateway</maml:name> <maml:Description> <maml:para>Specifies the 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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MTU</maml:name> <maml:Description> <maml:para>Specifies the maximum transmission unit. The default value is 1500 bytes.</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>Network</maml:name> <maml:Description> <maml:para>Specifies the network of the static route provided in the <network-ip>/<prefix-length> format.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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="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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Gateway</maml:name> <maml:Description> <maml:para>Specifies the 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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MTU</maml:name> <maml:Description> <maml:para>Specifies the maximum transmission unit. The default value is 1500 bytes.</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>Network</maml:name> <maml:Description> <maml:para>Specifies the network of the static route provided in the <network-ip>/<prefix-length> format.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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.Hcx.Types.V1.HCXStaticRoute</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-HCXStaticRoute -Network 192.168.100.0/24 -Gateway 192.168.0.1</dev:code> <dev:remarks> <maml:para>Creates a static route.</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-HCXAppliance</command:name> <command:verb>Remove</command:verb> <command:noun>HCXAppliance</command:noun> <maml:description> <maml:para>This cmdlet removes an HCX Appliance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes an HCX Appliance which can be of type Interconnect, L2Concentrator, and WANOptimization. You can use the HCXJob output to retrieve job details by running the Get-HCXJob cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HCXAppliance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Appliance</maml:name> <maml:Description> <maml:para>Specifies the appliance you want to remove. The supported types are Interconnect, L2Concentrator, and WANOptimization.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXAppliance</command:parameterValue> <dev:type> <maml:name>HCXAppliance</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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>DestinationSite</maml:name> <maml:Description> <maml:para>Specifies the destination site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>Indicates that you want to remove the appliance. If the Force parameter is not set and the resource is busy, the appliance removal job will not be initiated.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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="0" aliases="none"> <maml:name>Appliance</maml:name> <maml:Description> <maml:para>Specifies the appliance you want to remove. The supported types are Interconnect, L2Concentrator, and WANOptimization.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXAppliance</command:parameterValue> <dev:type> <maml:name>HCXAppliance</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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>DestinationSite</maml:name> <maml:Description> <maml:para>Specifies the destination site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>Indicates that you want to remove the appliance. If the Force parameter is not set and the resource is busy, the appliance removal job will not be initiated.</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="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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.Hcx.Types.V1.HCXAppliance</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXSite</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.Hcx.Types.V1.HCXJob</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-HCXAppliance -Appliance $myAppliance -DestinationSite $myDestination -Force</dev:code> <dev:remarks> <maml:para>Removes the appliance.</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-HCXComputeProfile</command:name> <command:verb>Remove</command:verb> <command:noun>HCXComputeProfile</command:noun> <maml:description> <maml:para>This cmdlet removes an existing HCX Compute Profile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes an existing HCX Compute Profile.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HCXComputeProfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>ComputeProfile</maml:name> <maml:Description> <maml:para>Specifies the Compute Profile that you want to remove. To retrieve a Compute Profile, use the Get-HCXComputeProfile cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXComputeProfile</command:parameterValue> <dev:type> <maml:name>HCXComputeProfile</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Prompts you for confirmation before running the cmdlet.</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>Shows what would happen if the cmdlet runs. The cmdlet is not run.</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>ComputeProfile</maml:name> <maml:Description> <maml:para>Specifies the Compute Profile that you want to remove. To retrieve a Compute Profile, use the Get-HCXComputeProfile cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXComputeProfile</command:parameterValue> <dev:type> <maml:name>HCXComputeProfile</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Prompts you for confirmation before running the cmdlet.</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>Shows what would happen if the cmdlet runs. The cmdlet is not run.</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.Hcx.Types.V1.HCXComputeProfile</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.Hcx.Types.V1.HCXInterconnectTask</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>$myComputeProfile = Get-HCXComputeProfile -Name "myComputeProfile" Remove-HCXComputeProfile -ComputeProfile $myComputeProfile</dev:code> <dev:remarks> <maml:para>Removes the Compute Profile.</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-HCXNetworkExtension</command:name> <command:verb>Remove</command:verb> <command:noun>HCXNetworkExtension</command:noun> <maml:description> <maml:para>This cmdlet removes an HCX Network Extension.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes an HCX Network Extension (L2 extension) and you can reverse the stretch operation on the provided network. You can retrieve job details by running the Get-HCXJob cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HCXNetworkExtension</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>HCXNetworkExtension</maml:name> <maml:Description> <maml:para>Specifies the HCX network extension that you want to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkExtension</command:parameterValue> <dev:type> <maml:name>HCXNetworkExtension</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>ConnectToLocalRouter</maml:name> <maml:Description> <maml:para>Specifies the option which connects the network to a local router after removing the network extension.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Shows what would happen if the cmdlet runs. The cmdlet is not run.</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>ConnectToLocalRouter</maml:name> <maml:Description> <maml:para>Specifies the option which connects the network to a local router after removing the network extension.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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="0" aliases="none"> <maml:name>HCXNetworkExtension</maml:name> <maml:Description> <maml:para>Specifies the HCX network extension that you want to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkExtension</command:parameterValue> <dev:type> <maml:name>HCXNetworkExtension</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Shows what would happen if the cmdlet runs. The cmdlet is not run.</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.Hcx.Types.V1.HCXNetworkExtension</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.Hcx.Types.V1.HCXJob</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-HCXNetworkExtension -HCXNetworkExtension $networkExtended</dev:code> <dev:remarks> <maml:para>Removes the network extension.</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-HCXNetworkProfile</command:name> <command:verb>Remove</command:verb> <command:noun>HCXNetworkProfile</command:noun> <maml:description> <maml:para>This cmdlet removes an existing HCX Network Profile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes an existing HCX Network Profile.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HCXNetworkProfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>NetworkProfile</maml:name> <maml:Description> <maml:para>Specifies the Network Profile that you want to remove. To retrieve a Network Profile, use the Get-HCXNetworkProfile cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Prompts you for confirmation before running the cmdlet.</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>InterconnectNetworkType</maml:name> <maml:Description> <maml:para>Specifies network type to be removed from Service Mesh or Compute Profile's Network.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">InterconnectNetworkType</command:parameterValue> <dev:type> <maml:name>InterconnectNetworkType</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="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</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>NetworkProfile</maml:name> <maml:Description> <maml:para>Specifies the Network Profile that you want to remove. To retrieve a Network Profile, use the Get-HCXNetworkProfile cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Prompts you for confirmation before running the cmdlet.</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>InterconnectNetworkType</maml:name> <maml:Description> <maml:para>Specifies network type to be removed from Service Mesh or Compute Profile's Network.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">InterconnectNetworkType</command:parameterValue> <dev:type> <maml:name>InterconnectNetworkType</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="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</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.Hcx.Types.V1.HCXNetworkProfile</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.Hcx.Types.V1.HCXNetworkProfileJob</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>$myNetworkProfile = Get-HCXNetworkProfile -Name "myNetworkProfile" Remove-HCXNetworkProfile -NetworkProfile $myNetworkProfile</dev:code> <dev:remarks> <maml:para>Removes the Network Profile.</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-HCXReplication</command:name> <command:verb>Remove</command:verb> <command:noun>HCXReplication</command:noun> <maml:description> <maml:para>This cmdlet removes an existing HCX replication.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes an existing HCX replication.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HCXReplication</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Replication</maml:name> <maml:Description> <maml:para>Specifies the replication that you want to remove. To retrieve a replication, use the Get-HCXReplication cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXReplication[]</command:parameterValue> <dev:type> <maml:name>HCXReplication[]</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="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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="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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Replication</maml:name> <maml:Description> <maml:para>Specifies the replication that you want to remove. To retrieve a replication, use the Get-HCXReplication cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXReplication[]</command:parameterValue> <dev:type> <maml:name>HCXReplication[]</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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.Hcx.Types.V1.HCXReplication[]</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.Hcx.Types.V1.HCXJob</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-HCXReplication -Replication $myReplication</dev:code> <dev:remarks> <maml:para>Removes the replication.</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-HCXServiceMesh</command:name> <command:verb>Remove</command:verb> <command:noun>HCXServiceMesh</command:noun> <maml:description> <maml:para>This cmdlet removes an existing HCX Service Mesh.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes an existing HCX Service Mesh.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HCXServiceMesh</maml:name> <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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>ServiceMesh</maml:name> <maml:Description> <maml:para>Specifies the Service Mesh that you want to remove. To retrieve a Service Mesh, use the Get-HCXServiceMesh cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXServiceMesh</command:parameterValue> <dev:type> <maml:name>HCXServiceMesh</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>Prompts you for confirmation before running the cmdlet.</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>Shows what would happen if the cmdlet runs. The cmdlet is not run.</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>Server</maml:name> <maml:Description> <maml:para>Specifies the HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>ServiceMesh</maml:name> <maml:Description> <maml:para>Specifies the Service Mesh that you want to remove. To retrieve a Service Mesh, use the Get-HCXServiceMesh cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXServiceMesh</command:parameterValue> <dev:type> <maml:name>HCXServiceMesh</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>Prompts you for confirmation before running the cmdlet.</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>Shows what would happen if the cmdlet runs. The cmdlet is not run.</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.Hcx.Types.V1.HCXServiceMesh</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.Hcx.Types.V1.HCXInterconnectTask</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>$myServiceMesh = Get-HCXServiceMesh -Name "myServiceMesh" Remove-HCXServiceMesh -ServiceMesh $myServiceMesh</dev:code> <dev:remarks> <maml:para>Removes the Service Mesh.</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-HCXSitePairing</command:name> <command:verb>Remove</command:verb> <command:noun>HCXSitePairing</command:noun> <maml:description> <maml:para>This cmdlet removes the specified site pairing from the HCX.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes the specified site pairing from the HCX. This unpairs the connection between the source site and the remote cloud site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-HCXSitePairing</maml:name> <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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>SitePairing</maml:name> <maml:Description> <maml:para>Specifies the list of the site pairing objects that you want to delete.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSitePairing[]</command:parameterValue> <dev:type> <maml:name>HCXSitePairing[]</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>Server</maml:name> <maml:Description> <maml:para>Specifies the HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>SitePairing</maml:name> <maml:Description> <maml:para>Specifies the list of the site pairing objects that you want to delete.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSitePairing[]</command:parameterValue> <dev:type> <maml:name>HCXSitePairing[]</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.HCX.Types.V1.HCXSitePairing[]</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.hcx.appliance.model.HCXJob</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-HCXSitePairing -SitePairing $sitePairing</dev:code> <dev:remarks> <maml:para>Removes a site pairing.</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>Resume-HCXReplication</command:name> <command:verb>Resume</command:verb> <command:noun>HCXReplication</command:noun> <maml:description> <maml:para>This cmdlet resumes an HCX replication.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet resumes an HCX replication. The cmdlet also resumes syncing data at specified RPO (Recovery Point Objective) for a replication which is paused.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Resume-HCXReplication</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Replication</maml:name> <maml:Description> <maml:para>Specifies the replication object for which you want to resume the sync process.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXReplication[]</command:parameterValue> <dev:type> <maml:name>HCXReplication[]</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="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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="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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Replication</maml:name> <maml:Description> <maml:para>Specifies the replication object for which you want to resume the sync process.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXReplication[]</command:parameterValue> <dev:type> <maml:name>HCXReplication[]</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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.Hcx.Types.V1.HCXReplication[]</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.Hcx.Types.V1.HCXJob</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>Resume-HCXReplication -Replication $myReplication</dev:code> <dev:remarks> <maml:para>Resumes the replication.</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-HCXAppliance</command:name> <command:verb>Set</command:verb> <command:noun>HCXAppliance</command:noun> <maml:description> <maml:para>This cmdlet modifies the HCX appliances of type Interconnect and Network Extension that are available on the HCX Server system.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet modifies the HCX appliances of type Interconnect and Network Extension that are available on the HCX Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HCXAppliance</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AdminPassword</maml:name> <maml:Description> <maml:para>Specifies the password by which you can log in to the appliance as an administrator.</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="True (ByValue)" position="named" aliases="none"> <maml:name>Appliance</maml:name> <maml:Description> <maml:para>Specifies the appliance for which you want to reset password or start the sync process. If you want to retrieve an appliance, use the Get-HCXAppliance cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXAppliance</command:parameterValue> <dev:type> <maml:name>HCXAppliance</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>RootPassword</maml:name> <maml:Description> <maml:para>Specifies the password by which you can log in to the appliance as a root user.</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="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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-HCXAppliance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Appliance</maml:name> <maml:Description> <maml:para>Specifies the appliance for which you want to reset password or start the sync process. If you want to retrieve an appliance, use the Get-HCXAppliance cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXAppliance</command:parameterValue> <dev:type> <maml:name>HCXAppliance</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>DestinationSite</maml:name> <maml:Description> <maml:para>Specifies the destination site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>StartSync</maml:name> <maml:Description> <maml:para>Specifies that you want to start a sync process for an existing appliance.</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>Set-HCXAppliance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Appliance</maml:name> <maml:Description> <maml:para>Specifies the appliance for which you want to reset password or start the sync process. If you want to retrieve an appliance, use the Get-HCXAppliance cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXAppliance</command:parameterValue> <dev:type> <maml:name>HCXAppliance</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the appliance.</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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AdminPassword</maml:name> <maml:Description> <maml:para>Specifies the password by which you can log in to the appliance as an administrator.</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="True (ByValue)" position="named" aliases="none"> <maml:name>Appliance</maml:name> <maml:Description> <maml:para>Specifies the appliance for which you want to reset password or start the sync process. If you want to retrieve an appliance, use the Get-HCXAppliance cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXAppliance</command:parameterValue> <dev:type> <maml:name>HCXAppliance</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>DestinationSite</maml:name> <maml:Description> <maml:para>Specifies the destination site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXSite</command:parameterValue> <dev:type> <maml:name>HCXSite</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>RootPassword</maml:name> <maml:Description> <maml:para>Specifies the password by which you can log in to the appliance as a root user.</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="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>StartSync</maml:name> <maml:Description> <maml:para>Specifies that you want to start a sync process for an existing appliance.</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the appliance.</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:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXSite</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXAppliance</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.Hcx.Types.V1.HCXJob</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>$myAppliance = Get-HCXAppliance -Name 'myAppliance' Set-HCXAppliance -AdminPassword 'myAdminPassword' -RootPassword 'myRootPassword' -Appliance $myAppliance</dev:code> <dev:remarks> <maml:para>Resets the passwords for the appliance.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$myAppliance = Get-HCXAppliance -Name 'myAppliance' $myDestinationSite = Get-HCXSite -Destination Set-HCXAppliance -DestinationSite $myDestinationSite -Appliance $myAppliance -StartSync</dev:code> <dev:remarks> <maml:para>Starts a sync process for the appliance.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$myAppliance = Get-HCXAppliance -Name 'myAppliance' Set-HCXAppliance -Name 'applianceName' -Appliance $myAppliance</dev:code> <dev:remarks> <maml:para>Renames the appliance.</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-HCXComputeProfile</command:name> <command:verb>Set</command:verb> <command:noun>HCXComputeProfile</command:noun> <maml:description> <maml:para>This cmdlet modifies the HCX Compute Profile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet modifies the HCX Compute Profile.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HCXComputeProfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ComputeProfile</maml:name> <maml:Description> <maml:para>Specifies the Compute Profile that you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXComputeProfile</command:parameterValue> <dev:type> <maml:name>HCXComputeProfile</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>DVS</maml:name> <maml:Description> <maml:para>Specifies the Distributed Virtual Switches (DVS) that you want to use for the HCX Network Extension services.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceDVS[]</command:parameterValue> <dev:type> <maml:name>HCXApplianceDVS[]</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>Datastore</maml:name> <maml:Description> <maml:para>Specifies the storage resource for deploying the HCX Interconnect appliances.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceDatastore[]</command:parameterValue> <dev:type> <maml:name>HCXApplianceDatastore[]</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>DeploymentResource</maml:name> <maml:Description> <maml:para>Specifies the compute resource for deploying the HCX Interconnect appliances. This can be a Cluster or a ResourcePool.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceCompute[]</command:parameterValue> <dev:type> <maml:name>HCXApplianceCompute[]</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>ManagementNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies the network profile by which you can reach the management interface of the vCenter Server system and the ESXi hosts.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile</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>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the HCX Compute Profile.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Service</maml:name> <maml:Description> <maml:para>Specifies the services that you want to enable. Licenses must be enabled for the RAV and OSAssistedMigration services to work.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Interconnect</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NetworkExtension</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WANOptimization</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BulkMigration</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DisasterRecovery</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Vmotion</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RAV</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OSAssistedMigration</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">InterconnectServiceType[]</command:parameterValue> <dev:type> <maml:name>InterconnectServiceType[]</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>ServiceCluster</maml:name> <maml:Description> <maml:para>Specifies one or more clusters for which you want to enable the selected HCX services.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceCompute[]</command:parameterValue> <dev:type> <maml:name>HCXApplianceCompute[]</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>UplinkNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies one or more network profiles in such a way that one of the following is true: 1. The Interconnect appliances on the remote site can be reached by the network. 2. The remote site appliances can reach the local Interconnect appliances by the network.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile[]</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile[]</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>vMotionNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies the Network Profile for ? vMotion network for the HCX appliances.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile</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>vSphereReplicationNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies a Network Profile by which you can reach the vSphere Replication interface of the ESXi hosts.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile</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>GuestNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies the Network Profile with a network that has access to the sentinel workloads.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile</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>ComputeProfile</maml:name> <maml:Description> <maml:para>Specifies the Compute Profile that you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXComputeProfile</command:parameterValue> <dev:type> <maml:name>HCXComputeProfile</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>DVS</maml:name> <maml:Description> <maml:para>Specifies the Distributed Virtual Switches (DVS) that you want to use for the HCX Network Extension services.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceDVS[]</command:parameterValue> <dev:type> <maml:name>HCXApplianceDVS[]</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>Datastore</maml:name> <maml:Description> <maml:para>Specifies the storage resource for deploying the HCX Interconnect appliances.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceDatastore[]</command:parameterValue> <dev:type> <maml:name>HCXApplianceDatastore[]</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>DeploymentResource</maml:name> <maml:Description> <maml:para>Specifies the compute resource for deploying the HCX Interconnect appliances. This can be a Cluster or a ResourcePool.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceCompute[]</command:parameterValue> <dev:type> <maml:name>HCXApplianceCompute[]</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>ManagementNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies the network profile by which you can reach the management interface of the vCenter Server system and the ESXi hosts.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile</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>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the HCX Compute Profile.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Service</maml:name> <maml:Description> <maml:para>Specifies the services that you want to enable. Licenses must be enabled for the RAV and OSAssistedMigration services to work.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">InterconnectServiceType[]</command:parameterValue> <dev:type> <maml:name>InterconnectServiceType[]</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>ServiceCluster</maml:name> <maml:Description> <maml:para>Specifies one or more clusters for which you want to enable the selected HCX services.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXApplianceCompute[]</command:parameterValue> <dev:type> <maml:name>HCXApplianceCompute[]</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>UplinkNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies one or more network profiles in such a way that one of the following is true: 1. The Interconnect appliances on the remote site can be reached by the network. 2. The remote site appliances can reach the local Interconnect appliances by the network.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile[]</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile[]</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>vMotionNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies the Network Profile for ? vMotion network for the HCX appliances.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile</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>vSphereReplicationNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies a Network Profile by which you can reach the vSphere Replication interface of the ESXi hosts.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile</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>GuestNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies the Network Profile with a network that has access to the sentinel workloads.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile</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.Hcx.Types.V1.HCXNetworkProfile</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXNetworkProfile[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXApplianceDVS[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXApplianceCompute[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXApplianceDatastore[]</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.Hcx.Types.V1.HCXInterconnectTask</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>$myComputeProfile = Get-HCXComputeProfile -Name "myComputeProfile" Set-HCXComputeProfile -Name "newComputeProfile" -ComputeProfile $myComputeProfile</dev:code> <dev:remarks> <maml:para>Modifies the Compute Profile name.</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-HCXMigration</command:name> <command:verb>Set</command:verb> <command:noun>HCXMigration</command:noun> <maml:description> <maml:para>This cmdlet modifies the HCX migrations.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet modifies the HCX migrations. You can use the cmdlet to either abort a migration or change the schedule for a bulk migration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HCXMigration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Migration</maml:name> <maml:Description> <maml:para>Specifies the HCX migration that you want to update.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMigration</command:parameterValue> <dev:type> <maml:name>HCXMigration</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>Abort</maml:name> <maml:Description> <maml:para>Indicates that you can cancel the migration.</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="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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-HCXMigration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Migration</maml:name> <maml:Description> <maml:para>Specifies the HCX migration that you want to update.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMigration</command:parameterValue> <dev:type> <maml:name>HCXMigration</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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ScheduleEndTime</maml:name> <maml:Description> <maml:para>Specifies the end time of the schedule window.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</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>ScheduleStartTime</maml:name> <maml:Description> <maml:para>Specifies the start time of the schedule window.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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-HCXMigration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Migration</maml:name> <maml:Description> <maml:para>Specifies the HCX migration that you want to update.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMigration</command:parameterValue> <dev:type> <maml:name>HCXMigration</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="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RemoveSwitchOver</maml:name> <maml:Description> <maml:para>Specifies that you want to remove the schedule window for the migration.</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>Abort</maml:name> <maml:Description> <maml:para>Indicates that you can cancel the migration.</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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Migration</maml:name> <maml:Description> <maml:para>Specifies the HCX migration that you want to update.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMigration</command:parameterValue> <dev:type> <maml:name>HCXMigration</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>ScheduleEndTime</maml:name> <maml:Description> <maml:para>Specifies the end time of the schedule window.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</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>ScheduleStartTime</maml:name> <maml:Description> <maml:para>Specifies the start time of the schedule window.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RemoveSwitchOver</maml:name> <maml:Description> <maml:para>Specifies that you want to remove the schedule window for the migration.</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.Hcx.Types.V1.HCXMigration</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.Hcx.Types.V1.HCXMigration</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-HCXMigration -ScheduleStartTime '01/18/2019 3:57 PM' -ScheduleEndTime '01/18/2019 4:57 PM' -Migration $migration</dev:code> <dev:remarks> <maml:para>Modifies the schedule start time and schedule end time for the given migration. You can use the cmdlet in case of bulk migration.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Set-HCXMigration -Abort -Migration $migration</dev:code> <dev:remarks> <maml:para>Aborts the given migration and you can use it in case of bulk migration.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Set-HCXMigration -Migration $migration -RemoveSwitchOver</dev:code> <dev:remarks> <maml:para>Removes the schedule window and you can use it in case of bulk migration.</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-HCXMobilityGroup</command:name> <command:verb>Set</command:verb> <command:noun>HCXMobilityGroup</command:noun> <maml:description> <maml:para>This cmdlet modifies the HCX mobility group.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet modifies the HCX mobility group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HCXMobilityGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AddMigration</maml:name> <maml:Description> <maml:para>Indicates that you can add the migrations to the HCX mobility group.</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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Migration</maml:name> <maml:Description> <maml:para>Specifies the array of a virtual machine and its configurations that are part of the HCX mobility group.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMobilityGroupMigration[]</command:parameterValue> <dev:type> <maml:name>HCXMobilityGroupMigration[]</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>MobilityGroup</maml:name> <maml:Description> <maml:para>Specifies the HCX mobility group that you want to update.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMobilityGroup</command:parameterValue> <dev:type> <maml:name>HCXMobilityGroup</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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. The cmdlet is not run.</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-HCXMobilityGroup</maml:name> <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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Migration</maml:name> <maml:Description> <maml:para>Specifies the array of a virtual machine and its configurations that are part of the HCX mobility group.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMobilityGroupMigration[]</command:parameterValue> <dev:type> <maml:name>HCXMobilityGroupMigration[]</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>MobilityGroup</maml:name> <maml:Description> <maml:para>Specifies the HCX mobility group that you want to update.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMobilityGroup</command:parameterValue> <dev:type> <maml:name>HCXMobilityGroup</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>RemoveMigration</maml:name> <maml:Description> <maml:para>Indicates that you want to remove the migrations from an HCX mobility group.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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. The cmdlet is not run.</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-HCXMobilityGroup</maml:name> <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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>MobilityGroup</maml:name> <maml:Description> <maml:para>Specifies the HCX mobility group that you want to update.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMobilityGroup</command:parameterValue> <dev:type> <maml:name>HCXMobilityGroup</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 an HCX mobility group.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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. The cmdlet is not run.</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>AddMigration</maml:name> <maml:Description> <maml:para>Indicates that you can add the migrations to the HCX mobility group.</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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Migration</maml:name> <maml:Description> <maml:para>Specifies the array of a virtual machine and its configurations that are part of the HCX mobility group.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMobilityGroupMigration[]</command:parameterValue> <dev:type> <maml:name>HCXMobilityGroupMigration[]</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>MobilityGroup</maml:name> <maml:Description> <maml:para>Specifies the HCX mobility group that you want to update.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMobilityGroup</command:parameterValue> <dev:type> <maml:name>HCXMobilityGroup</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 an HCX mobility group.</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>RemoveMigration</maml:name> <maml:Description> <maml:para>Indicates that you want to remove the migrations from an HCX mobility group.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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. The cmdlet is not run.</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.Hcx.Types.V1.HCXMobilityGroup</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXMobilityGroupMigration[]</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.Hcx.Types.V1.HCXMobilityGroup</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-HCXMobilityGroup -MobilityGroup $mobilityGroup -Migration $newHCXMobilityGroupMigration -AddMigration</dev:code> <dev:remarks> <maml:para>Adds $newHCXMobilityMigration objects to the existing HCX mobility group.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Set-HCXMobilityGroup -MobilityGroup $mobilityGroup -Migration $existingHCXMobilityGroupMigration -RemoveMigration</dev:code> <dev:remarks> <maml:para>Removes $existingHCXMobilityGroupMigration objects from the existing HCX mobility group.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Set-HCXMobilityGroup -MobilityGroup $mobilityGroup -Name $newHCXMobilityGroupName</dev:code> <dev:remarks> <maml:para>Updates the name of the existing HCX mobility group to $newHCXMobilityGroupName.</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-HCXMobilityGroupConfiguration</command:name> <command:verb>Set</command:verb> <command:noun>HCXMobilityGroupConfiguration</command:noun> <maml:description> <maml:para>This cmdlet updates the HCX mobility group configurations.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet updates the HCX mobility group configurations.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HCXMobilityGroupConfiguration</maml:name> <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="none"> <maml:name>DiskProvisionType</maml:name> <maml:Description> <maml:para>Specifies the type of the disk provisioning that you want to use.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">SameAsSource</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Thick</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Thin</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">DiskProvisionType</command:parameterValue> <dev:type> <maml:name>DiskProvisionType</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>ForcePowerOffVm</maml:name> <maml:Description> <maml:para>Specifies whether you want the virtual machine to be in a powered off state after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>MigrationType</maml:name> <maml:Description> <maml:para>Specifies the type of migration that you want to perform.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">vMotion</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Bulk</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Cold</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RAV</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OsAssistedMigration</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">MigrationType</command:parameterValue> <dev:type> <maml:name>MigrationType</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>MobilityGroup</maml:name> <maml:Description> <maml:para>Specifies the mobility group where you want to perform an update operation.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMobilityGroup</command:parameterValue> <dev:type> <maml:name>HCXMobilityGroup</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>NetworkMapping</maml:name> <maml:Description> <maml:para>Specifies the source and destination networks you want to use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkMapping[]</command:parameterValue> <dev:type> <maml:name>HCXNetworkMapping[]</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>RemoveISOs</maml:name> <maml:Description> <maml:para>Specifies whether you want to remove the ISO files after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>RemoveSnapshots</maml:name> <maml:Description> <maml:para>Specifies whether you want to remove the snapshots after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>RetainMac</maml:name> <maml:Description> <maml:para>Specifies whether you want to retain the MAC address after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>ScheduleEndTime</maml:name> <maml:Description> <maml:para>Specifies the end time of the schedule window in case of bulk migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</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>ScheduleStartTime</maml:name> <maml:Description> <maml:para>Specifies the start time of the schedule window in case of bulk migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>TargetComputeContainer</maml:name> <maml:Description> <maml:para>Specifies the container on the destination site. If you want to retrieve the container, run Get-HCXContainer -Type ComputeContainer -Site $DestinationSite -Name "Container name".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXComputeContainer</command:parameterValue> <dev:type> <maml:name>HCXComputeContainer</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>TargetComputeFolder</maml:name> <maml:Description> <maml:para>Specifies the folder on the destination site. If you want to retrieve the folder, run Get-HCXContainer -Type Folder -Site $DestinationSite -Name "Folder name".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXFolderContainer</command:parameterValue> <dev:type> <maml:name>HCXFolderContainer</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>TargetDatastore</maml:name> <maml:Description> <maml:para>Specifies the datastore on the destination site. If you want to retrieve the datastore, run Get-HCXDatastore -Site $DestinationSite -Name "datastore name".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXDatastore</command:parameterValue> <dev:type> <maml:name>HCXDatastore</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>TargetStorageProfile</maml:name> <maml:Description> <maml:para>Specifies the storage profile at the destination site that you want to use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXStorageProfile</command:parameterValue> <dev:type> <maml:name>HCXStorageProfile</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>UpgradeHardware</maml:name> <maml:Description> <maml:para>Specifies whether you want to upgrade the hardware after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>UpgradeVMTools</maml:name> <maml:Description> <maml:para>Specifies whether you want to upgrade the VM tools after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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="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="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="none"> <maml:name>DiskProvisionType</maml:name> <maml:Description> <maml:para>Specifies the type of the disk provisioning that you want to use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DiskProvisionType</command:parameterValue> <dev:type> <maml:name>DiskProvisionType</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>ForcePowerOffVm</maml:name> <maml:Description> <maml:para>Specifies whether you want the virtual machine to be in a powered off state after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>MigrationType</maml:name> <maml:Description> <maml:para>Specifies the type of migration that you want to perform.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">MigrationType</command:parameterValue> <dev:type> <maml:name>MigrationType</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>MobilityGroup</maml:name> <maml:Description> <maml:para>Specifies the mobility group where you want to perform an update operation.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMobilityGroup</command:parameterValue> <dev:type> <maml:name>HCXMobilityGroup</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>NetworkMapping</maml:name> <maml:Description> <maml:para>Specifies the source and destination networks you want to use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkMapping[]</command:parameterValue> <dev:type> <maml:name>HCXNetworkMapping[]</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>RemoveISOs</maml:name> <maml:Description> <maml:para>Specifies whether you want to remove the ISO files after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>RemoveSnapshots</maml:name> <maml:Description> <maml:para>Specifies whether you want to remove the snapshots after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>RetainMac</maml:name> <maml:Description> <maml:para>Specifies whether you want to retain the MAC address after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>ScheduleEndTime</maml:name> <maml:Description> <maml:para>Specifies the end time of the schedule window in case of bulk migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</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>ScheduleStartTime</maml:name> <maml:Description> <maml:para>Specifies the start time of the schedule window in case of bulk migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>TargetComputeContainer</maml:name> <maml:Description> <maml:para>Specifies the container on the destination site. If you want to retrieve the container, run Get-HCXContainer -Type ComputeContainer -Site $DestinationSite -Name "Container name".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXComputeContainer</command:parameterValue> <dev:type> <maml:name>HCXComputeContainer</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>TargetComputeFolder</maml:name> <maml:Description> <maml:para>Specifies the folder on the destination site. If you want to retrieve the folder, run Get-HCXContainer -Type Folder -Site $DestinationSite -Name "Folder name".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXFolderContainer</command:parameterValue> <dev:type> <maml:name>HCXFolderContainer</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>TargetDatastore</maml:name> <maml:Description> <maml:para>Specifies the datastore on the destination site. If you want to retrieve the datastore, run Get-HCXDatastore -Site $DestinationSite -Name "datastore name".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXDatastore</command:parameterValue> <dev:type> <maml:name>HCXDatastore</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>TargetStorageProfile</maml:name> <maml:Description> <maml:para>Specifies the storage profile at the destination site that you want to use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXStorageProfile</command:parameterValue> <dev:type> <maml:name>HCXStorageProfile</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>UpgradeHardware</maml:name> <maml:Description> <maml:para>Specifies whether you want to upgrade the hardware after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>UpgradeVMTools</maml:name> <maml:Description> <maml:para>Specifies whether you want to upgrade the VM tools after the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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="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.Hcx.Types.V1.HCXMobilityGroup</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXComputeContainer</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXFolderContainer</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXDatastore</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXStorageProfile</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.Hcx.Types.V1.HCXMobilityGroup</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-HCXMobilityGroupConfiguration -MobilityGroup $mobilityGroup -RemoveSnapshots true -ScheduleStartTime '01/02/2019 7:50:40 PM' -ScheduleEndTime '01/02/2019 8:50:40 PM' -UpgradeHardware true -RetainMac false</dev:code> <dev:remarks> <maml:para>Updates the default group configuration with the specified configuration.</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-HCXNetworkProfile</command:name> <command:verb>Set</command:verb> <command:noun>HCXNetworkProfile</command:noun> <maml:description> <maml:para>This cmdlet modifies the HCX Network Profile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet modifies the HCX Network Profile.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HCXNetworkProfile</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowEditingIPPool</maml:name> <maml:Description> <maml:para>Specifies if you can edit the IP Pool by using the Enterprise Administrator login.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>DNSSuffix</maml:name> <maml:Description> <maml:para>Specifies the DNS suffix for the IP Pool.</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>GatewayAddress</maml:name> <maml:Description> <maml:para>Specifies the Gateway IP address for the IP Pool.</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>IPPool</maml:name> <maml:Description> <maml:para>Specifies the IP ranges. The following formats are valid: 1. IP address (ex: 10.2.3.4). 2. IP range (ex: 10.2.3.4-10.2.3.5).</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>MTU</maml:name> <maml:Description> <maml:para>Specifies the maximum transmission unit.</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>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the HCX Network Profile.</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>Network</maml:name> <maml:Description> <maml:para>Specifies the HCX network backing.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkBacking</command:parameterValue> <dev:type> <maml:name>HCXNetworkBacking</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>NetworkProfile</maml:name> <maml:Description> <maml:para>Specifies the Network Profile that you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile</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>PrefixLength</maml:name> <maml:Description> <maml:para>Specifies the prefix length for the Network Profile.</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>PrimaryDNS</maml:name> <maml:Description> <maml:para>Specifies the primary DNS for the Network Profile.</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>SecondaryDNS</maml:name> <maml:Description> <maml:para>Specifies the secondary DNS for the Network Profile.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>AllowEditingIPPool</maml:name> <maml:Description> <maml:para>Specifies if you can edit the IP Pool by using the Enterprise Administrator login.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>DNSSuffix</maml:name> <maml:Description> <maml:para>Specifies the DNS suffix for the IP Pool.</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>GatewayAddress</maml:name> <maml:Description> <maml:para>Specifies the Gateway IP address for the IP Pool.</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>IPPool</maml:name> <maml:Description> <maml:para>Specifies the IP ranges. The following formats are valid: 1. IP address (ex: 10.2.3.4). 2. IP range (ex: 10.2.3.4-10.2.3.5).</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>MTU</maml:name> <maml:Description> <maml:para>Specifies the maximum transmission unit.</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>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the HCX Network Profile.</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>Network</maml:name> <maml:Description> <maml:para>Specifies the HCX network backing.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkBacking</command:parameterValue> <dev:type> <maml:name>HCXNetworkBacking</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>NetworkProfile</maml:name> <maml:Description> <maml:para>Specifies the Network Profile that you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile</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>PrefixLength</maml:name> <maml:Description> <maml:para>Specifies the prefix length for the Network Profile.</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>PrimaryDNS</maml:name> <maml:Description> <maml:para>Specifies the primary DNS for the Network Profile.</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>SecondaryDNS</maml:name> <maml:Description> <maml:para>Specifies the secondary DNS for the Network Profile.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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.Hcx.Types.V1.HCXNetworkBacking</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.Hcx.Types.V1.HCXNetworkProfileJob</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>$myNetworkProfile = Get-HCXNetworkProfile -Name "myNetworkProfile" Set-HCXNetworkProfile -Name "newNetworkProfile" -NetworkProfile $myNetworkProfile</dev:code> <dev:remarks> <maml:para>Modifies the name of the Network Profile.</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-HCXReplication</command:name> <command:verb>Set</command:verb> <command:noun>HCXReplication</command:noun> <maml:description> <maml:para>This cmdlet modifies an existing HCX replication.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet modifies an existing HCX replication. You can use the cmdlet to perform the FoceSync, Recover, TestRecover, Reverse, and TestCleanup operations on the HCXReplication objects.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HCXReplication</maml:name> <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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ForceSync</maml:name> <maml:Description> <maml:para>Specifies whether you want to sync data from a source to destination with specified RPO.</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>Replication</maml:name> <maml:Description> <maml:para>Specifies the replication. If you want to retrieve a replication request, use the Get-HCXReplication cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXReplication[]</command:parameterValue> <dev:type> <maml:name>HCXReplication[]</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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-HCXReplication</maml:name> <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="True (ByValue)" position="named" aliases="none"> <maml:name>NetworkMapping</maml:name> <maml:Description> <maml:para>Specifies the list of network mapping that you want to use from a source to destination site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkMapping[]</command:parameterValue> <dev:type> <maml:name>HCXNetworkMapping[]</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>PowerOffVMAfterRecovery</maml:name> <maml:Description> <maml:para>Specifies whether you want to power off the replicated virtual machine after recovering to the source site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>Replication</maml:name> <maml:Description> <maml:para>Specifies the replication. If you want to retrieve a replication request, use the Get-HCXReplication cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXReplication[]</command:parameterValue> <dev:type> <maml:name>HCXReplication[]</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Snapshot</maml:name> <maml:Description> <maml:para>Specifies the snapshot of the replicated virtual machine that you have to recover.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXReplicationSnapshot</command:parameterValue> <dev:type> <maml:name>HCXReplicationSnapshot</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>TargetComputeContainer</maml:name> <maml:Description> <maml:para>Specifies the container on the target site that you use for recovery.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXComputeContainer</command:parameterValue> <dev:type> <maml:name>HCXComputeContainer</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>TargetDatacenter</maml:name> <maml:Description> <maml:para>Specifies the data center on the target site that you want to use for recovery.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXFolderContainer</command:parameterValue> <dev:type> <maml:name>HCXFolderContainer</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>Test</maml:name> <maml:Description> <maml:para>Specifies the parameter that you want to use when testing the recovery process.</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-HCXReplication</maml:name> <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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Replication</maml:name> <maml:Description> <maml:para>Specifies the replication. If you want to retrieve a replication request, use the Get-HCXReplication cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXReplication[]</command:parameterValue> <dev:type> <maml:name>HCXReplication[]</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>Reverse</maml:name> <maml:Description> <maml:para>Reverses the replicated virtual machine that has been recovered from the destination to the source site.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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-HCXReplication</maml:name> <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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Replication</maml:name> <maml:Description> <maml:para>Specifies the replication. If you want to retrieve a replication request, use the Get-HCXReplication cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXReplication[]</command:parameterValue> <dev:type> <maml:name>HCXReplication[]</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>TestCleanup</maml:name> <maml:Description> <maml:para>Specifies the parameter that you want to use when cleaning up the test recovered virtual machine.</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="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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ForceSync</maml:name> <maml:Description> <maml:para>Specifies whether you want to sync data from a source to destination with specified RPO.</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="True (ByValue)" position="named" aliases="none"> <maml:name>NetworkMapping</maml:name> <maml:Description> <maml:para>Specifies the list of network mapping that you want to use from a source to destination site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkMapping[]</command:parameterValue> <dev:type> <maml:name>HCXNetworkMapping[]</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>PowerOffVMAfterRecovery</maml:name> <maml:Description> <maml:para>Specifies whether you want to power off the replicated virtual machine after recovering to the source site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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>Replication</maml:name> <maml:Description> <maml:para>Specifies the replication. If you want to retrieve a replication request, use the Get-HCXReplication cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXReplication[]</command:parameterValue> <dev:type> <maml:name>HCXReplication[]</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>Reverse</maml:name> <maml:Description> <maml:para>Reverses the replicated virtual machine that has been recovered from the destination to the source site.</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="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Snapshot</maml:name> <maml:Description> <maml:para>Specifies the snapshot of the replicated virtual machine that you have to recover.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXReplicationSnapshot</command:parameterValue> <dev:type> <maml:name>HCXReplicationSnapshot</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>TargetComputeContainer</maml:name> <maml:Description> <maml:para>Specifies the container on the target site that you use for recovery.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXComputeContainer</command:parameterValue> <dev:type> <maml:name>HCXComputeContainer</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>TargetDatacenter</maml:name> <maml:Description> <maml:para>Specifies the data center on the target site that you want to use for recovery.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXFolderContainer</command:parameterValue> <dev:type> <maml:name>HCXFolderContainer</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>Test</maml:name> <maml:Description> <maml:para>Specifies the parameter that you want to use when testing the recovery process.</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>TestCleanup</maml:name> <maml:Description> <maml:para>Specifies the parameter that you want to use when cleaning up the test recovered virtual machine.</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.Hcx.Types.V1.HCXComputeContainer</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXFolderContainer</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXNetworkMapping[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXReplication[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXReplicationSnapshot</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.Hcx.Types.V1.HCXJob</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-HCXReplication -ForceSync -Replication $myReplication</dev:code> <dev:remarks> <maml:para>Forces a sync process for the existing replication.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Set-HCXReplication -Replication $myReplication -Snapshot $mySnapshot</dev:code> <dev:remarks> <maml:para>Recovers the replicated virtual machine at the destination site.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Set-HCXReplication -Replication $myReplication -Snapshot $mySnapshot -Test</dev:code> <dev:remarks> <maml:para>Tests the recovery process of the replication.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Set-HCXReplication -Reverse -Replication $myReplication</dev:code> <dev:remarks> <maml:para>Specifies how to reverse the replication.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Set-HCXReplication -Replication $myReplication -TestCleanup</dev:code> <dev:remarks> <maml:para>Removes the test recovered virtual machine.</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-HCXServiceMesh</command:name> <command:verb>Set</command:verb> <command:noun>HCXServiceMesh</command:noun> <maml:description> <maml:para>Specifies the HCX Service Mesh that you want to modify.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Specifies the HCX Service Mesh that you want to modify.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-HCXServiceMesh</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>DVS</maml:name> <maml:Description> <maml:para>Specifies the Distributed Virtual Switch.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXServiceMeshDVS[]</command:parameterValue> <dev:type> <maml:name>HCXServiceMeshDVS[]</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>DestinationUplinkNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies the destination uplink network profile that you use to connect to the network and by which you can reach the remote site's Interconnect appliances.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile[]</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile[]</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>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the HCX Service Mesh.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Service</maml:name> <maml:Description> <maml:para>Specifies the services that you want to enable. Licenses must be enabled for the RAV and OSAssistedMigration services to work.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Interconnect</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NetworkExtension</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WANOptimization</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BulkMigration</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DisasterRecovery</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Vmotion</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RAV</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OSAssistedMigration</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">InterconnectServiceType[]</command:parameterValue> <dev:type> <maml:name>InterconnectServiceType[]</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>ServiceMesh</maml:name> <maml:Description> <maml:para>Specifies the Service Mesh that you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXServiceMesh</command:parameterValue> <dev:type> <maml:name>HCXServiceMesh</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>SourceUplinkNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies the source uplink network profile that you can use to connect to the network and by which you can reach the remote site's Interconnect appliances. By default, the uplink network profile is used from the compute profile selected at the source site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile[]</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile[]</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>WANOPTBandwidth</maml:name> <maml:Description> <maml:para>Specifies the maximum aggregate uplink bandwidth that you want to consume for migrations across all uplinks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</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="True (ByValue)" position="named" aliases="none"> <maml:name>DVS</maml:name> <maml:Description> <maml:para>Specifies the Distributed Virtual Switch.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXServiceMeshDVS[]</command:parameterValue> <dev:type> <maml:name>HCXServiceMeshDVS[]</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>DestinationUplinkNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies the destination uplink network profile that you use to connect to the network and by which you can reach the remote site's Interconnect appliances.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile[]</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile[]</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>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the HCX Service Mesh.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Service</maml:name> <maml:Description> <maml:para>Specifies the services that you want to enable. Licenses must be enabled for the RAV and OSAssistedMigration services to work.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">InterconnectServiceType[]</command:parameterValue> <dev:type> <maml:name>InterconnectServiceType[]</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>ServiceMesh</maml:name> <maml:Description> <maml:para>Specifies the Service Mesh that you want to modify.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXServiceMesh</command:parameterValue> <dev:type> <maml:name>HCXServiceMesh</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>SourceUplinkNetworkProfile</maml:name> <maml:Description> <maml:para>Specifies the source uplink network profile that you can use to connect to the network and by which you can reach the remote site's Interconnect appliances. By default, the uplink network profile is used from the compute profile selected at the source site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXNetworkProfile[]</command:parameterValue> <dev:type> <maml:name>HCXNetworkProfile[]</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>WANOPTBandwidth</maml:name> <maml:Description> <maml:para>Specifies the maximum aggregate uplink bandwidth that you want to consume for migrations across all uplinks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</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.Hcx.Types.V1.HCXNetworkProfile[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXServiceMeshDVS[]</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.Hcx.Types.V1.HCXInterconnectTask</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>$myServiceMesh = Get-HCXServiceMesh -Name myServiceMesh Set-HCXServiceMesh -ServiceMesh $myServiceMesh -Name "newServiceMesh"</dev:code> <dev:remarks> <maml:para>Modifies the name of the Service Mesh.</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>Start-HCXMigration</command:name> <command:verb>Start</command:verb> <command:noun>HCXMigration</command:noun> <maml:description> <maml:para>This cmdlet starts the HCX migrations.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet starts the HCX (Hybrid Cloud Extension) migrations.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-HCXMigration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Migration</maml:name> <maml:Description> <maml:para>Specifies the list of migration requests. If you want to retrieve a migration request, use the New-HCXMigration cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMigration[]</command:parameterValue> <dev:type> <maml:name>HCXMigration[]</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="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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="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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Migration</maml:name> <maml:Description> <maml:para>Specifies the list of migration requests. If you want to retrieve a migration request, use the New-HCXMigration cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMigration[]</command:parameterValue> <dev:type> <maml:name>HCXMigration[]</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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.Hcx.Types.V1.HCXMigration[]</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.Hcx.Types.V1.HCXMigration[]</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>Start-HCXMigration -Migration $migration1,$migration2</dev:code> <dev:remarks> <maml:para>Starts the HCX migrations for the $migration1 and $migration2 values.</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>Start-HCXMobilityGroupMigration</command:name> <command:verb>Start</command:verb> <command:noun>HCXMobilityGroupMigration</command:noun> <maml:description> <maml:para>This cmdlet starts the HCX Mobility Group migrations.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet starts the HCX Mobility Group migrations.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-HCXMobilityGroupMigration</maml:name> <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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the ID of the mobility group that you can use to identify any particular group.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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>Start-HCXMobilityGroupMigration</maml:name> <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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>MobilityGroup</maml:name> <maml:Description> <maml:para>Specifies a full mobility group definition.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMobilityGroup</command:parameterValue> <dev:type> <maml:name>HCXMobilityGroup</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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="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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the ID of the mobility group that you can use to identify any particular group.</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="True (ByValue)" position="named" aliases="none"> <maml:name>MobilityGroup</maml:name> <maml:Description> <maml:para>Specifies a full mobility group definition.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMobilityGroup</command:parameterValue> <dev:type> <maml:name>HCXMobilityGroup</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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.Hcx.Types.V1.HCXMobilityGroup</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.Hcx.Types.V1.HCXMobilityGroup</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>Start-HCXMobilityGroupMigration -Id "mobilityGroupId"</dev:code> <dev:remarks> <maml:para>Starts migrations of all virtual machines in the mobility group with a specified ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Start-HCXMobilityGroupMigration -MobilityGroup $mobilityGroup</dev:code> <dev:remarks> <maml:para>Starts migrations of all virtual machines in the specified mobility group.</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>Start-HCXReplication</command:name> <command:verb>Start</command:verb> <command:noun>HCXReplication</command:noun> <maml:description> <maml:para>This cmdlet starts an HCX replication.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet starts an HCX replication.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-HCXReplication</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Replication</maml:name> <maml:Description> <maml:para>Specifies the list of replication requests. If you want to retrieve a replication request, use the New-HCXReplication cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXReplication[]</command:parameterValue> <dev:type> <maml:name>HCXReplication[]</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="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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="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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Replication</maml:name> <maml:Description> <maml:para>Specifies the list of replication requests. If you want to retrieve a replication request, use the New-HCXReplication cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXReplication[]</command:parameterValue> <dev:type> <maml:name>HCXReplication[]</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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.Hcx.Types.V1.HCXReplication[]</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.Hcx.Types.V1.HCXReplication</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>Start-HCXReplication -Replication $myReplication</dev:code> <dev:remarks> <maml:para>Starts the replication task.</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>Stop-HCXMobilityGroupMigration</command:name> <command:verb>Stop</command:verb> <command:noun>HCXMobilityGroupMigration</command:noun> <maml:description> <maml:para>This cmdlet stops the migration of all virtual machines in the mobility group.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet stops the migration of all virtual machines in the mobility group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-HCXMobilityGroupMigration</maml:name> <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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the ID of the mobility group that you can use to identify any particular group.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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>Stop-HCXMobilityGroupMigration</maml:name> <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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>MobilityGroup</maml:name> <maml:Description> <maml:para>Specifies the full mobility group definition.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMobilityGroup</command:parameterValue> <dev:type> <maml:name>HCXMobilityGroup</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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="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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Specifies the ID of the mobility group that you can use to identify any particular group.</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="True (ByValue)" position="named" aliases="none"> <maml:name>MobilityGroup</maml:name> <maml:Description> <maml:para>Specifies the full mobility group definition.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMobilityGroup</command:parameterValue> <dev:type> <maml:name>HCXMobilityGroup</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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.Hcx.Types.V1.HCXMobilityGroup</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.Hcx.Types.V1.HCXMobilityGroup</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>Stop-HCXMobilityGroupMigration -Id "mobilityGroupId"</dev:code> <dev:remarks> <maml:para>This cmdlet stops the migration of all virtual machines in the mobility group with a specified ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Stop-HCXMobilityGroupMigration -MobilityGroup $mobilityGroup</dev:code> <dev:remarks> <maml:para>This cmdlet stops the migration of all virtual machines in the specified mobility group.</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>Suspend-HCXReplication</command:name> <command:verb>Suspend</command:verb> <command:noun>HCXReplication</command:noun> <maml:description> <maml:para>This cmdlet suspends an existing HCX replication.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet suspends an existing HCX replication. This pauses the synchronization of data from a source to destination at the specified RPO.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Suspend-HCXReplication</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Replication</maml:name> <maml:Description> <maml:para>Specifies the replication that you want to suspend. To retrieve a replication, use the Get-HCXReplication cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXReplication[]</command:parameterValue> <dev:type> <maml:name>HCXReplication[]</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="true" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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="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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Replication</maml:name> <maml:Description> <maml:para>Specifies the replication that you want to suspend. To retrieve a replication, use the Get-HCXReplication cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXReplication[]</command:parameterValue> <dev:type> <maml:name>HCXReplication[]</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="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.Hcx.Types.V1.HCXReplication[]</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.Hcx.Types.V1.HCXJob</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>Suspend-HCXReplication -Replication $myReplication</dev:code> <dev:remarks> <maml:para>Suspends the replication.</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>Test-HCXMigration</command:name> <command:verb>Test</command:verb> <command:noun>HCXMigration</command:noun> <maml:description> <maml:para>This cmdlet validates an HCX migration request.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet validates an HCX (Hybrid Cloud Extension) migration request that you can use to start a migration process.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-HCXMigration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Migration</maml:name> <maml:Description> <maml:para>Specifies the list of migration requests. If you want to retrieve a migration request, use the New-HCXMigration cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMigration[]</command:parameterValue> <dev:type> <maml:name>HCXMigration[]</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="0" aliases="none"> <maml:name>Migration</maml:name> <maml:Description> <maml:para>Specifies the list of migration requests. If you want to retrieve a migration request, use the New-HCXMigration cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMigration[]</command:parameterValue> <dev:type> <maml:name>HCXMigration[]</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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.Hcx.Types.V1.HCXMigration[]</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.Hcx.Types.V1.HCXMigrationValidationResult[]</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>Test-HCXMigration -Migration $migration1,$migration2</dev:code> <dev:remarks> <maml:para>Validates a list of migration requests.</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>Test-HCXMobilityGroup</command:name> <command:verb>Test</command:verb> <command:noun>HCXMobilityGroup</command:noun> <maml:description> <maml:para>This cmdlet validates an HCX mobility group object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet validates an HCX mobility group object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-HCXMobilityGroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>GroupConfiguration</maml:name> <maml:Description> <maml:para>Specifies a common set of configurations that you can apply to all virtual machines in a group while doing the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMobilityGroupConfiguration</command:parameterValue> <dev:type> <maml:name>HCXMobilityGroupConfiguration</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>Migration</maml:name> <maml:Description> <maml:para>Specifies the array of a virtual machine and its configurations that are part of the mobility group.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMobilityGroupMigration[]</command:parameterValue> <dev:type> <maml:name>HCXMobilityGroupMigration[]</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 mobility group.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-HCXMobilityGroup</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 ID of the mobility group which you can use to identify any group uniquely.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-HCXMobilityGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MobilityGroup</maml:name> <maml:Description> <maml:para>Specifies a full mobility group definition.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMobilityGroup</command:parameterValue> <dev:type> <maml:name>HCXMobilityGroup</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="True (ByValue)" position="named" aliases="none"> <maml:name>GroupConfiguration</maml:name> <maml:Description> <maml:para>Specifies a common set of configurations that you can apply to all virtual machines in a group while doing the migration.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMobilityGroupConfiguration</command:parameterValue> <dev:type> <maml:name>HCXMobilityGroupConfiguration</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>Id</maml:name> <maml:Description> <maml:para>Specifies the ID of the mobility group which you can use to identify any group uniquely.</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>Migration</maml:name> <maml:Description> <maml:para>Specifies the array of a virtual machine and its configurations that are part of the mobility group.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMobilityGroupMigration[]</command:parameterValue> <dev:type> <maml:name>HCXMobilityGroupMigration[]</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>MobilityGroup</maml:name> <maml:Description> <maml:para>Specifies a full mobility group definition.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXMobilityGroup</command:parameterValue> <dev:type> <maml:name>HCXMobilityGroup</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 mobility group.</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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.Hcx.Types.V1.HCXMobilityGroupConfiguration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXMobilityGroupMigration[]</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.Hcx.Types.V1.HCXMobilityGroup</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>Test-HCXMobilityGroup -Name "mobilityGroupName"</dev:code> <dev:remarks> <maml:para>Validates the mobility group configurations for a given mobility group name. You must create the mobility group before validating with the Name parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Test-HCXMobilityGroup -MobilityGroup $mobilityGroup</dev:code> <dev:remarks> <maml:para>Validates the specified mobility group configurations.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Test-HCXMobilityGroup -Id "mobilityGroupId"</dev:code> <dev:remarks> <maml:para>Validates the mobility group configurations for the given mobility group ID. You must create the mobility group before validating with the Id parameter.</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>Test-HCXReplication</command:name> <command:verb>Test</command:verb> <command:noun>HCXReplication</command:noun> <maml:description> <maml:para>This cmdlet validates an HCX replication request.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet validates an HCX replication request returned by the New-HCXReplication cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-HCXReplication</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Replication</maml:name> <maml:Description> <maml:para>Specifies the replication that you want to validate. If you want to retrieve a replication request, use the New-HCXReplication cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXReplication[]</command:parameterValue> <dev:type> <maml:name>HCXReplication[]</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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="0" aliases="none"> <maml:name>Replication</maml:name> <maml:Description> <maml:para>Specifies the replication that you want to validate. If you want to retrieve a replication request, use the New-HCXReplication cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXReplication[]</command:parameterValue> <dev:type> <maml:name>HCXReplication[]</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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.Hcx.Types.V1.HCXReplication[]</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.Hcx.Types.V1.HCXReplicationValidationResult</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>Test-HCXReplication -Replication $myReplication1, $myReplication2</dev:code> <dev:remarks> <maml:para>Validates a list of replication requests.</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>Uninstall-HCXSentinel</command:name> <command:verb>Uninstall</command:verb> <command:noun>HCXSentinel</command:noun> <maml:description> <maml:para>This cmdlet uninstalls the sentinel from a virtual machine.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet uninstalls the sentinel software running on the source virtual machine.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Uninstall-HCXSentinel</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>VM</maml:name> <maml:Description> <maml:para>Specifies the ID of the virtual machine where the sentinel software runs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXVM</command:parameterValue> <dev:type> <maml:name>HCXVM</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>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>VM</maml:name> <maml:Description> <maml:para>Specifies the ID of the virtual machine where the sentinel software runs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXVM</command:parameterValue> <dev:type> <maml:name>HCXVM</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>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.Hcx.Types.V1.HCXJob</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>$site=Get-HCXSite -Type "Sentinel" $vm=Get-HCXVM -Name $vmName -Site $site Uninstall-HCXSentinel -VM $vm</dev:code> <dev:remarks> <maml:para>Retrieves the source site by type.</maml:para> <maml:para>Uninstalls the sentinel software that runs on the virtual machine.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$site=Get-HCXSite -Name "Non vSphere Inventory" $vm=Get-HCXVM -Name $vmName -Site $site Uninstall-HCXSentinel -VM $vm</dev:code> <dev:remarks> <maml:para>Retrieves the source site by Name</maml:para> <maml:para>Uninstalls the sentinel software that runs on the virtual machine.</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>Update-HCXSentinel</command:name> <command:verb>Update</command:verb> <command:noun>HCXSentinel</command:noun> <maml:description> <maml:para>This cmdlet upgrades the HCX sentinel software running on the source virtual machine.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet upgrades the HCX sentinel software running on the source virtual machine.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-HCXSentinel</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>VM</maml:name> <maml:Description> <maml:para>Specifies the list of virtual machine IDs where the sentinel software runs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXVM[]</command:parameterValue> <dev:type> <maml:name>HCXVM[]</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>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>VM</maml:name> <maml:Description> <maml:para>Specifies the list of virtual machine IDs where the sentinel software runs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXVM[]</command:parameterValue> <dev:type> <maml:name>HCXVM[]</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>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.Hcx.Types.V1.HCXSentinelUpgrade</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>$site = Get-HCXSite -Type Sentinel $vm = Get-HCXVM -Name $vmName -Site $site $update = Update-HCXSentinel -VM $vm Wait-HCXJob -Job $update</dev:code> <dev:remarks> <maml:para>Retrieves the source site by type.</maml:para> <maml:para>Upgrades the VMware HCX Sentinel software that runs on the source virtual machine.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$site=Get-HCXSite -Name "Non vSphere Inventory" $vm=Get-HCXVM -Name $vmName -Site $site $update = Update-HCXSentinel -VM $vm Wait-HCXJob -Job $update</dev:code> <dev:remarks> <maml:para>Retrieves the source site by name.</maml:para> <maml:para>Upgrades the VMware HCX Sentinel software that runs on the source virtual machine.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$site = Get-HCXSite -Type Sentinel $vm = Get-HCXVM -Site $site $update = Update-HCXSentinel -VM $vm Wait-HCXJob -Job $update</dev:code> <dev:remarks> <maml:para>Retrieves the source site by type.</maml:para> <maml:para>Upgrades VMware HCX Sentinel software running on one or more source virtual machine.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>$site=Get-HCXSite -Name "Non vSphere Inventory" $vm=Get-HCXVM -Site $site $update = Update-HCXSentinel -VM $vm Wait-HCXJob -Job $update</dev:code> <dev:remarks> <maml:para>Retrieves the source site by name.</maml:para> <maml:para>Upgrades VMware HCX Sentinel software running on one or more source virtual machine.</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>Wait-HCXJob</command:name> <command:verb>Wait</command:verb> <command:noun>HCXJob</command:noun> <maml:description> <maml:para>This cmdlet waits for the job to complete.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet waits for the job to complete. The cmdlet blocks the execution of PowerShell until all specified jobs are completed successfully, failed, or times out.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Wait-HCXJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Job</maml:name> <maml:Description> <maml:para>Specifies the HCX job for which you want to wait to complete.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXJob[]</command:parameterValue> <dev:type> <maml:name>HCXJob[]</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Timeout</maml:name> <maml:Description> <maml:para>Specifies the time in milliseconds seconds.</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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Job</maml:name> <maml:Description> <maml:para>Specifies the HCX job for which you want to wait to complete.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HCXJob[]</command:parameterValue> <dev:type> <maml:name>HCXJob[]</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 HCX Server systems 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-HCXServer cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">HcxServer[]</command:parameterValue> <dev:type> <maml:name>HcxServer[]</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>Timeout</maml:name> <maml:Description> <maml:para>Specifies the time in milliseconds seconds.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Hcx.Types.V1.HCXJob[]</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>Wait-HCXJob -Job $job</dev:code> <dev:remarks> <maml:para>Waits for the job to complete.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |