netcoreapp3.1/VMware.Sdk.Vr.Cmdlets.dll-Help.xml
|
<?xml version="1.0" encoding="us-ascii"?>
<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-VrServer</command:name> <command:verb>Connect</command:verb> <command:noun>VrServer</command:noun> <maml:description> <maml:para>This cmdlet establishes a connection to a VMware vSphere Replication (VR) Management server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet establishes a connection to a VMware vSphere Replication (VR) Management server. The resulting connections are added to the list of default connections in a global variable named "$global:defaultVrConnections" (if the NotDefault switch was not specified). A VR deployment typically consists of two sites - a local site and a remote site. Replications are also possible within the same vCenter Server system. Most operations require that you are logged in to both sites. To connect to the remote site, specify the RemoteUser\RemotePassword or the RemoteCredential parameters. (For replications within the same vCenter Server you log in to the local site only.) The cmdlet output is a VrServer object. For most operations, you need the IDs of the pairings between your local and remote sites. You can find these IDs in the ConnectedPairings property of the VrServer object. You can find these IDs in the ConnectedPairings property of the VrServerVrServer object. It contains the user, authenticated against the remote site, and a Pair object, containing all IDs of the corresponding Pairing. When connecting to the local site only, the pairing within the same vCenter Server is already available in the ConnectedPairings property. To invoke API operations on a VR server, use the Invoke- cmdlets. Some VR SDK cmdlets accept parameters, which are complex objects. To create these complex objects use the Initialize- cmdlets.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-VrServer</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 address or fully qualified domain name (FQDN) of the local VR 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="Username"> <maml:name>User</maml:name> <maml:description> <maml:para>Specifies the user name to log in to the local vCenter Server.</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>Password</maml:name> <maml:description> <maml:para>Specifies the password to log in to the local vCenter Server.</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>Credential</maml:name> <maml:description> <maml:para>Specifies the credentials to log in to the local vCenter Server. You can use this parameter as an alternative to the User/Password parameter pair.</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>IgnoreInvalidCertificate</maml:name> <maml:description> <maml:para>If specified, PowerCLI ignores any errors related to invalid server certificates of the VR server.</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>Port</maml:name> <maml:description> <maml:para>Specifies the port on the server you want to use for the connection. If not specified, a protocol-specific default value is used.</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>Protocol</maml:name> <maml:description> <maml:para>Specifies the Internet protocol you want to use for the connection. It can be either HTTP or HTTPS. If not specified, HTTPS is used.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">http</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">https</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NotDefault</maml:name> <maml:description> <maml:para>If specified, the resulting connection is not recorded in the list of default SRM server connections and must be manually specified when you use a 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>ApiVersion</maml:name> <maml:description> <maml:para>By default, the cmdlet uses the SRM API version on which the Powercli.Sdk.Vr module is built. If this API version is unavailable on the server, the cmdlet chooses the closest available version. If the Powercli.Sdk.Vr module is built against a version later than all available API versions, then the latest available API version is used. If the Powercli.Sdk.Vr module is built against a version older than all available API versions, then the oldest available API version is used. If you want to override the selected version you can specify desired API version with this parameter.</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-VrServer</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 address or fully qualified domain name (FQDN) of the local VR 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="Username"> <maml:name>User</maml:name> <maml:description> <maml:para>Specifies the user name to log in to the local vCenter Server.</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>Password</maml:name> <maml:description> <maml:para>Specifies the password to log in to the local vCenter Server.</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>Credential</maml:name> <maml:description> <maml:para>Specifies the credentials to log in to the local vCenter Server. You can use this parameter as an alternative to the User/Password parameter pair.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RemoteServer</maml:name> <maml:description> <maml:para>Specifies the remote vCenter Server 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="RemoteUsername"> <maml:name>RemoteUser</maml:name> <maml:description> <maml:para>Specifies the user name to log in to the remote vCenter Server.</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>RemotePassword</maml:name> <maml:description> <maml:para>Specifies the password to log in to the remote vCenter Server.</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>RemoteCredential</maml:name> <maml:description> <maml:para>Specifies the credentials to log in to the remote vCenter server. You can use this parameter as an alternative to the RemoteUser/RemotePassword parameter pair.</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>IgnoreInvalidCertificate</maml:name> <maml:description> <maml:para>If specified, PowerCLI ignores any errors related to invalid server certificates of the VR server.</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>Port</maml:name> <maml:description> <maml:para>Specifies the port on the server you want to use for the connection. If not specified, a protocol-specific default value is used.</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>Protocol</maml:name> <maml:description> <maml:para>Specifies the Internet protocol you want to use for the connection. It can be either HTTP or HTTPS. If not specified, HTTPS is used.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">http</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">https</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NotDefault</maml:name> <maml:description> <maml:para>If specified, the resulting connection is not recorded in the list of default SRM server connections and must be manually specified when you use a 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>ApiVersion</maml:name> <maml:description> <maml:para>By default, the cmdlet uses the SRM API version on which the Powercli.Sdk.Vr module is built. If this API version is unavailable on the server, the cmdlet chooses the closest available version. If the Powercli.Sdk.Vr module is built against a version later than all available API versions, then the latest available API version is used. If the Powercli.Sdk.Vr module is built against a version older than all available API versions, then the oldest available API version is used. If you want to override the selected version you can specify desired API version with this parameter.</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-VrServer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>LocalServer</maml:name> <maml:description> <maml:para>Specifies the VrServer of the local site for which you want to authenticate against the new remote site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VrServer</command:parameterValue> <dev:type> <maml:name>VrServer</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>RemoteServer</maml:name> <maml:description> <maml:para>Specifies the remote vCenter Server 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="RemoteUsername"> <maml:name>RemoteUser</maml:name> <maml:description> <maml:para>Specifies the user name to log in to the remote vCenter Server.</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>RemotePassword</maml:name> <maml:description> <maml:para>Specifies the password to log in to the remote vCenter Server.</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>RemoteCredential</maml:name> <maml:description> <maml:para>Specifies the credentials to log in to the remote vCenter server. You can use this parameter as an alternative to the RemoteUser/RemotePassword parameter pair.</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:syntaxItem> </command:syntax> <command:parameters> <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 address or fully qualified domain name (FQDN) of the local VR 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="Username"> <maml:name>User</maml:name> <maml:description> <maml:para>Specifies the user name to log in to the local vCenter Server.</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>Password</maml:name> <maml:description> <maml:para>Specifies the password to log in to the local vCenter Server.</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>Credential</maml:name> <maml:description> <maml:para>Specifies the credentials to log in to the local vCenter Server. You can use this parameter as an alternative to the User/Password parameter pair.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RemoteServer</maml:name> <maml:description> <maml:para>Specifies the remote vCenter Server 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="RemoteUsername"> <maml:name>RemoteUser</maml:name> <maml:description> <maml:para>Specifies the user name to log in to the remote vCenter Server.</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>RemotePassword</maml:name> <maml:description> <maml:para>Specifies the password to log in to the remote vCenter Server.</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>RemoteCredential</maml:name> <maml:description> <maml:para>Specifies the credentials to log in to the remote vCenter server. You can use this parameter as an alternative to the RemoteUser/RemotePassword parameter pair.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>LocalServer</maml:name> <maml:description> <maml:para>Specifies the VrServer of the local site for which you want to authenticate against the new remote site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VrServer</command:parameterValue> <dev:type> <maml:name>VrServer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IgnoreInvalidCertificate</maml:name> <maml:description> <maml:para>If specified, PowerCLI ignores any errors related to invalid server certificates of the VR server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="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. If not specified, a protocol-specific default value is used.</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>Protocol</maml:name> <maml:description> <maml:para>Specifies the Internet protocol you want to use for the connection. It can be either HTTP or HTTPS. If not specified, HTTPS is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NotDefault</maml:name> <maml:description> <maml:para>If specified, the resulting connection is not recorded in the list of default SRM server connections and must be manually specified when you use a 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>ApiVersion</maml:name> <maml:description> <maml:para>By default, the cmdlet uses the SRM API version on which the Powercli.Sdk.Vr module is built. If this API version is unavailable on the server, the cmdlet chooses the closest available version. If the Powercli.Sdk.Vr module is built against a version later than all available API versions, then the latest available API version is used. If the Powercli.Sdk.Vr module is built against a version older than all available API versions, then the oldest available API version is used. If you want to override the selected version you can specify desired API version with this parameter.</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.Sdk.OpenApi.Cmdlets.IServerConnection</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>PS C:\> Connect-VrServer -Server MyLocalVR.com -User "MyLocalVcUser" -Password "MyLocalVcPassword" Connects to a VR server with a MyLocalVR.com address by passing a valid vCenter Server user name and password.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Connect-VrServer -Server MyVrLocal.com -User "MyLocalVcUser" -Password "MyLocalVcPassword" -RemoteServer MyRemoteVCName -RemoteUser "MyRemoteVcUser" -RemotePassword "MyRemoteVcPassword" Connects to a local VR server with the specified address and authenticates to a remote VR server by passing the vCenter Server name and the RemoteUser/RemotePassword for the remote vCenter Server.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> $myRemoteVc = "MyRemoteVCName" PS C:\> $myVrServer = Connect-VrServer -Server MyVrLocal.com -User "MyLocalVcUser" -Password "MyLocalVcPassword" -RemoteServer $myRemoteVc -RemoteUser "MyRemoteVcUser" -RemotePassword "MyRemoteVcPassword" PS C:\> Invoke-VrGetVrCapableTargetDatastores -PairingId $myVrServer.ConnectedPairings[$myRemoteVc].Pairing.PairingId -VcenterId $myVrServer.ConnectedPairings[$myRemoteVc].Pairing.RemoteVcServer.Id.Guid Connect to the specified local VR server and authenticates to the specified remote VC pair. Retrieves the capable target datastores on the remote vCenter Server.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> $myVrServer = Connect-VrServer -Server MyVrLocal.com -User "MyLocalVcUser" -Password "MyLocalVcPassword" PS C:\> Connect-VrServer -LocalServer $myVrServer -RemoteServer "MyRemoteVCName" -RemoteUser "MyRemoteVcUser" -RemotePassword "MyRemoteVcPassword" Connects to the specified local VR server and authenticates to the specified remote VC pair by passing the vCenter Server name and the RemoteUser/RemotePassword for the remote vCenter Server.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>PS C:\> Connect-VrServer -Server MyVrLocal.com -User "MyLocalVcUser" -Password "MyLocalVcPassword" -RemoteServer MyRemoteVCName -RemoteUser "MyRemoteVcUser" -RemotePassword "MyRemoteVcPassword" -ApiVersion v1 Connects to the specified local VR server and authenticates to the specified remote VC pair by passing the vCenter Server name the RemoteUser/RemotePassword for the remote vCenter Server. Overrides the automatic VR API version selection by specifying the "v1" API version.</dev:code> <dev:remarks> <maml:para></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>Invoke-VrDeleteVrPairing</command:name> <command:verb>Invoke</command:verb> <command:noun>VrDeleteVrPairing</command:noun> <maml:description> <maml:para>Delete the existing pairing with the remote vSphere Replication Management server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete the existing pairing with the remote vSphere Replication Management server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrDeleteVrPairing</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Whether or not to perform a single-sided break pair operation. This should be true if remote vSphere Replication server is not available anymore and you want to remove the pairing information from the current site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Whether or not to perform a single-sided break pair operation. This should be true if remote vSphere Replication server is not available anymore and you want to remove the pairing information from the current site.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.TaskDrResponseEntity</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>Invoke-VrDeleteVrPairing -pairingId "pairingId_example" -force $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrDeleteVrPairing with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrDeleteVrPairing -pairingId "pairingId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrDeleteVrPairing with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/delete//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetAllVrDetailsInPairing</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetAllVrDetailsInPairing</command:noun> <maml:description> <maml:para>Get information about vSphere Replication servers that are paired.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get information about vSphere Replication servers that are paired.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetAllVrDetailsInPairing</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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.Bindings.Vr.Model.VrmsInfoDrResponseList</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>Invoke-VrGetAllVrDetailsInPairing -pairingId "pairingId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetAllVrDetailsInPairing with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetAllVrDetailsInPairing -pairingId "pairingId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetAllVrDetailsInPairing with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/vrs/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetAllVrServersInPairing</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetAllVrServersInPairing</command:noun> <maml:description> <maml:para>Get all registered replication servers for a vSphere Replication in a pairing.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get all registered replication servers for a vSphere Replication in a pairing.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetAllVrServersInPairing</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VrId</maml:name> <maml:Description> <maml:para>The ID of the VRMS</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VrId</maml:name> <maml:Description> <maml:para>The ID of the VRMS</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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.Bindings.Vr.Model.ReplicationServerInfoDrResponseList</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>Invoke-VrGetAllVrServersInPairing -pairingId "pairingId_example" -vrId "vrId_example" -filterProperty "filterProperty_example" -filter "Myfilter" -sortBy name -orderBy "orderBy_example" -limit 10 -offset 10 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetAllVrServersInPairing with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetAllVrServersInPairing -pairingId "pairingId_example" -vrId "vrId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetAllVrServersInPairing with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/vrs/vr_id/replication-servers/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetVrInfoInPairing</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetVrInfoInPairing</command:noun> <maml:description> <maml:para>Get information about a specific vSphere Replication Management Server in a pairing.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get information about a specific vSphere Replication Management Server in a pairing.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetVrInfoInPairing</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VrId</maml:name> <maml:Description> <maml:para>The ID of the VRMS</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VrId</maml:name> <maml:Description> <maml:para>The ID of the VRMS</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.Bindings.Vr.Model.VrmsInfoDrResponseEntity</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>Invoke-VrGetVrInfoInPairing -pairingId "pairingId_example" -vrId "vrId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVrInfoInPairing with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetVrInfoInPairing -pairingId "pairingId_example" -vrId "vrId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVrInfoInPairing with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/vrs/vr_id/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetVrPairing</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetVrPairing</command:noun> <maml:description> <maml:para>Get information about the pairing.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get information about the pairing.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetVrPairing</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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.Bindings.Vr.Model.PairingDrResponseEntity</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>Invoke-VrGetVrPairing -pairingId "pairingId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVrPairing with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetVrPairing -pairingId "pairingId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVrPairing with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetVrPairingIssues</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetVrPairingIssues</command:noun> <maml:description> <maml:para>Get all issues for the pairing.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get all issues for the pairing.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetVrPairingIssues</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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.Bindings.Vr.Model.IssueInfoDrResponseList</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>Invoke-VrGetVrPairingIssues -pairingId "pairingId_example" -filterProperty "filterProperty_example" -filter "Myfilter" -sortBy name -orderBy "orderBy_example" -limit 10 -offset 10 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVrPairingIssues with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetVrPairingIssues -pairingId "pairingId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVrPairingIssues with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/issues/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetVrPairings</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetVrPairings</command:noun> <maml:description> <maml:para>Get a list of all existing pairings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a list of all existing pairings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetVrPairings</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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.Bindings.Vr.Model.PairingDrResponseList</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>Invoke-VrGetVrPairings -filterProperty "filterProperty_example" -filter "Myfilter" -sortBy name -orderBy "orderBy_example" -limit 10 -offset 10 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVrPairings with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetVrPairings </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVrPairings with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetVrServerInPairing</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetVrServerInPairing</command:noun> <maml:description> <maml:para>Get information about a registered vSphere Replication server for a VRMS, which is part of a pairing.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get information about a registered vSphere Replication server for a VRMS, which is part of a pairing.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetVrServerInPairing</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VrId</maml:name> <maml:Description> <maml:para>The ID of the VRMS</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" aliases="none"> <maml:name>ReplicationServerId</maml:name> <maml:Description> <maml:para>The ID of the vSphere Replication server</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VrId</maml:name> <maml:Description> <maml:para>The ID of the VRMS</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" aliases="none"> <maml:name>ReplicationServerId</maml:name> <maml:Description> <maml:para>The ID of the vSphere Replication server</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.Bindings.Vr.Model.ReplicationServerInfoDrResponseEntity</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>Invoke-VrGetVrServerInPairing -pairingId "pairingId_example" -vrId "vrId_example" -replicationServerId "replicationServerId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVrServerInPairing with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetVrServerInPairing -pairingId "pairingId_example" -vrId "vrId_example" -replicationServerId "replicationServerId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVrServerInPairing with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/vrs/vr_id/replication-servers/replication_server_id/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrPairVr</command:name> <command:verb>Invoke</command:verb> <command:noun>VrPairVr</command:noun> <maml:description> <maml:para>Pair to the remote vSphere Replication Management Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Pair to the remote vSphere Replication Management Server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrPairVr</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingSpec</maml:name> <maml:Description> <maml:para>Pair the remote server spec</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.PairingSpec</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.PairingSpec</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" aliases="none"> <maml:name>PairingSpec</maml:name> <maml:Description> <maml:para>Pair the remote server spec</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.PairingSpec</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.PairingSpec</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.Bindings.Vr.Model.TaskDrResponseEntity</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>$PairingSpecPairPscInfo = Initialize-VrPairingSpecPairPscInfo -Url "MyUrl" -Port 0 -Thumbprint "MyThumbprint" -Username "MyUsername" -Password "MyPassword" $PairingSpec = Initialize-VrPairingSpec -PairPscInfo $PairingSpecPairPscInfo -PairVcId "MyPairVcId" Invoke-VrPairVr -pairingSpec $pairingSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrPairVr with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PairingSpecPairPscInfo = Initialize-VrPairingSpecPairPscInfo $PairingSpec = Initialize-VrPairingSpec -PairPscInfo $PairingSpecPairPscInfo -PairVcId "MyPairVcId" Invoke-VrPairVr -pairingSpec $pairingSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrPairVr with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VrPairingSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrReconnectVrPairing</command:name> <command:verb>Invoke</command:verb> <command:noun>VrReconnectVrPairing</command:noun> <maml:description> <maml:para>Reconnect the existing pairing to the remote vSphere Replication Management Server (VRMS).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Reconnect the existing pairing to the remote vSphere Replication Management Server (VRMS).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrReconnectVrPairing</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>PairingSpec</maml:name> <maml:Description> <maml:para>Reconnect with the remote server spec.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.PairingSpec</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.PairingSpec</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>PairingSpec</maml:name> <maml:Description> <maml:para>Reconnect with the remote server spec.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.PairingSpec</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.PairingSpec</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.Bindings.Vr.Model.TaskDrResponseEntity</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>$PairingSpecPairPscInfo = Initialize-VrPairingSpecPairPscInfo -Url "MyUrl" -Port 0 -Thumbprint "MyThumbprint" -Username "MyUsername" -Password "MyPassword" $PairingSpec = Initialize-VrPairingSpec -PairPscInfo $PairingSpecPairPscInfo -PairVcId "MyPairVcId" Invoke-VrReconnectVrPairing -pairingId "pairingId_example" -pairingSpec $pairingSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrReconnectVrPairing with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PairingSpecPairPscInfo = Initialize-VrPairingSpecPairPscInfo $PairingSpec = Initialize-VrPairingSpec -PairPscInfo $PairingSpecPairPscInfo -PairVcId "MyPairVcId" Invoke-VrReconnectVrPairing -pairingId "pairingId_example" -pairingSpec $pairingSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrReconnectVrPairing with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/actions/reconnect/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VrPairingSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrReconnectVrServerInPairing</command:name> <command:verb>Invoke</command:verb> <command:noun>VrReconnectVrServerInPairing</command:noun> <maml:description> <maml:para>Update the connection information for this vSphere Replication server and reset any current connection for a vSphere Replication in a pairing.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update the connection information for this vSphere Replication server and reset any current connection for a vSphere Replication in a pairing.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrReconnectVrServerInPairing</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VrId</maml:name> <maml:Description> <maml:para>The ID of the VRMS</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" aliases="none"> <maml:name>ReplicationServerId</maml:name> <maml:Description> <maml:para>The ID of the vSphere Replication server</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VrId</maml:name> <maml:Description> <maml:para>The ID of the VRMS</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" aliases="none"> <maml:name>ReplicationServerId</maml:name> <maml:Description> <maml:para>The ID of the vSphere Replication server</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.Bindings.Vr.Model.TaskDrResponseEntity</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>Invoke-VrReconnectVrServerInPairing -pairingId "pairingId_example" -vrId "vrId_example" -replicationServerId "replicationServerId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrReconnectVrServerInPairing with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrReconnectVrServerInPairing -pairingId "pairingId_example" -vrId "vrId_example" -replicationServerId "replicationServerId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrReconnectVrServerInPairing with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/vrs/vr_id/replication-servers/replication_server_id/actions/reconnect/post//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrRegisterVrServerInPairing</command:name> <command:verb>Invoke</command:verb> <command:noun>VrRegisterVrServerInPairing</command:noun> <maml:description> <maml:para>Register a replication server for a vSphere Replication in a pairing.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Register a replication server for a vSphere Replication in a pairing.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrRegisterVrServerInPairing</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VrId</maml:name> <maml:Description> <maml:para>The ID of the VRMS</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" aliases="none"> <maml:name>StringDrData</maml:name> <maml:Description> <maml:para>ID of the replication server virtual machine.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.StringDrData</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.StringDrData</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VrId</maml:name> <maml:Description> <maml:para>The ID of the VRMS</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" aliases="none"> <maml:name>StringDrData</maml:name> <maml:Description> <maml:para>ID of the replication server virtual machine.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.StringDrData</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.StringDrData</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.Bindings.Vr.Model.TaskDrResponseEntity</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>$StringDrData = Initialize-VrStringDrData -Value "MyValue" Invoke-VrRegisterVrServerInPairing -pairingId "pairingId_example" -vrId "vrId_example" -stringDrData $stringDrData </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrRegisterVrServerInPairing with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$StringDrData = Initialize-VrStringDrData Invoke-VrRegisterVrServerInPairing -pairingId "pairingId_example" -vrId "vrId_example" -stringDrData $stringDrData </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrRegisterVrServerInPairing with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/vrs/vr_id/replication-servers/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VrStringDrData</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrUnregisterVrServerInPairing</command:name> <command:verb>Invoke</command:verb> <command:noun>VrUnregisterVrServerInPairing</command:noun> <maml:description> <maml:para>Unregister a vSphere Replication server for a vSphere Replication in a pairing.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Unregister a vSphere Replication server for a vSphere Replication in a pairing.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrUnregisterVrServerInPairing</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VrId</maml:name> <maml:Description> <maml:para>The ID of the VRMS</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" aliases="none"> <maml:name>ReplicationServerId</maml:name> <maml:Description> <maml:para>The ID of the vSphere Replication server</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VrId</maml:name> <maml:Description> <maml:para>The ID of the VRMS</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" aliases="none"> <maml:name>ReplicationServerId</maml:name> <maml:Description> <maml:para>The ID of the vSphere Replication server</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.Bindings.Vr.Model.TaskDrResponseEntity</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>Invoke-VrUnregisterVrServerInPairing -pairingId "pairingId_example" -vrId "vrId_example" -replicationServerId "replicationServerId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrUnregisterVrServerInPairing with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrUnregisterVrServerInPairing -pairingId "pairingId_example" -vrId "vrId_example" -replicationServerId "replicationServerId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrUnregisterVrServerInPairing with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/vrs/vr_id/replication-servers/replication_server_id/delete//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrBrowseDatastore</command:name> <command:verb>Invoke</command:verb> <command:noun>VrBrowseDatastore</command:noun> <maml:description> <maml:para>Browse the datastore that is defined in the URL by its ID. This API returns files that reside on the given datastore. These files are filtered based on the given search criteria.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Browse the datastore that is defined in the URL by its ID. This API returns files that reside on the given datastore. These files are filtered based on the given search criteria.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrBrowseDatastore</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VcenterId</maml:name> <maml:Description> <maml:para>The ID of the vCenter server</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" aliases="none"> <maml:name>DatastoreId</maml:name> <maml:Description> <maml:para>The ID of a 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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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" aliases="none"> <maml:name>DatastoreBrowserRequest</maml:name> <maml:Description> <maml:para>Search criteria to browse the datastore</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.DatastoreBrowserRequest</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.DatastoreBrowserRequest</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VcenterId</maml:name> <maml:Description> <maml:para>The ID of the vCenter server</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" aliases="none"> <maml:name>DatastoreId</maml:name> <maml:Description> <maml:para>The ID of a 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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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" aliases="none"> <maml:name>DatastoreBrowserRequest</maml:name> <maml:Description> <maml:para>Search criteria to browse the datastore</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.DatastoreBrowserRequest</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.DatastoreBrowserRequest</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.Bindings.Vr.Model.DatastoreBrowserResultDrResponseList</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>$DatastoreBrowserRequest = Initialize-VrDatastoreBrowserRequest -QueryType "VM_DISK" -BrowsePath "MyBrowsePath" -SubFolders $false Invoke-VrBrowseDatastore -pairingId "pairingId_example" -vcenterId "vcenterId_example" -datastoreId "datastoreId_example" -filterProperty "filterProperty_example" -filter "Myfilter" -sortBy name -orderBy "orderBy_example" -limit 10 -offset 10 -datastoreBrowserRequest $datastoreBrowserRequest </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrBrowseDatastore with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrBrowseDatastore -pairingId "pairingId_example" -vcenterId "vcenterId_example" -datastoreId "datastoreId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrBrowseDatastore with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/vcenters/vcenter_id/datastores/datastore_id/actions/browse/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VrDatastoreBrowserRequest</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrCheckStoragePolicyCompliance</command:name> <command:verb>Invoke</command:verb> <command:noun>VrCheckStoragePolicyCompliance</command:noun> <maml:description> <maml:para>Check datastores for compliance against a given storage policy.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Check datastores for compliance against a given storage policy.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrCheckStoragePolicyCompliance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VcenterId</maml:name> <maml:Description> <maml:para>The ID of the vCenter server</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" aliases="none"> <maml:name>StoragePolicyId</maml:name> <maml:Description> <maml:para>The ID of a storage policy</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" aliases="none"> <maml:name>RequestBody</maml:name> <maml:Description> <maml:para>List of datastores to check their compliance</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VcenterId</maml:name> <maml:Description> <maml:para>The ID of the vCenter server</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" aliases="none"> <maml:name>StoragePolicyId</maml:name> <maml:Description> <maml:para>The ID of a storage policy</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" aliases="none"> <maml:name>RequestBody</maml:name> <maml:Description> <maml:para>List of datastores to check their compliance</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<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.Bindings.Vr.Model.StoragePolicyComplianceCheckDataDrResponseList</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>Invoke-VrCheckStoragePolicyCompliance -pairingId "pairingId_example" -vcenterId "vcenterId_example" -storagePolicyId "storagePolicyId_example" -requestBody "MyrequestBody" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrCheckStoragePolicyCompliance with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrCheckStoragePolicyCompliance -pairingId "pairingId_example" -vcenterId "vcenterId_example" -storagePolicyId "storagePolicyId_example" -requestBody "MyrequestBody" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrCheckStoragePolicyCompliance with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/vcenters/vcenter_id/storage-policies/storage_policy_id/actions/check-compliance/post//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrConfigureReplication</command:name> <command:verb>Invoke</command:verb> <command:noun>VrConfigureReplication</command:noun> <maml:description> <maml:para>Configure replication for a virtual machine from a source site to a target vCenter Server site.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use this workflow to configure a replication.<br/><hr>1. Search for VMs that are suitable for a replication.<br/><code>GET /{pairing_id}/vcenters/{vcenter_id}/vms</code><br/>&ensp;- Query parameter suitable_for_replication should be true<br/>2. Choose VMs.<br/>3. For each VM, get disks:<br/><code>GET /{pairing_id}/vcenters/{vcenter_id}/vms/{vm_id}/disks</code><br/>4. Optionally, for each VM, check capabilities if replication is supported and what are the supported replication settings:<br/><code>GET /{pairing_id}/vcenters/{vcenter_id}/vms/{vm_id}/capability</code><br/>5. Request storage policies at the target vCenter Server:<br/><code>GET /{pairing_id}/vcenters/{vcenter_id}/storage-policies</code><br/>6. Choose a storage policy. If default storage policy will be used, then set destination_storage_policy_id in the resulting ConfigureReplicationSpec to null.<br/>7. Search for possible target datastores at the target vCenter Server:<br/><code>GET /{pairing_id}/vcenters/{vcenter_id}/datastores</code><br/>8. Choose a target datastore.<br/>9. Optionally check the selected target datastore's compliance against the selected target storage policy.<br/><code>POST /{pairing_id}/vcenters/{vcenter_id}/storage-policies/{storage_policy_id}/actions/check-compliance</code><br/>&ensp;- Pass the chosen datastore IDs as a body to the endpoint<br/>10. Optionally search for seeds at the target vCenter Server for the chosen target datastore from step 8:<br/>&ensp;a. <code>POST /{pairing_id}/vcenters/{vcenter_id}/datastores/{datastore_id}/actions/find-seeds</code><br/>&emsp;- Pass spec based on the VM disks retrieved in step 3<br/>&ensp;b. Or browse the datastore to select manually seed folder/file<br/><code>POST /{pairing_id}/vcenters/{vcenter_id}/datastores/{datastore_id}/actions/browse</code><br/>&emsp;- Pass spec for specific type and path of files/folders<br/>11. Construct ConfigureReplicationSpec.<br/>12. Create a replication.<br/><code>POST /{pairing_id}/replications</code></maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrConfigureReplication</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ConfigureReplicationSpec</maml:name> <maml:Description> <maml:para>List of replication settings to replicate VMs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vr.Model.ConfigureReplicationSpec></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vr.Model.ConfigureReplicationSpec></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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ConfigureReplicationSpec</maml:name> <maml:Description> <maml:para>List of replication settings to replicate VMs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vr.Model.ConfigureReplicationSpec></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vr.Model.ConfigureReplicationSpec></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.Bindings.Vr.Model.TaskDrResponseList</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>$DatastorePathData = Initialize-VrDatastorePathData -DatastoreId Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd -DatastoreName local-datastore -Path /path/to/folder -Filename vmDisk1.vmdk $VmDisk = Initialize-VrVmDisk -VmId VirtualMachine:vm-80:e594ad24-5f75-41e3-a276-88a2116dbed0 -DeviceKey 0 -IsVmHome $false -Encrypted $false -Capacity 0 -SourceDiskFormat "SAME_AS_SOURCE" -SourcePath $DatastorePathData -SourceStoragePolicyName "MySourceStoragePolicyName" -SourceStoragePolicyId dsbrowser.defaultStoragePolicy -Label "MyLabel" -ControllerKey 0 -ControllerLabel "MyControllerLabel" -SupportedForReplication $false $ConfigureReplicationVmDisk = Initialize-VrConfigureReplicationVmDisk -VmDisk $VmDisk -EnabledForReplication $false -UseSeeds $false -DestinationStoragePolicyId dsbrowser.defaultStoragePolicy -DestinationPath my_vm_seeds_folder/my_vm_disk_1.vmdk -DestinationDatastoreId Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd -DestinationDiskFormat "SAME_AS_SOURCE" $ConfigureReplicationSpec = Initialize-VrConfigureReplicationSpec -QuiesceEnabled $false -Rpo 0 -NetworkCompressionEnabled $false -MpitEnabled $false -MpitInstances 0 -MpitDays 0 -AutoReplicateNewDisks $false -TargetReplicationServerId HmsRemoteHbrServer:HBRSRV-1924009b-0562-433d-8db9-082141ac04cd:067878e6-2ff0-41eb-928c-5e91492a7b29 -LwdEncryptionEnabled $false -VmDataSetsReplicationEnabled $false -EnhancedReplication $false -Disks $ConfigureReplicationVmDisk -TargetVcId ff4a23e7-2fed-4be0-be39-479ae372badd -VmId VirtualMachine:vm-80:e594ad24-5f75-41e3-a276-88a2116dbed0 Invoke-VrConfigureReplication -pairingId "pairingId_example" -configureReplicationSpec $configureReplicationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrConfigureReplication with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrConfigureReplication -pairingId "pairingId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrConfigureReplication with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/replications/post//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrDemoteTestImage</command:name> <command:verb>Invoke</command:verb> <command:noun>VrDemoteTestImage</command:noun> <maml:description> <maml:para>Demote a test image.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove the promotion of the latest promoted test image associated with this group (if any) as an established promoted instance. The promoted instance is \"demoted\" to a regular group instance and becomes a candidate for pruning. Operation is available only on recovery site (for incoming replications)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrDemoteTestImage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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.Bindings.Vr.Model.TaskDrResponseEntity</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>Invoke-VrDemoteTestImage -pairingId "pairingId_example" -replicationId "replicationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrDemoteTestImage with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrDemoteTestImage -pairingId "pairingId_example" -replicationId "replicationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrDemoteTestImage with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/replications/replication_id/actions/demote-test-image/post//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrDestroyReplication</command:name> <command:verb>Invoke</command:verb> <command:noun>VrDestroyReplication</command:noun> <maml:description> <maml:para>Delete replication of a VM. The operation deletes the replication only on the local site. Remove the replication configuration first.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete replication of a VM. The operation deletes the replication only on the local site. Remove the replication configuration first.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrDestroyReplication</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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" aliases="none"> <maml:name>RetainReplicaDisks</maml:name> <maml:Description> <maml:para>Whether or not to retain replica disks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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" aliases="none"> <maml:name>RetainReplicaDisks</maml:name> <maml:Description> <maml:para>Whether or not to retain replica disks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.TaskDrResponseEntity</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>Invoke-VrDestroyReplication -pairingId "pairingId_example" -replicationId "replicationId_example" -retainReplicaDisks $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrDestroyReplication with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrDestroyReplication -pairingId "pairingId_example" -replicationId "replicationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrDestroyReplication with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/replications/replication_id/delete//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetActiveReplicationImage</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetActiveReplicationImage</command:noun> <maml:description> <maml:para>Get a details about the active replication image (point in time replica) for a given replication.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>There are two types of images: test-bubble and failover. A test-bubble image is expected to be reverted after any testing is completed. Optionally, it is possible to promote the image to a recovery image. A failover image will either be reverted or committed. Will return 404 Not Found in case there is no active replication image. Operation is available only on recovery site (for incoming replications).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetActiveReplicationImage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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.Bindings.Vr.Model.ReplicationImageDrResponseEntity</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>Invoke-VrGetActiveReplicationImage -pairingId "pairingId_example" -replicationId "replicationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetActiveReplicationImage with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetActiveReplicationImage -pairingId "pairingId_example" -replicationId "replicationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetActiveReplicationImage with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/replications/replication_id/active-image/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetAllPointInTimeInstances</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetAllPointInTimeInstances</command:noun> <maml:description> <maml:para>Get a list of all available consistent replicas (point in time instances) for a given replication.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a list of all available consistent replicas (point in time instances) for a given replication.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetAllPointInTimeInstances</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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.Bindings.Vr.Model.PointInTimeInstanceDrResponseList</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>Invoke-VrGetAllPointInTimeInstances -pairingId "pairingId_example" -replicationId "replicationId_example" -filterProperty "filterProperty_example" -filter "Myfilter" -sortBy name -orderBy "orderBy_example" -limit 10 -offset 10 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetAllPointInTimeInstances with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetAllPointInTimeInstances -pairingId "pairingId_example" -replicationId "replicationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetAllPointInTimeInstances with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/replications/replication_id/instances/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetAllReplications</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetAllReplications</command:noun> <maml:description> <maml:para>Get a list of all the incoming or outgoing replications from a vCenter Server. </maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a list of all the incoming or outgoing replications from a vCenter Server. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetAllReplications</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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" aliases="none"> <maml:name>SourceVcGuid</maml:name> <maml:Description> <maml:para>Filter replications by their source vCenter Server.</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" aliases="none"> <maml:name>ExtendedInfo</maml:name> <maml:Description> <maml:para>Requesting extended info for the replications might lead to slower API response. If false, the following fields will not be set or will have default value of 'false': configuration_error, last_group_error, recovery_error, last_sync_time, last_sync_duration, last_sync_size, recovery_solution, current_rpo_violation, quiescing_enabled, network_compression_enabled, encryption_enabled, mpit_enabled, mpit_instances, mpit_days, auto_replicate_new_disks_enabled, configuration_state, recovery_state, vm_data_sets_replication_enabled, sync_progress</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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" aliases="none"> <maml:name>SourceVcGuid</maml:name> <maml:Description> <maml:para>Filter replications by their source vCenter Server.</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" aliases="none"> <maml:name>ExtendedInfo</maml:name> <maml:Description> <maml:para>Requesting extended info for the replications might lead to slower API response. If false, the following fields will not be set or will have default value of 'false': configuration_error, last_group_error, recovery_error, last_sync_time, last_sync_duration, last_sync_size, recovery_solution, current_rpo_violation, quiescing_enabled, network_compression_enabled, encryption_enabled, mpit_enabled, mpit_instances, mpit_days, auto_replicate_new_disks_enabled, configuration_state, recovery_state, vm_data_sets_replication_enabled, sync_progress</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.ReplicationInfoDrResponseList</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>Invoke-VrGetAllReplications -pairingId "pairingId_example" -filterProperty "filterProperty_example" -filter "Myfilter" -sortBy name -orderBy "orderBy_example" -limit 10 -offset 10 -sourceVcGuid "sourceVcGuid_example" -extendedInfo $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetAllReplications with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetAllReplications -pairingId "pairingId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetAllReplications with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/replications/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetLocalVmDisks</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetLocalVmDisks</command:noun> <maml:description> <maml:para>Retrieve information about the disks of a VM.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve information about the disks of a VM.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetLocalVmDisks</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VcenterId</maml:name> <maml:Description> <maml:para>The ID of the vCenter server</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" aliases="none"> <maml:name>VmId</maml:name> <maml:Description> <maml:para>The ID of a VM</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VcenterId</maml:name> <maml:Description> <maml:para>The ID of the vCenter server</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" aliases="none"> <maml:name>VmId</maml:name> <maml:Description> <maml:para>The ID of a VM</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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.Bindings.Vr.Model.VmDiskDrResponseList</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>Invoke-VrGetLocalVmDisks -pairingId "pairingId_example" -vcenterId "vcenterId_example" -vmId "vmId_example" -filterProperty "filterProperty_example" -filter "Myfilter" -sortBy name -orderBy "orderBy_example" -limit 10 -offset 10 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetLocalVmDisks with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetLocalVmDisks -pairingId "pairingId_example" -vcenterId "vcenterId_example" -vmId "vmId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetLocalVmDisks with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/vcenters/vcenter_id/vms/vm_id/disks/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetLocalVms</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetLocalVms</command:noun> <maml:description> <maml:para>Get a list of all VMs on the vCenter Server specified by vCenter Server ID in the URL.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a list of all VMs on the vCenter Server specified by vCenter Server ID in the URL.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetLocalVms</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VcenterId</maml:name> <maml:Description> <maml:para>The ID of the vCenter server</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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" aliases="none"> <maml:name>SuitableForReplication</maml:name> <maml:Description> <maml:para>Flag to filter VMs which are suitable for replication by vSphere Replication.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VcenterId</maml:name> <maml:Description> <maml:para>The ID of the vCenter server</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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" aliases="none"> <maml:name>SuitableForReplication</maml:name> <maml:Description> <maml:para>Flag to filter VMs which are suitable for replication by vSphere Replication.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.VirtualMachineDrResponseList</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>Invoke-VrGetLocalVms -pairingId "pairingId_example" -vcenterId "vcenterId_example" -filterProperty "filterProperty_example" -filter "Myfilter" -sortBy name -orderBy "orderBy_example" -limit 10 -offset 10 -suitableForReplication $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetLocalVms with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetLocalVms -pairingId "pairingId_example" -vcenterId "vcenterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetLocalVms with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/vcenters/vcenter_id/vms/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetPointInTimeInstance</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetPointInTimeInstance</command:noun> <maml:description> <maml:para>Get a specific consistent replica (point in time instance) for a given replication.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a specific consistent replica (point in time instance) for a given replication.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetPointInTimeInstance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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" aliases="none"> <maml:name>InstanceId</maml:name> <maml:Description> <maml:para>The ID of an instance</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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" aliases="none"> <maml:name>InstanceId</maml:name> <maml:Description> <maml:para>The ID of an instance</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.Bindings.Vr.Model.PointInTimeInstanceDrResponseEntity</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>Invoke-VrGetPointInTimeInstance -pairingId "pairingId_example" -replicationId "replicationId_example" -instanceId "instanceId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetPointInTimeInstance with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetPointInTimeInstance -pairingId "pairingId_example" -replicationId "replicationId_example" -instanceId "instanceId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetPointInTimeInstance with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/replications/replication_id/instances/instance_id/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetReplicatedVmDisks</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetReplicatedVmDisks</command:noun> <maml:description> <maml:para>Retrieve information about the disks of a replicated VM.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve information about the disks of a replicated VM.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetReplicatedVmDisks</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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.Bindings.Vr.Model.ReplicatedVmDiskDrResponseList</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>Invoke-VrGetReplicatedVmDisks -pairingId "pairingId_example" -replicationId "replicationId_example" -filterProperty "filterProperty_example" -filter "Myfilter" -sortBy name -orderBy "orderBy_example" -limit 10 -offset 10 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetReplicatedVmDisks with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetReplicatedVmDisks -pairingId "pairingId_example" -replicationId "replicationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetReplicatedVmDisks with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/replications/replication_id/disks/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetReplicationInfo</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetReplicationInfo</command:noun> <maml:description> <maml:para>Get information about the replication.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get information about the replication.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetReplicationInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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.Bindings.Vr.Model.ReplicationInfoDrResponseEntity</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>Invoke-VrGetReplicationInfo -pairingId "pairingId_example" -replicationId "replicationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetReplicationInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetReplicationInfo -pairingId "pairingId_example" -replicationId "replicationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetReplicationInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/replications/replication_id/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetReplicationsCount</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetReplicationsCount</command:noun> <maml:description> <maml:para>Get the total number of replications - both incoming and outgoing.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the total number of replications - both incoming and outgoing.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetReplicationsCount</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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.Bindings.Vr.Model.CountDataDrResponseEntity</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>Invoke-VrGetReplicationsCount -pairingId "pairingId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetReplicationsCount with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetReplicationsCount -pairingId "pairingId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetReplicationsCount with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/replications/count/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetReplicationsIssues</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetReplicationsIssues</command:noun> <maml:description> <maml:para>Get a list of all the current issues for all incoming or outgoing replications.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a list of all the current issues for all incoming or outgoing replications.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetReplicationsIssues</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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" aliases="none"> <maml:name>SourceVcGuid</maml:name> <maml:Description> <maml:para>Filter replications to retrieve issues for, by their source vCenter Server.</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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" aliases="none"> <maml:name>SourceVcGuid</maml:name> <maml:Description> <maml:para>Filter replications to retrieve issues for, by their source vCenter Server.</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.Bindings.Vr.Model.IssueInfoDrResponseList</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>Invoke-VrGetReplicationsIssues -pairingId "pairingId_example" -filterProperty "filterProperty_example" -filter "Myfilter" -sortBy name -orderBy "orderBy_example" -limit 10 -offset 10 -sourceVcGuid "sourceVcGuid_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetReplicationsIssues with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetReplicationsIssues -pairingId "pairingId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetReplicationsIssues with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/replications/issues/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetSeedsForDisks</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetSeedsForDisks</command:noun> <maml:description> <maml:para>Retrieve information about possible seeds for a given set of disks.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve information about possible seeds for a given set of disks.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetSeedsForDisks</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VcenterId</maml:name> <maml:Description> <maml:para>The ID of the vCenter server</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" aliases="none"> <maml:name>DatastoreId</maml:name> <maml:Description> <maml:para>The ID of a 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="false" aliases="none"> <maml:name>VmDiskFindSeedSpec</maml:name> <maml:Description> <maml:para>List of specs to search for VM disks' seeds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vr.Model.VmDiskFindSeedSpec></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vr.Model.VmDiskFindSeedSpec></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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VcenterId</maml:name> <maml:Description> <maml:para>The ID of the vCenter server</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" aliases="none"> <maml:name>DatastoreId</maml:name> <maml:Description> <maml:para>The ID of a 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="false" aliases="none"> <maml:name>VmDiskFindSeedSpec</maml:name> <maml:Description> <maml:para>List of specs to search for VM disks' seeds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vr.Model.VmDiskFindSeedSpec></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vr.Model.VmDiskFindSeedSpec></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.Bindings.Vr.Model.VmDiskSeedInformationDrResponseList</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>$VmDiskIdentifier = Initialize-VrVmDiskIdentifier -VmId VirtualMachine:vm-80:e594ad24-5f75-41e3-a276-88a2116dbed0 -DeviceKey 0 $VmDiskFindSeedSpec = Initialize-VrVmDiskFindSeedSpec -VmDisk $VmDiskIdentifier -DestinationPath "MyDestinationPath" -UseWildcard $false Invoke-VrGetSeedsForDisks -pairingId "pairingId_example" -vcenterId "vcenterId_example" -datastoreId "datastoreId_example" -vmDiskFindSeedSpec $vmDiskFindSeedSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetSeedsForDisks with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VmDiskIdentifier = Initialize-VrVmDiskIdentifier -VmId VirtualMachine:vm-80:e594ad24-5f75-41e3-a276-88a2116dbed0 $VmDiskFindSeedSpec = Initialize-VrVmDiskFindSeedSpec -VmDisk $VmDiskIdentifier Invoke-VrGetSeedsForDisks -pairingId "pairingId_example" -vcenterId "vcenterId_example" -datastoreId "datastoreId_example" -vmDiskFindSeedSpec $vmDiskFindSeedSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetSeedsForDisks with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/vcenters/vcenter_id/datastores/datastore_id/actions/find-seeds/post//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetVcStoragePolicies</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetVcStoragePolicies</command:noun> <maml:description> <maml:para>Retrieve vCenter Server's storage policies.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve vCenter Server's storage policies.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetVcStoragePolicies</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VcenterId</maml:name> <maml:Description> <maml:para>The ID of the vCenter server</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VcenterId</maml:name> <maml:Description> <maml:para>The ID of the vCenter server</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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.Bindings.Vr.Model.StoragePolicyDrResponseList</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>Invoke-VrGetVcStoragePolicies -pairingId "pairingId_example" -vcenterId "vcenterId_example" -filterProperty "filterProperty_example" -filter "Myfilter" -sortBy name -orderBy "orderBy_example" -limit 10 -offset 10 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVcStoragePolicies with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetVcStoragePolicies -pairingId "pairingId_example" -vcenterId "vcenterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVcStoragePolicies with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/vcenters/vcenter_id/storage-policies/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetVmCapability</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetVmCapability</command:noun> <maml:description> <maml:para>Retrieve vSphere Replication capability information about a given VM.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve vSphere Replication capability information about a given VM.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetVmCapability</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VcenterId</maml:name> <maml:Description> <maml:para>The ID of the vCenter server</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" aliases="none"> <maml:name>VmId</maml:name> <maml:Description> <maml:para>The ID of a VM</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VcenterId</maml:name> <maml:Description> <maml:para>The ID of the vCenter server</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" aliases="none"> <maml:name>VmId</maml:name> <maml:Description> <maml:para>The ID of a VM</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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.Bindings.Vr.Model.VmCapabilitiesDrResponseEntity</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>Invoke-VrGetVmCapability -pairingId "pairingId_example" -vcenterId "vcenterId_example" -vmId "vmId_example" -filterProperty "filterProperty_example" -filter "Myfilter" -sortBy name -orderBy "orderBy_example" -limit 10 -offset 10 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVmCapability with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetVmCapability -pairingId "pairingId_example" -vcenterId "vcenterId_example" -vmId "vmId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVmCapability with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/vcenters/vcenter_id/vms/vm_id/capability/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetVrCapableTargetDatastores</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetVrCapableTargetDatastores</command:noun> <maml:description> <maml:para>Retrieve vSphere Replication supported datastores.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve vSphere Replication supported datastores.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetVrCapableTargetDatastores</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VcenterId</maml:name> <maml:Description> <maml:para>The ID of the vCenter server</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VcenterId</maml:name> <maml:Description> <maml:para>The ID of the vCenter server</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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.Bindings.Vr.Model.DatastoreDrResponseList</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>Invoke-VrGetVrCapableTargetDatastores -pairingId "pairingId_example" -vcenterId "vcenterId_example" -filterProperty "filterProperty_example" -filter "Myfilter" -sortBy name -orderBy "orderBy_example" -limit 10 -offset 10 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVrCapableTargetDatastores with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetVrCapableTargetDatastores -pairingId "pairingId_example" -vcenterId "vcenterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVrCapableTargetDatastores with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/vcenters/vcenter_id/datastores/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrPauseReplication</command:name> <command:verb>Invoke</command:verb> <command:noun>VrPauseReplication</command:noun> <maml:description> <maml:para>Pause the replication for a virtual machine from the source site to a remote vCenter Server site.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Pause the replication for a virtual machine from the source site to a remote vCenter Server site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrPauseReplication</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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.Bindings.Vr.Model.TaskDrResponseEntity</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>Invoke-VrPauseReplication -pairingId "pairingId_example" -replicationId "replicationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrPauseReplication with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrPauseReplication -pairingId "pairingId_example" -replicationId "replicationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrPauseReplication with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/replications/replication_id/actions/pause/post//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrPromoteTestImage</command:name> <command:verb>Invoke</command:verb> <command:noun>VrPromoteTestImage</command:noun> <maml:description> <maml:para>Promote a test image.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Cleanup files and objects associated with the image of a group while retaining the contents of the image as a new instance. Only one image of any type can exist for a group at any given moment. The image must be a test bubble image, attempting to promote a failover image will fail. Operation is available only on recovery site (for incoming replications).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrPromoteTestImage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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" aliases="none"> <maml:name>StringDrData</maml:name> <maml:Description> <maml:para>ID of the test image to promote.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.StringDrData</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.StringDrData</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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" aliases="none"> <maml:name>StringDrData</maml:name> <maml:Description> <maml:para>ID of the test image to promote.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.StringDrData</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.StringDrData</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.Bindings.Vr.Model.TaskDrResponseEntity</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>$StringDrData = Initialize-VrStringDrData -Value "MyValue" Invoke-VrPromoteTestImage -pairingId "pairingId_example" -replicationId "replicationId_example" -stringDrData $stringDrData </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrPromoteTestImage with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$StringDrData = Initialize-VrStringDrData Invoke-VrPromoteTestImage -pairingId "pairingId_example" -replicationId "replicationId_example" -stringDrData $stringDrData </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrPromoteTestImage with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/replications/replication_id/actions/promote-test-image/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VrStringDrData</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrReconfigureReplication</command:name> <command:verb>Invoke</command:verb> <command:noun>VrReconfigureReplication</command:noun> <maml:description> <maml:para>Change the settings of a replication, including reconfiguring a replication on new virtual hard disks and enabling the default seed disk to use a replica disk in the VM folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Change the settings of a replication, including reconfiguring a replication on new virtual hard disks and enabling the default seed disk to use a replica disk in the VM folder.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrReconfigureReplication</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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" aliases="none"> <maml:name>ReconfigureReplicationSpec</maml:name> <maml:Description> <maml:para>Spec that is used to reconfigure replication.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.ReconfigureReplicationSpec</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.ReconfigureReplicationSpec</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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" aliases="none"> <maml:name>ReconfigureReplicationSpec</maml:name> <maml:Description> <maml:para>Spec that is used to reconfigure replication.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.ReconfigureReplicationSpec</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.ReconfigureReplicationSpec</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.Bindings.Vr.Model.TaskDrResponseEntity</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>$DatastorePathData = Initialize-VrDatastorePathData -DatastoreId Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd -DatastoreName local-datastore -Path /path/to/folder -Filename vmDisk1.vmdk $VmDisk = Initialize-VrVmDisk -VmId VirtualMachine:vm-80:e594ad24-5f75-41e3-a276-88a2116dbed0 -DeviceKey 0 -IsVmHome $false -Encrypted $false -Capacity 0 -SourceDiskFormat "SAME_AS_SOURCE" -SourcePath $DatastorePathData -SourceStoragePolicyName "MySourceStoragePolicyName" -SourceStoragePolicyId dsbrowser.defaultStoragePolicy -Label "MyLabel" -ControllerKey 0 -ControllerLabel "MyControllerLabel" -SupportedForReplication $false $ConfigureReplicationVmDisk = Initialize-VrConfigureReplicationVmDisk -VmDisk $VmDisk -EnabledForReplication $false -UseSeeds $false -DestinationStoragePolicyId dsbrowser.defaultStoragePolicy -DestinationPath my_vm_seeds_folder/my_vm_disk_1.vmdk -DestinationDatastoreId Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd -DestinationDiskFormat "SAME_AS_SOURCE" $ReconfigureReplicationSpec = Initialize-VrReconfigureReplicationSpec -QuiesceEnabled $false -Rpo 0 -NetworkCompressionEnabled $false -MpitEnabled $false -MpitInstances 0 -MpitDays 0 -AutoReplicateNewDisks $false -TargetReplicationServerId HmsRemoteHbrServer:HBRSRV-1924009b-0562-433d-8db9-082141ac04cd:067878e6-2ff0-41eb-928c-5e91492a7b29 -LwdEncryptionEnabled $false -VmDataSetsReplicationEnabled $false -EnhancedReplication $false -Disks $ConfigureReplicationVmDisk Invoke-VrReconfigureReplication -pairingId "pairingId_example" -replicationId "replicationId_example" -reconfigureReplicationSpec $reconfigureReplicationSpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrReconfigureReplication with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrReconfigureReplication -pairingId "pairingId_example" -replicationId "replicationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrReconfigureReplication with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/replications/replication_id/actions/reconfigure/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VrReconfigureReplicationSpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrResumeReplication</command:name> <command:verb>Invoke</command:verb> <command:noun>VrResumeReplication</command:noun> <maml:description> <maml:para>Resume a paused replication to the target vCenter Server site.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Resume a paused replication to the target vCenter Server site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrResumeReplication</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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.Bindings.Vr.Model.TaskDrResponseEntity</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>Invoke-VrResumeReplication -pairingId "pairingId_example" -replicationId "replicationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrResumeReplication with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrResumeReplication -pairingId "pairingId_example" -replicationId "replicationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrResumeReplication with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/replications/replication_id/actions/resume/post//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrRunCleanup</command:name> <command:verb>Invoke</command:verb> <command:noun>VrRunCleanup</command:noun> <maml:description> <maml:para>Run a cleanup test recovery for a given replication.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Run a cleanup test recovery for a given replication. This includes removing or reloading the placeholder VM from original path and reverting the test bubble image. Operation is available only on recovery site (for incoming replications).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrRunCleanup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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.Bindings.Vr.Model.TaskDrResponseEntity</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>Invoke-VrRunCleanup -pairingId "pairingId_example" -replicationId "replicationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrRunCleanup with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrRunCleanup -pairingId "pairingId_example" -replicationId "replicationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrRunCleanup with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/replications/replication_id/actions/cleanup/post//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrRunDisasterRecovery</command:name> <command:verb>Invoke</command:verb> <command:noun>VrRunDisasterRecovery</command:noun> <maml:description> <maml:para>Run a disaster recovery for a given replication.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Run a disaster recovery for a given replication. Operation is available only on recovery site (for incoming replications). The operation requires a valid VMware Live Recovery subscription.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrRunDisasterRecovery</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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" aliases="none"> <maml:name>RunRecoverySpec</maml:name> <maml:Description> <maml:para>Spec containing disaster recovery settings.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.RunRecoverySpec</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.RunRecoverySpec</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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" aliases="none"> <maml:name>RunRecoverySpec</maml:name> <maml:Description> <maml:para>Spec containing disaster recovery settings.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.RunRecoverySpec</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.RunRecoverySpec</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.Bindings.Vr.Model.TaskDrResponseEntity</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>$DiskBacking = Initialize-VrDiskBacking -DiskKey 0 -DestinationPath my_vm_folder/my_vm_disk_1.vmdk -DestinationDatastoreId Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd $RunRecoverySpec = Initialize-VrRunRecoverySpec -InstanceId "MyInstanceId" -FolderId Folder:folder-19:f26599ec-ff35-4da6-8c4d-72f6761309f3 -ComputeResourceId "MyComputeResourceId" -ExcludedDiskBackings $DiskBacking -PowerOn $false -SyncData $false Invoke-VrRunDisasterRecovery -pairingId "pairingId_example" -replicationId "replicationId_example" -runRecoverySpec $runRecoverySpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrRunDisasterRecovery with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$RunRecoverySpec = Initialize-VrRunRecoverySpec -FolderId Folder:folder-19:f26599ec-ff35-4da6-8c4d-72f6761309f3 -ComputeResourceId "MyComputeResourceId" -PowerOn $false -SyncData $false Invoke-VrRunDisasterRecovery -pairingId "pairingId_example" -replicationId "replicationId_example" -runRecoverySpec $runRecoverySpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrRunDisasterRecovery with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/replications/replication_id/actions/recovery/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VrRunRecoverySpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrRunTest</command:name> <command:verb>Invoke</command:verb> <command:noun>VrRunTest</command:noun> <maml:description> <maml:para>Run a test recovery for a given replication.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Run a test recovery for a given replication. A VM is created and registered at the recovery site. You can use the VM to run tests, security scans and ransomware-cleanup. Operation is available only on recovery site (for incoming replications). The operation requires a valid VMware Live Recovery subscription.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrRunTest</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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" aliases="none"> <maml:name>RunTestRecoverySpec</maml:name> <maml:Description> <maml:para>Spec containing test recovery settings.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.RunTestRecoverySpec</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.RunTestRecoverySpec</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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" aliases="none"> <maml:name>RunTestRecoverySpec</maml:name> <maml:Description> <maml:para>Spec containing test recovery settings.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.RunTestRecoverySpec</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.RunTestRecoverySpec</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.Bindings.Vr.Model.TaskDrResponseEntity</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>$DiskBacking = Initialize-VrDiskBacking -DiskKey 0 -DestinationPath my_vm_folder/my_vm_disk_1.vmdk -DestinationDatastoreId Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd $RunTestRecoverySpec = Initialize-VrRunTestRecoverySpec -InstanceId "MyInstanceId" -FolderId Folder:folder-19:f26599ec-ff35-4da6-8c4d-72f6761309f3 -ComputeResourceId "MyComputeResourceId" -ExcludedDiskBackings $DiskBacking -PowerOn $false Invoke-VrRunTest -pairingId "pairingId_example" -replicationId "replicationId_example" -runTestRecoverySpec $runTestRecoverySpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrRunTest with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$RunTestRecoverySpec = Initialize-VrRunTestRecoverySpec -InstanceId "MyInstanceId" -FolderId Folder:folder-19:f26599ec-ff35-4da6-8c4d-72f6761309f3 -ComputeResourceId "MyComputeResourceId" -PowerOn $false Invoke-VrRunTest -pairingId "pairingId_example" -replicationId "replicationId_example" -runTestRecoverySpec $runTestRecoverySpec </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrRunTest with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/replications/replication_id/actions/test/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VrRunTestRecoverySpec</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrSyncReplication</command:name> <command:verb>Invoke</command:verb> <command:noun>VrSyncReplication</command:noun> <maml:description> <maml:para>Sync the latest changes for a virtual machine with a configured replication to the target vCenter Server site.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sync the latest changes for a virtual machine with a configured replication to the target vCenter Server site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrSyncReplication</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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.Bindings.Vr.Model.TaskDrResponseEntity</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>Invoke-VrSyncReplication -pairingId "pairingId_example" -replicationId "replicationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrSyncReplication with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrSyncReplication -pairingId "pairingId_example" -replicationId "replicationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrSyncReplication with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/replications/replication_id/actions/sync/post//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrUnconfigureReplication</command:name> <command:verb>Invoke</command:verb> <command:noun>VrUnconfigureReplication</command:noun> <maml:description> <maml:para>Gracefully remove the replication configuration of a VM. If the remote site is not available, use DELETE /replications/{replication_id} to delete the replication from the local site.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gracefully remove the replication configuration of a VM. If the remote site is not available, use DELETE /replications/{replication_id} to delete the replication from the local site.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrUnconfigureReplication</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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" aliases="none"> <maml:name>RetainReplicaDisks</maml:name> <maml:Description> <maml:para>Whether or not to retain replica disks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>ReplicationId</maml:name> <maml:Description> <maml:para>The ID of a replication</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" aliases="none"> <maml:name>RetainReplicaDisks</maml:name> <maml:Description> <maml:para>Whether or not to retain replica disks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.TaskDrResponseEntity</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>Invoke-VrUnconfigureReplication -pairingId "pairingId_example" -replicationId "replicationId_example" -retainReplicaDisks $false </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrUnconfigureReplication with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrUnconfigureReplication -pairingId "pairingId_example" -replicationId "replicationId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrUnconfigureReplication with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/replications/replication_id/actions/unconfigure/post//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetAllVrServers</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetAllVrServers</command:noun> <maml:description> <maml:para>Get all registered replication servers.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get all registered replication servers.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetAllVrServers</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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.Bindings.Vr.Model.ReplicationServerInfoDrResponseList</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>Invoke-VrGetAllVrServers -filterProperty "filterProperty_example" -filter "Myfilter" -sortBy name -orderBy "orderBy_example" -limit 10 -offset 10 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetAllVrServers with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetAllVrServers </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetAllVrServers with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/replication-servers/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetVrInfo</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetVrInfo</command:noun> <maml:description> <maml:para>vSphere Replication Management Server information.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Lists details about the vSphere Replication Management Server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetVrInfo</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.VrmsInfoDrResponseEntity</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>Invoke-VrGetVrInfo </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVrInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetVrInfo </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVrInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/info/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetVrServer</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetVrServer</command:noun> <maml:description> <maml:para>Get information about a registered vSphere Replication server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get information about a registered vSphere Replication server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetVrServer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReplicationServerId</maml:name> <maml:Description> <maml:para>The UUID of the vSphere Replication server</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" aliases="none"> <maml:name>ReplicationServerId</maml:name> <maml:Description> <maml:para>The UUID of the vSphere Replication server</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.Bindings.Vr.Model.ReplicationServerInfoDrResponseEntity</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>Invoke-VrGetVrServer -replicationServerId "replicationServerId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVrServer with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetVrServer -replicationServerId "replicationServerId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVrServer with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/replication-servers/replication_server_id/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrReconnectVrServer</command:name> <command:verb>Invoke</command:verb> <command:noun>VrReconnectVrServer</command:noun> <maml:description> <maml:para>Update the connection information of this vSphere Replication server and reset any current connection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update the connection information of this vSphere Replication server and reset any current connection.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrReconnectVrServer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReplicationServerId</maml:name> <maml:Description> <maml:para>The UUID of the vSphere Replication server</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" aliases="none"> <maml:name>ReplicationServerId</maml:name> <maml:Description> <maml:para>The UUID of the vSphere Replication server</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.Bindings.Vr.Model.TaskDrResponseEntity</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>Invoke-VrReconnectVrServer -replicationServerId "replicationServerId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrReconnectVrServer with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrReconnectVrServer -replicationServerId "replicationServerId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrReconnectVrServer with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/replication-servers/replication_server_id/actions/reconnect/post//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrRegisterVrServer</command:name> <command:verb>Invoke</command:verb> <command:noun>VrRegisterVrServer</command:noun> <maml:description> <maml:para>Register a replication server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Register a replication server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrRegisterVrServer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StringDrData</maml:name> <maml:Description> <maml:para>An ID of the vSphere Replication server virtual machine.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.StringDrData</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.StringDrData</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" aliases="none"> <maml:name>StringDrData</maml:name> <maml:Description> <maml:para>An ID of the vSphere Replication server virtual machine.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.StringDrData</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.StringDrData</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.Bindings.Vr.Model.TaskDrResponseEntity</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>$StringDrData = Initialize-VrStringDrData -Value "MyValue" Invoke-VrRegisterVrServer -stringDrData $stringDrData </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrRegisterVrServer with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$StringDrData = Initialize-VrStringDrData Invoke-VrRegisterVrServer -stringDrData $stringDrData </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrRegisterVrServer with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/replication-servers/post//</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VrStringDrData</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrUnregisterVrServer</command:name> <command:verb>Invoke</command:verb> <command:noun>VrUnregisterVrServer</command:noun> <maml:description> <maml:para>Unregister a vSphere Replication server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Unregister a vSphere Replication server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrUnregisterVrServer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReplicationServerId</maml:name> <maml:Description> <maml:para>The UUID of the vSphere Replication server</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" aliases="none"> <maml:name>ReplicationServerId</maml:name> <maml:Description> <maml:para>The UUID of the vSphere Replication server</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.Bindings.Vr.Model.TaskDrResponseEntity</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>Invoke-VrUnregisterVrServer -replicationServerId "replicationServerId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrUnregisterVrServer with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrUnregisterVrServer -replicationServerId "replicationServerId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrUnregisterVrServer with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/replication-servers/replication_server_id/delete//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetRecentTasksInfo</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetRecentTasksInfo</command:noun> <maml:description> <maml:para>Retrieve all recent tasks.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve all recent tasks.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetRecentTasksInfo</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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.Bindings.Vr.Model.TaskDrResponseList</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>Invoke-VrGetRecentTasksInfo -filterProperty "filterProperty_example" -filter "Myfilter" -sortBy name -orderBy "orderBy_example" -limit 10 -offset 10 </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetRecentTasksInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetRecentTasksInfo </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetRecentTasksInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/tasks/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetTaskInfo</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetTaskInfo</command:noun> <maml:description> <maml:para>Retrieve task information.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve task information.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetTaskInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TaskId</maml:name> <maml:Description> <maml:para>The ID of a task.</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" aliases="none"> <maml:name>TaskId</maml:name> <maml:Description> <maml:para>The ID of a task.</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.Bindings.Vr.Model.TaskDrResponseEntity</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>Invoke-VrGetTaskInfo -taskId "taskId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetTaskInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetTaskInfo -taskId "taskId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetTaskInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/tasks/task_id/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetVcenterComputeInventory</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetVcenterComputeInventory</command:noun> <maml:description> <maml:para>Get information about the vCenter Server's compute inventory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get information about the vCenter Server's compute inventory.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetVcenterComputeInventory</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VcenterId</maml:name> <maml:Description> <maml:para>The ID of the vCenter server</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" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>A path to the compute resource or the folder object.</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VcenterId</maml:name> <maml:Description> <maml:para>The ID of the vCenter server</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" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>A path to the compute resource or the folder object.</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.Bindings.Vr.Model.VcenterServerInventoryItemDrResponseList</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>Invoke-VrGetVcenterComputeInventory -pairingId "pairingId_example" -vcenterId "vcenterId_example" -path "path_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVcenterComputeInventory with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetVcenterComputeInventory -pairingId "pairingId_example" -vcenterId "vcenterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVcenterComputeInventory with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/vcenters/vcenter_id/inventory/compute/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetVcenterComputeItem</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetVcenterComputeItem</command:noun> <maml:description> <maml:para>Get information about the vCenter Server's compute object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get information about the vCenter Server's compute object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetVcenterComputeItem</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VcenterId</maml:name> <maml:Description> <maml:para>The ID of the vCenter server</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" aliases="none"> <maml:name>ComputeId</maml:name> <maml:Description> <maml:para>The ID of a vCenter Server's compute object.</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VcenterId</maml:name> <maml:Description> <maml:para>The ID of the vCenter server</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" aliases="none"> <maml:name>ComputeId</maml:name> <maml:Description> <maml:para>The ID of a vCenter Server's compute object.</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.Bindings.Vr.Model.VcenterServerInventoryItemDrResponseEntity</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>Invoke-VrGetVcenterComputeItem -pairingId "pairingId_example" -vcenterId "vcenterId_example" -computeId "computeId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVcenterComputeItem with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetVcenterComputeItem -pairingId "pairingId_example" -vcenterId "vcenterId_example" -computeId "computeId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVcenterComputeItem with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/vcenters/vcenter_id/inventory/compute/compute_id/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetVcenterVmFolder</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetVcenterVmFolder</command:noun> <maml:description> <maml:para>Get information about the vCenter Server's VM folder object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get information about the vCenter Server's VM folder object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetVcenterVmFolder</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VcenterId</maml:name> <maml:Description> <maml:para>The ID of the vCenter server</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" aliases="none"> <maml:name>VmFolderId</maml:name> <maml:Description> <maml:para>The ID of a vCenter Server's VM folder object.</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VcenterId</maml:name> <maml:Description> <maml:para>The ID of the vCenter server</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" aliases="none"> <maml:name>VmFolderId</maml:name> <maml:Description> <maml:para>The ID of a vCenter Server's VM folder object.</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.Bindings.Vr.Model.VcenterServerInventoryItemDrResponseEntity</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>Invoke-VrGetVcenterVmFolder -pairingId "pairingId_example" -vcenterId "vcenterId_example" -vmFolderId "vmFolderId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVcenterVmFolder with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetVcenterVmFolder -pairingId "pairingId_example" -vcenterId "vcenterId_example" -vmFolderId "vmFolderId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVcenterVmFolder with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/vcenters/vcenter_id/inventory/vm-folder/vm_folder_id/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VrGetVcenterVmFolderInventory</command:name> <command:verb>Invoke</command:verb> <command:noun>VrGetVcenterVmFolderInventory</command:noun> <maml:description> <maml:para>Get information about the vCenter Server's VM folder inventory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a list of children of a given folder by path.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VrGetVcenterVmFolderInventory</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VcenterId</maml:name> <maml:Description> <maml:para>The ID of the vCenter server</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Path to the VM folder.</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" aliases="none"> <maml:name>PairingId</maml:name> <maml:Description> <maml:para>The ID of the pairing between this vSphere Replication server and the remote one.</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" aliases="none"> <maml:name>VcenterId</maml:name> <maml:Description> <maml:para>The ID of the vCenter server</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" aliases="none"> <maml:name>FilterProperty</maml:name> <maml:Description> <maml:para>The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1</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" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<string></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SortBy</maml:name> <maml:Description> <maml:para>Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.</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" aliases="none"> <maml:name>OrderBy</maml:name> <maml:Description> <maml:para>Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.</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" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property 'defaultResponsePageSize' in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.</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" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10</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" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Path to the VM folder.</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.Bindings.Vr.Model.VcenterServerInventoryItemDrResponseList</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>Invoke-VrGetVcenterVmFolderInventory -pairingId "pairingId_example" -vcenterId "vcenterId_example" -filterProperty "filterProperty_example" -filter "Myfilter" -sortBy name -orderBy "orderBy_example" -limit 10 -offset 10 -path "path_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVcenterVmFolderInventory with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Invoke-VrGetVcenterVmFolderInventory -pairingId "pairingId_example" -vcenterId "vcenterId_example" </dev:code> <dev:remarks> <maml:para>Invoking Invoke-VrGetVcenterVmFolderInventory with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/pairings/pairing_id/vcenters/vcenter_id/inventory/vm-folder/get//</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VrConfigureReplicationSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>ConfigureReplicationSpec</command:noun> <maml:description> <maml:para>A spec used to configure replication.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A spec used to configure replication.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VrConfigureReplicationSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>QuiesceEnabled</maml:name> <maml:Description> <maml:para>A flag that defines whether the quiescing method is enabled.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rpo</maml:name> <maml:Description> <maml:para>The target RPO in minutes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkCompressionEnabled</maml:name> <maml:Description> <maml:para>Use network compression for replication traffic.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MpitEnabled</maml:name> <maml:Description> <maml:para>The point-in-time recovery enabled. Up to 24 instances are supported if both ''mpit_days'' and ''mpit_instances'' are specified.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MpitInstances</maml:name> <maml:Description> <maml:para>The point-in-time recovery instances per day. If ''mpit_days'' is 0, then latest ''mpit_instances'' will be kept.\"It is recommended to have a vSAN ESA datastore as a target for values over 24.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MpitDays</maml:name> <maml:Description> <maml:para>The point-in-time recovery days to retain instances for. If 0 - latest ''mpit_instances'' will be kept. (VMware Live Recovery subscription required)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AutoReplicateNewDisks</maml:name> <maml:Description> <maml:para>Indicate whether automatic replication of new disks is enabled for a VM being replicated.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetReplicationServerId</maml:name> <maml:Description> <maml:para>The ID of the vSphere Replication server this group resides on. In case of null, the server will be automatically determined. Deprecated - from VMware Live Recovery 9.0.3 legacy replications are not supported and this property is ignored.</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" aliases="none"> <maml:name>LwdEncryptionEnabled</maml:name> <maml:Description> <maml:para>Indicate whether LWD encryption is enabled for this replication. Deprecated - from VMware Live Recovery 9.0.3 LWD encryption is always enabled and this value is ignored.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmDataSetsReplicationEnabled</maml:name> <maml:Description> <maml:para>Indicate whether VM's DataSets replication is enabled.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EnhancedReplication</maml:name> <maml:Description> <maml:para>Indicate whether the replication is an enhanced replication. Enhanced vSphere Replication includes automated load balancing and scaling to achieve higher performance, and when enabled with VMware Live Recovery provides a 1 minute RPO. Legacy vSphere Replication routes traffic to the replication appliance at the target site. Depending on replication traffic, you might need to manually deploy additional vSphere Replication servers. If set to true - target_replication_server_id is ignored.Deprecated - from VMware Live Recovery 9.0.3 legacy replications are not supported and enhanced_replication is always true.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>true</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Disks</maml:name> <maml:Description> <maml:para>A VM disk with a destination path, a disk format, a storage policy, and the replication status.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vr.Model.ConfigureReplicationVmDisk></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vr.Model.ConfigureReplicationVmDisk></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetVcId</maml:name> <maml:Description> <maml:para>The ID of the target VC server.</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" aliases="none"> <maml:name>VmId</maml:name> <maml:Description> <maml:para>The ID of the virtual machine that is going to be replicated.</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" aliases="none"> <maml:name>QuiesceEnabled</maml:name> <maml:Description> <maml:para>A flag that defines whether the quiescing method is enabled.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rpo</maml:name> <maml:Description> <maml:para>The target RPO in minutes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkCompressionEnabled</maml:name> <maml:Description> <maml:para>Use network compression for replication traffic.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MpitEnabled</maml:name> <maml:Description> <maml:para>The point-in-time recovery enabled. Up to 24 instances are supported if both ''mpit_days'' and ''mpit_instances'' are specified.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MpitInstances</maml:name> <maml:Description> <maml:para>The point-in-time recovery instances per day. If ''mpit_days'' is 0, then latest ''mpit_instances'' will be kept.\"It is recommended to have a vSAN ESA datastore as a target for values over 24.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MpitDays</maml:name> <maml:Description> <maml:para>The point-in-time recovery days to retain instances for. If 0 - latest ''mpit_instances'' will be kept. (VMware Live Recovery subscription required)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AutoReplicateNewDisks</maml:name> <maml:Description> <maml:para>Indicate whether automatic replication of new disks is enabled for a VM being replicated.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetReplicationServerId</maml:name> <maml:Description> <maml:para>The ID of the vSphere Replication server this group resides on. In case of null, the server will be automatically determined. Deprecated - from VMware Live Recovery 9.0.3 legacy replications are not supported and this property is ignored.</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" aliases="none"> <maml:name>LwdEncryptionEnabled</maml:name> <maml:Description> <maml:para>Indicate whether LWD encryption is enabled for this replication. Deprecated - from VMware Live Recovery 9.0.3 LWD encryption is always enabled and this value is ignored.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmDataSetsReplicationEnabled</maml:name> <maml:Description> <maml:para>Indicate whether VM's DataSets replication is enabled.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EnhancedReplication</maml:name> <maml:Description> <maml:para>Indicate whether the replication is an enhanced replication. Enhanced vSphere Replication includes automated load balancing and scaling to achieve higher performance, and when enabled with VMware Live Recovery provides a 1 minute RPO. Legacy vSphere Replication routes traffic to the replication appliance at the target site. Depending on replication traffic, you might need to manually deploy additional vSphere Replication servers. If set to true - target_replication_server_id is ignored.Deprecated - from VMware Live Recovery 9.0.3 legacy replications are not supported and enhanced_replication is always true.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>true</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Disks</maml:name> <maml:Description> <maml:para>A VM disk with a destination path, a disk format, a storage policy, and the replication status.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vr.Model.ConfigureReplicationVmDisk></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vr.Model.ConfigureReplicationVmDisk></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetVcId</maml:name> <maml:Description> <maml:para>The ID of the target VC server.</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" aliases="none"> <maml:name>VmId</maml:name> <maml:Description> <maml:para>The ID of the virtual machine that is going to be replicated.</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $DatastorePathData = Initialize-VrDatastorePathData -DatastoreId Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd -DatastoreName local-datastore -Path /path/to/folder -Filename vmDisk1.vmdk $VmDisk = Initialize-VrVmDisk -VmId VirtualMachine:vm-80:e594ad24-5f75-41e3-a276-88a2116dbed0 -DeviceKey 0 -IsVmHome $false -Encrypted $false -Capacity 0 -SourceDiskFormat "SAME_AS_SOURCE" -SourcePath $DatastorePathData -SourceStoragePolicyName "MySourceStoragePolicyName" -SourceStoragePolicyId dsbrowser.defaultStoragePolicy -Label "MyLabel" -ControllerKey 0 -ControllerLabel "MyControllerLabel" -SupportedForReplication $false $ConfigureReplicationVmDisk = Initialize-VrConfigureReplicationVmDisk -VmDisk $VmDisk -EnabledForReplication $false -UseSeeds $false -DestinationStoragePolicyId dsbrowser.defaultStoragePolicy -DestinationPath my_vm_seeds_folder/my_vm_disk_1.vmdk -DestinationDatastoreId Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd -DestinationDiskFormat "SAME_AS_SOURCE" $ConfigureReplicationSpec = Initialize-VrConfigureReplicationSpec -QuiesceEnabled $false -Rpo 0 -NetworkCompressionEnabled $false -MpitEnabled $false -MpitInstances 0 -MpitDays 0 -AutoReplicateNewDisks $false -TargetReplicationServerId HmsRemoteHbrServer:HBRSRV-1924009b-0562-433d-8db9-082141ac04cd:067878e6-2ff0-41eb-928c-5e91492a7b29 -LwdEncryptionEnabled $false -VmDataSetsReplicationEnabled $false -EnhancedReplication $false -Disks $ConfigureReplicationVmDisk -TargetVcId ff4a23e7-2fed-4be0-be39-479ae372badd -VmId VirtualMachine:vm-80:e594ad24-5f75-41e3-a276-88a2116dbed0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrConfigureReplicationSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $VmDisk = Initialize-VrVmDisk -VmId VirtualMachine:vm-80:e594ad24-5f75-41e3-a276-88a2116dbed0 $ConfigureReplicationVmDisk = Initialize-VrConfigureReplicationVmDisk -VmDisk $VmDisk -EnabledForReplication $false -DestinationDatastoreId Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd -DestinationDiskFormat "SAME_AS_SOURCE" $ConfigureReplicationSpec = Initialize-VrConfigureReplicationSpec -Rpo 0 -NetworkCompressionEnabled $false -MpitEnabled $false -AutoReplicateNewDisks $false -Disks $ConfigureReplicationVmDisk -TargetVcId ff4a23e7-2fed-4be0-be39-479ae372badd -VmId VirtualMachine:vm-80:e594ad24-5f75-41e3-a276-88a2116dbed0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrConfigureReplicationSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/data-structures/ConfigureReplicationSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VrConfigureReplicationVmDisk</command:name> <command:verb>Initialize</command:verb> <command:noun>ConfigureReplicationVmDisk</command:noun> <maml:description> <maml:para>VM disk information while configuring or reconfiguring a replication.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>VM disk information while configuring or reconfiguring a replication.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VrConfigureReplicationVmDisk</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmDisk</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.VmDisk</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.VmDisk</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EnabledForReplication</maml:name> <maml:Description> <maml:para>Indicate whether the VM disk is enabled for replication.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UseSeeds</maml:name> <maml:Description> <maml:para>Whether to use seeds for this VM disk. If this field is true, then also set the destination_path property.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DestinationStoragePolicyId</maml:name> <maml:Description> <maml:para>The destination storage policy ID. If destination storage policy ID is null then default datastore policy will be used.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DestinationPath</maml:name> <maml:Description> <maml:para>If use_seeds is true, specify the destination path where the seed folder and vmdk files are located. Otherwise, leave it null. For VM home disk - always must be null.</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" aliases="none"> <maml:name>DestinationDatastoreId</maml:name> <maml:Description> <maml:para>The ID of the destination datastore at the target 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" aliases="none"> <maml:name>DestinationDiskFormat</maml:name> <maml:Description> <maml:para>The format of the virtual disk.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.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" aliases="none"> <maml:name>VmDisk</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.VmDisk</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.VmDisk</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EnabledForReplication</maml:name> <maml:Description> <maml:para>Indicate whether the VM disk is enabled for replication.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>UseSeeds</maml:name> <maml:Description> <maml:para>Whether to use seeds for this VM disk. If this field is true, then also set the destination_path property.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DestinationStoragePolicyId</maml:name> <maml:Description> <maml:para>The destination storage policy ID. If destination storage policy ID is null then default datastore policy will be used.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DestinationPath</maml:name> <maml:Description> <maml:para>If use_seeds is true, specify the destination path where the seed folder and vmdk files are located. Otherwise, leave it null. For VM home disk - always must be null.</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" aliases="none"> <maml:name>DestinationDatastoreId</maml:name> <maml:Description> <maml:para>The ID of the destination datastore at the target 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" aliases="none"> <maml:name>DestinationDiskFormat</maml:name> <maml:Description> <maml:para>The format of the virtual disk.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $DatastorePathData = Initialize-VrDatastorePathData -DatastoreId Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd -DatastoreName local-datastore -Path /path/to/folder -Filename vmDisk1.vmdk $VmDisk = Initialize-VrVmDisk -VmId VirtualMachine:vm-80:e594ad24-5f75-41e3-a276-88a2116dbed0 -DeviceKey 0 -IsVmHome $false -Encrypted $false -Capacity 0 -SourceDiskFormat "SAME_AS_SOURCE" -SourcePath $DatastorePathData -SourceStoragePolicyName "MySourceStoragePolicyName" -SourceStoragePolicyId dsbrowser.defaultStoragePolicy -Label "MyLabel" -ControllerKey 0 -ControllerLabel "MyControllerLabel" -SupportedForReplication $false $ConfigureReplicationVmDisk = Initialize-VrConfigureReplicationVmDisk -VmDisk $VmDisk -EnabledForReplication $false -UseSeeds $false -DestinationStoragePolicyId dsbrowser.defaultStoragePolicy -DestinationPath my_vm_seeds_folder/my_vm_disk_1.vmdk -DestinationDatastoreId Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd -DestinationDiskFormat "SAME_AS_SOURCE" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrConfigureReplicationVmDisk with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $VmDisk = Initialize-VrVmDisk -VmId VirtualMachine:vm-80:e594ad24-5f75-41e3-a276-88a2116dbed0 $ConfigureReplicationVmDisk = Initialize-VrConfigureReplicationVmDisk -VmDisk $VmDisk -EnabledForReplication $false -DestinationDatastoreId Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd -DestinationDiskFormat "SAME_AS_SOURCE" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrConfigureReplicationVmDisk with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/data-structures/ConfigureReplicationVmDisk</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VrVmDisk</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VrDatastoreBrowserRequest</command:name> <command:verb>Initialize</command:verb> <command:noun>DatastoreBrowserRequest</command:noun> <maml:description> <maml:para>Request spec to search a datastore for specific types of files or folders.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Request spec to search a datastore for specific types of files or folders.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VrDatastoreBrowserRequest</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>QueryType</maml:name> <maml:Description> <maml:para>The datastore browser query type.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BrowsePath</maml:name> <maml:Description> <maml:para>The path of the datastore to browse, pass an empty string for the root node.</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" aliases="none"> <maml:name>SubFolders</maml:name> <maml:Description> <maml:para>Indicate whether the datastore that the file system searches should include subfolders of the browse path.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</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" aliases="none"> <maml:name>QueryType</maml:name> <maml:Description> <maml:para>The datastore browser query type.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>BrowsePath</maml:name> <maml:Description> <maml:para>The path of the datastore to browse, pass an empty string for the root node.</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" aliases="none"> <maml:name>SubFolders</maml:name> <maml:Description> <maml:para>Indicate whether the datastore that the file system searches should include subfolders of the browse path.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$DatastoreBrowserRequest = Initialize-VrDatastoreBrowserRequest -QueryType "VM_DISK" -BrowsePath "MyBrowsePath" -SubFolders $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrDatastoreBrowserRequest with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DatastoreBrowserRequest = Initialize-VrDatastoreBrowserRequest </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrDatastoreBrowserRequest with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/data-structures/DatastoreBrowserRequest</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VrDatastoreBrowserResultDrResponseEntity</command:name> <command:verb>Initialize</command:verb> <command:noun>DatastoreBrowserResultDrResponseEntity</command:noun> <maml:description> <maml:para>The result of the browsing datastore request</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The result of the browsing datastore request</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VrDatastoreBrowserResultDrResponseEntity</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>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" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The full path of the file with the datastore name as the prefix.</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" aliases="none"> <maml:name>Size</maml:name> <maml:Description> <maml:para>The size of the returned object/file in bytes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FileType</maml:name> <maml:Description> <maml:para>The type of the file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.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" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>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" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The full path of the file with the datastore name as the prefix.</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" aliases="none"> <maml:name>Size</maml:name> <maml:Description> <maml:para>The size of the returned object/file in bytes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FileType</maml:name> <maml:Description> <maml:para>The type of the file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$DatastoreBrowserResultDrResponseEntity = Initialize-VrDatastoreBrowserResultDrResponseEntity -Name "MyName" -Path "MyPath" -Size 0 -FileType "FOLDER" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrDatastoreBrowserResultDrResponseEntity with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DatastoreBrowserResultDrResponseEntity = Initialize-VrDatastoreBrowserResultDrResponseEntity </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrDatastoreBrowserResultDrResponseEntity with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/data-structures/DatastoreBrowserResultDrResponseEntity</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VrDatastoreDrResponseEntity</command:name> <command:verb>Initialize</command:verb> <command:noun>DatastoreDrResponseEntity</command:noun> <maml:description> <maml:para>Datastore information such as file system type and general health.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Datastore information such as file system type and general health.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VrDatastoreDrResponseEntity</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the 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" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the 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" aliases="none"> <maml:name>Parent</maml:name> <maml:Description> <maml:para>The ID of the parent 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" aliases="none"> <maml:name>ParentName</maml:name> <maml:Description> <maml:para>The name of the parent 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" aliases="none"> <maml:name>Capacity</maml:name> <maml:Description> <maml:para>The total capacity of the datastore in bytes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FreeSpace</maml:name> <maml:Description> <maml:para>The free space on the datastore in bytes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FileSystemType</maml:name> <maml:Description> <maml:para>The file system type of the datastore.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MaintenanceMode</maml:name> <maml:Description> <maml:para>The maintenance mode for the 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" aliases="none"> <maml:name>OverallStatus</maml:name> <maml:Description> <maml:para>The overall status of the datastore.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Accessible</maml:name> <maml:Description> <maml:para>Indicate whether the datastore is accessible.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>The type of the datastore.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NkpSupported</maml:name> <maml:Description> <maml:para>Indicate whether the datastore supports encryption with native key.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The datastore path.</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" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The ID of the 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" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the 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" aliases="none"> <maml:name>Parent</maml:name> <maml:Description> <maml:para>The ID of the parent 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" aliases="none"> <maml:name>ParentName</maml:name> <maml:Description> <maml:para>The name of the parent 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" aliases="none"> <maml:name>Capacity</maml:name> <maml:Description> <maml:para>The total capacity of the datastore in bytes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FreeSpace</maml:name> <maml:Description> <maml:para>The free space on the datastore in bytes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FileSystemType</maml:name> <maml:Description> <maml:para>The file system type of the datastore.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MaintenanceMode</maml:name> <maml:Description> <maml:para>The maintenance mode for the 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" aliases="none"> <maml:name>OverallStatus</maml:name> <maml:Description> <maml:para>The overall status of the datastore.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Accessible</maml:name> <maml:Description> <maml:para>Indicate whether the datastore is accessible.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>The type of the datastore.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NkpSupported</maml:name> <maml:Description> <maml:para>Indicate whether the datastore supports encryption with native key.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The datastore path.</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$DatastoreDrResponseEntity = Initialize-VrDatastoreDrResponseEntity -Id "MyId" -Name "MyName" -Parent "MyParent" -ParentName "MyParentName" -Capacity 0 -FreeSpace 0 -FileSystemType "VMFS" -MaintenanceMode "MyMaintenanceMode" -OverallStatus "GRAY" -Accessible $false -Type "DATASTORE" -NkpSupported $false -Path "MyPath" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrDatastoreDrResponseEntity with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DatastoreDrResponseEntity = Initialize-VrDatastoreDrResponseEntity </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrDatastoreDrResponseEntity with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/data-structures/DatastoreDrResponseEntity</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VrDatastorePathData</command:name> <command:verb>Initialize</command:verb> <command:noun>DatastorePathData</command:noun> <maml:description> <maml:para>The data object that is used to fully qualify a datastore path.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The data object that is used to fully qualify a datastore path.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VrDatastorePathData</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DatastoreId</maml:name> <maml:Description> <maml:para>The ID of the 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" aliases="none"> <maml:name>DatastoreName</maml:name> <maml:Description> <maml:para>The name of the 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" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The path of the 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" aliases="none"> <maml:name>Filename</maml:name> <maml:Description> <maml:para>The name of file.</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" aliases="none"> <maml:name>DatastoreId</maml:name> <maml:Description> <maml:para>The ID of the 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" aliases="none"> <maml:name>DatastoreName</maml:name> <maml:Description> <maml:para>The name of the 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" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The path of the 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" aliases="none"> <maml:name>Filename</maml:name> <maml:Description> <maml:para>The name of file.</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$DatastorePathData = Initialize-VrDatastorePathData -DatastoreId Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd -DatastoreName local-datastore -Path /path/to/folder -Filename vmDisk1.vmdk </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrDatastorePathData with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DatastorePathData = Initialize-VrDatastorePathData -DatastoreId Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrDatastorePathData with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/data-structures/DatastorePathData</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VrDiskBacking</command:name> <command:verb>Initialize</command:verb> <command:noun>DiskBacking</command:noun> <maml:description> <maml:para>Mapping between disk and destination datastore and datastore path where the disk file is located.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Mapping between disk and destination datastore and datastore path where the disk file is located.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VrDiskBacking</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DiskKey</maml:name> <maml:Description> <maml:para>ID key of the disk</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DestinationPath</maml:name> <maml:Description> <maml:para>Path where the disk file is located. If not specified the disk will be detached from the recovered VM. Both destination_path and destination_datastore_id must be specified.</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" aliases="none"> <maml:name>DestinationDatastoreId</maml:name> <maml:Description> <maml:para>The ID of the destination datastore at the target site. If not specified the disk will be detached from the recovered VM. Both destination_path and destination_datastore_id must be specified.</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" aliases="none"> <maml:name>DiskKey</maml:name> <maml:Description> <maml:para>ID key of the disk</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DestinationPath</maml:name> <maml:Description> <maml:para>Path where the disk file is located. If not specified the disk will be detached from the recovered VM. Both destination_path and destination_datastore_id must be specified.</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" aliases="none"> <maml:name>DestinationDatastoreId</maml:name> <maml:Description> <maml:para>The ID of the destination datastore at the target site. If not specified the disk will be detached from the recovered VM. Both destination_path and destination_datastore_id must be specified.</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$DiskBacking = Initialize-VrDiskBacking -DiskKey 0 -DestinationPath my_vm_folder/my_vm_disk_1.vmdk -DestinationDatastoreId Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrDiskBacking with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$DiskBacking = Initialize-VrDiskBacking -DiskKey 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrDiskBacking with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/data-structures/DiskBacking</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VrIssueInfoDrResponseEntity</command:name> <command:verb>Initialize</command:verb> <command:noun>IssueInfoDrResponseEntity</command:noun> <maml:description> <maml:para>Issue information.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Issue information.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VrIssueInfoDrResponseEntity</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Entity</maml:name> <maml:Description> <maml:para>The entity this issue is about.</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" aliases="none"> <maml:name>EntityName</maml:name> <maml:Description> <maml:para>The entity name this issue is about.</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" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>The description of the issue.</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" aliases="none"> <maml:name>Timestamp</maml:name> <maml:Description> <maml:para>The timestamp of the issue, in milliseconds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>The issue status.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IssueType</maml:name> <maml:Description> <maml:para>The issue type.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.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" aliases="none"> <maml:name>Entity</maml:name> <maml:Description> <maml:para>The entity this issue is about.</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" aliases="none"> <maml:name>EntityName</maml:name> <maml:Description> <maml:para>The entity name this issue is about.</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" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>The description of the issue.</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" aliases="none"> <maml:name>Timestamp</maml:name> <maml:Description> <maml:para>The timestamp of the issue, in milliseconds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Status</maml:name> <maml:Description> <maml:para>The issue status.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IssueType</maml:name> <maml:Description> <maml:para>The issue type.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$IssueInfoDrResponseEntity = Initialize-VrIssueInfoDrResponseEntity -Entity "MyEntity" -EntityName "MyEntityName" -Description "MyDescription" -Timestamp 0 -Status "WARNING" -IssueType "VC" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrIssueInfoDrResponseEntity with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$IssueInfoDrResponseEntity = Initialize-VrIssueInfoDrResponseEntity </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrIssueInfoDrResponseEntity with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/data-structures/IssueInfoDrResponseEntity</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VrPairingSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>PairingSpec</command:noun> <maml:description> <maml:para>Pairing information.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Pairing information.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VrPairingSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairPscInfo</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.PairingSpecPairPscInfo</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.PairingSpecPairPscInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairVcId</maml:name> <maml:Description> <maml:para>The ID of the remote vCenter Server.</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" aliases="none"> <maml:name>PairPscInfo</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.PairingSpecPairPscInfo</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.PairingSpecPairPscInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PairVcId</maml:name> <maml:Description> <maml:para>The ID of the remote vCenter Server.</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $PairingSpecPairPscInfo = Initialize-VrPairingSpecPairPscInfo -Url "MyUrl" -Port 0 -Thumbprint "MyThumbprint" -Username "MyUsername" -Password "MyPassword" $PairingSpec = Initialize-VrPairingSpec -PairPscInfo $PairingSpecPairPscInfo -PairVcId "MyPairVcId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrPairingSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $PairingSpecPairPscInfo = Initialize-VrPairingSpecPairPscInfo $PairingSpec = Initialize-VrPairingSpec -PairPscInfo $PairingSpecPairPscInfo -PairVcId "MyPairVcId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrPairingSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/data-structures/PairingSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VrPairingSpecPairPscInfo</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VrPairingSpecPairPscInfo</command:name> <command:verb>Initialize</command:verb> <command:noun>PairingSpecPairPscInfo</command:noun> <maml:description> <maml:para>Information about the pair Platform Services Controller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Information about the pair Platform Services Controller.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VrPairingSpecPairPscInfo</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Url</maml:name> <maml:Description> <maml:para>The URL of the remote Platform Services Controller.</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" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>The port that is configured for the Platform Services Controller. The default port is 443.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Thumbprint</maml:name> <maml:Description> <maml:para>The thumbprint of the remote Platform Services Controller.</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" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>The user name for the Platform Services Controller.</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" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>The password for the Platform Services Controller.</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" aliases="none"> <maml:name>Url</maml:name> <maml:Description> <maml:para>The URL of the remote Platform Services Controller.</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" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>The port that is configured for the Platform Services Controller. The default port is 443.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Thumbprint</maml:name> <maml:Description> <maml:para>The thumbprint of the remote Platform Services Controller.</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" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>The user name for the Platform Services Controller.</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" aliases="none"> <maml:name>Password</maml:name> <maml:Description> <maml:para>The password for the Platform Services Controller.</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$PairingSpecPairPscInfo = Initialize-VrPairingSpecPairPscInfo -Url "MyUrl" -Port 0 -Thumbprint "MyThumbprint" -Username "MyUsername" -Password "MyPassword" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrPairingSpecPairPscInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$PairingSpecPairPscInfo = Initialize-VrPairingSpecPairPscInfo </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrPairingSpecPairPscInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/data-structures/PairingSpecPairPscInfo</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VrReconfigureReplicationSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>ReconfigureReplicationSpec</command:noun> <maml:description> <maml:para>A spec that is used to reconfigure replication.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A spec that is used to reconfigure replication.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VrReconfigureReplicationSpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>QuiesceEnabled</maml:name> <maml:Description> <maml:para>A flag that defines whether the quiescing method is enabled.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rpo</maml:name> <maml:Description> <maml:para>The target RPO in minutes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkCompressionEnabled</maml:name> <maml:Description> <maml:para>Use network compression for replication traffic.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MpitEnabled</maml:name> <maml:Description> <maml:para>The point-in-time recovery enabled. Up to 24 instances are supported if both ''mpit_days'' and ''mpit_instances'' are specified.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MpitInstances</maml:name> <maml:Description> <maml:para>The point-in-time recovery instances per day. If ''mpit_days'' is 0, then latest ''mpit_instances'' will be kept.\"It is recommended to have a vSAN ESA datastore as a target for values over 24.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MpitDays</maml:name> <maml:Description> <maml:para>The point-in-time recovery days to retain instances for. If 0 - latest ''mpit_instances'' will be kept. (VMware Live Recovery subscription required)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AutoReplicateNewDisks</maml:name> <maml:Description> <maml:para>Indicate whether automatic replication of new disks is enabled for a VM being replicated.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetReplicationServerId</maml:name> <maml:Description> <maml:para>The ID of the vSphere Replication server this group resides on. In case of null, the server will be automatically determined. Deprecated - from VMware Live Recovery 9.0.3 legacy replications are not supported and this property is ignored.</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" aliases="none"> <maml:name>LwdEncryptionEnabled</maml:name> <maml:Description> <maml:para>Indicate whether LWD encryption is enabled for this replication. Deprecated - from VMware Live Recovery 9.0.3 LWD encryption is always enabled and this value is ignored.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmDataSetsReplicationEnabled</maml:name> <maml:Description> <maml:para>Indicate whether VM's DataSets replication is enabled.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EnhancedReplication</maml:name> <maml:Description> <maml:para>Indicate whether the replication is an enhanced replication. Enhanced vSphere Replication includes automated load balancing and scaling to achieve higher performance, and when enabled with VMware Live Recovery provides a 1 minute RPO. Legacy vSphere Replication routes traffic to the replication appliance at the target site. Depending on replication traffic, you might need to manually deploy additional vSphere Replication servers. If set to true - target_replication_server_id is ignored.Deprecated - from VMware Live Recovery 9.0.3 legacy replications are not supported and enhanced_replication is always true.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>true</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Disks</maml:name> <maml:Description> <maml:para>A VM disk with a destination path, a disk format, a storage policy, and the replication status.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vr.Model.ConfigureReplicationVmDisk></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vr.Model.ConfigureReplicationVmDisk></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" aliases="none"> <maml:name>QuiesceEnabled</maml:name> <maml:Description> <maml:para>A flag that defines whether the quiescing method is enabled.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Rpo</maml:name> <maml:Description> <maml:para>The target RPO in minutes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NetworkCompressionEnabled</maml:name> <maml:Description> <maml:para>Use network compression for replication traffic.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MpitEnabled</maml:name> <maml:Description> <maml:para>The point-in-time recovery enabled. Up to 24 instances are supported if both ''mpit_days'' and ''mpit_instances'' are specified.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MpitInstances</maml:name> <maml:Description> <maml:para>The point-in-time recovery instances per day. If ''mpit_days'' is 0, then latest ''mpit_instances'' will be kept.\"It is recommended to have a vSAN ESA datastore as a target for values over 24.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>MpitDays</maml:name> <maml:Description> <maml:para>The point-in-time recovery days to retain instances for. If 0 - latest ''mpit_instances'' will be kept. (VMware Live Recovery subscription required)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>AutoReplicateNewDisks</maml:name> <maml:Description> <maml:para>Indicate whether automatic replication of new disks is enabled for a VM being replicated.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>TargetReplicationServerId</maml:name> <maml:Description> <maml:para>The ID of the vSphere Replication server this group resides on. In case of null, the server will be automatically determined. Deprecated - from VMware Live Recovery 9.0.3 legacy replications are not supported and this property is ignored.</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" aliases="none"> <maml:name>LwdEncryptionEnabled</maml:name> <maml:Description> <maml:para>Indicate whether LWD encryption is enabled for this replication. Deprecated - from VMware Live Recovery 9.0.3 LWD encryption is always enabled and this value is ignored.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>true</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmDataSetsReplicationEnabled</maml:name> <maml:Description> <maml:para>Indicate whether VM's DataSets replication is enabled.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>EnhancedReplication</maml:name> <maml:Description> <maml:para>Indicate whether the replication is an enhanced replication. Enhanced vSphere Replication includes automated load balancing and scaling to achieve higher performance, and when enabled with VMware Live Recovery provides a 1 minute RPO. Legacy vSphere Replication routes traffic to the replication appliance at the target site. Depending on replication traffic, you might need to manually deploy additional vSphere Replication servers. If set to true - target_replication_server_id is ignored.Deprecated - from VMware Live Recovery 9.0.3 legacy replications are not supported and enhanced_replication is always true.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>true</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Disks</maml:name> <maml:Description> <maml:para>A VM disk with a destination path, a disk format, a storage policy, and the replication status.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vr.Model.ConfigureReplicationVmDisk></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vr.Model.ConfigureReplicationVmDisk></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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $DatastorePathData = Initialize-VrDatastorePathData -DatastoreId Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd -DatastoreName local-datastore -Path /path/to/folder -Filename vmDisk1.vmdk $VmDisk = Initialize-VrVmDisk -VmId VirtualMachine:vm-80:e594ad24-5f75-41e3-a276-88a2116dbed0 -DeviceKey 0 -IsVmHome $false -Encrypted $false -Capacity 0 -SourceDiskFormat "SAME_AS_SOURCE" -SourcePath $DatastorePathData -SourceStoragePolicyName "MySourceStoragePolicyName" -SourceStoragePolicyId dsbrowser.defaultStoragePolicy -Label "MyLabel" -ControllerKey 0 -ControllerLabel "MyControllerLabel" -SupportedForReplication $false $ConfigureReplicationVmDisk = Initialize-VrConfigureReplicationVmDisk -VmDisk $VmDisk -EnabledForReplication $false -UseSeeds $false -DestinationStoragePolicyId dsbrowser.defaultStoragePolicy -DestinationPath my_vm_seeds_folder/my_vm_disk_1.vmdk -DestinationDatastoreId Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd -DestinationDiskFormat "SAME_AS_SOURCE" $ReconfigureReplicationSpec = Initialize-VrReconfigureReplicationSpec -QuiesceEnabled $false -Rpo 0 -NetworkCompressionEnabled $false -MpitEnabled $false -MpitInstances 0 -MpitDays 0 -AutoReplicateNewDisks $false -TargetReplicationServerId HmsRemoteHbrServer:HBRSRV-1924009b-0562-433d-8db9-082141ac04cd:067878e6-2ff0-41eb-928c-5e91492a7b29 -LwdEncryptionEnabled $false -VmDataSetsReplicationEnabled $false -EnhancedReplication $false -Disks $ConfigureReplicationVmDisk </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrReconfigureReplicationSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $VmDisk = Initialize-VrVmDisk -VmId VirtualMachine:vm-80:e594ad24-5f75-41e3-a276-88a2116dbed0 $ConfigureReplicationVmDisk = Initialize-VrConfigureReplicationVmDisk -VmDisk $VmDisk -EnabledForReplication $false -DestinationDatastoreId Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd -DestinationDiskFormat "SAME_AS_SOURCE" $ReconfigureReplicationSpec = Initialize-VrReconfigureReplicationSpec -Rpo 0 -NetworkCompressionEnabled $false -MpitEnabled $false -AutoReplicateNewDisks $false -Disks $ConfigureReplicationVmDisk </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrReconfigureReplicationSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/data-structures/ReconfigureReplicationSpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VrReplicatedVmDiskDrResponseEntity</command:name> <command:verb>Initialize</command:verb> <command:noun>ReplicatedVmDiskDrResponseEntity</command:noun> <maml:description> <maml:para>Replicated VM disk information.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Replicated VM disk information.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VrReplicatedVmDiskDrResponseEntity</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmDisk</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.VmDisk</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.VmDisk</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Replicated</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DestinationPath</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.DestinationDatastorePathData</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.DestinationDatastorePathData</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DestinationStoragePolicyId</maml:name> <maml:Description> <maml:para>The destination storage policy 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" aliases="none"> <maml:name>DestinationStoragePolicyName</maml:name> <maml:Description> <maml:para>The destination storage policy 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" aliases="none"> <maml:name>DestinationDiskFormat</maml:name> <maml:Description> <maml:para>The format of the virtual disk.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReplicaDiskUsage</maml:name> <maml:Description> <maml:para>The usage of the replication disk.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</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" aliases="none"> <maml:name>VmDisk</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.VmDisk</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.VmDisk</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Replicated</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DestinationPath</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.DestinationDatastorePathData</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.DestinationDatastorePathData</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DestinationStoragePolicyId</maml:name> <maml:Description> <maml:para>The destination storage policy 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" aliases="none"> <maml:name>DestinationStoragePolicyName</maml:name> <maml:Description> <maml:para>The destination storage policy 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" aliases="none"> <maml:name>DestinationDiskFormat</maml:name> <maml:Description> <maml:para>The format of the virtual disk.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ReplicaDiskUsage</maml:name> <maml:Description> <maml:para>The usage of the replication disk.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $DatastorePathData = Initialize-VrDatastorePathData -DatastoreId Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd -DatastoreName local-datastore -Path /path/to/folder -Filename vmDisk1.vmdk $VmDisk = Initialize-VrVmDisk -VmId VirtualMachine:vm-80:e594ad24-5f75-41e3-a276-88a2116dbed0 -DeviceKey 0 -IsVmHome $false -Encrypted $false -Capacity 0 -SourceDiskFormat "SAME_AS_SOURCE" -SourcePath $DatastorePathData -SourceStoragePolicyName "MySourceStoragePolicyName" -SourceStoragePolicyId dsbrowser.defaultStoragePolicy -Label "MyLabel" -ControllerKey 0 -ControllerLabel "MyControllerLabel" -SupportedForReplication $false $ReplicatedVmDiskDrResponseEntity = Initialize-VrReplicatedVmDiskDrResponseEntity -VmDisk $VmDisk -Replicated $false -DestinationPath $DestinationDatastorePathData -DestinationStoragePolicyId "MyDestinationStoragePolicyId" -DestinationStoragePolicyName "MyDestinationStoragePolicyName" -DestinationDiskFormat "SAME_AS_SOURCE" -ReplicaDiskUsage 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrReplicatedVmDiskDrResponseEntity with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $ReplicatedVmDiskDrResponseEntity = Initialize-VrReplicatedVmDiskDrResponseEntity </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrReplicatedVmDiskDrResponseEntity with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/data-structures/ReplicatedVmDiskDrResponseEntity</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VrVmDisk</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-Vr</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VrRunRecoverySpec</command:name> <command:verb>Initialize</command:verb> <command:noun>RunRecoverySpec</command:noun> <maml:description> <maml:para>Spec containing run recovery settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Spec containing run recovery settings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VrRunRecoverySpec</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>InstanceId</maml:name> <maml:Description> <maml:para>The instance of the replicated VM to use for recovery. If no instance is set and there is a promoted instance, the promoted instance will be used. If no promoted instance exists, the latest instance will be used. If set, the 'sync_data' parameter must be 'false'.</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" aliases="none"> <maml:name>FolderId</maml:name> <maml:Description> <maml:para>The ID of the folder to add the recovered virtual machine to. Could be a folder or a datacenter.</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" aliases="none"> <maml:name>ComputeResourceId</maml:name> <maml:Description> <maml:para>The compute resource to which the virtual machine should be attached. Could be a resource pool, a cluster or a host system.</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" aliases="none"> <maml:name>ExcludedDiskBackings</maml:name> <maml:Description> <maml:para>File backings for excluded disks. If 'destination_path' and 'destination_datastore_id' properties are not specified then the disk will be detached from the VM.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vr.Model.DiskBacking></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vr.Model.DiskBacking></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PowerOn</maml:name> <maml:Description> <maml:para>Whether to power on the VM after the recovery completes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SyncData</maml:name> <maml:Description> <maml:para>Whether to perform offline sync to replicate the latest changes. If 'true', the protected site must still be available and the VMs powered off, else the recovery will fail. If the protected site is not available, and the user confirms the recovery should run, sync_data must be set to 'false'.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</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" aliases="none"> <maml:name>InstanceId</maml:name> <maml:Description> <maml:para>The instance of the replicated VM to use for recovery. If no instance is set and there is a promoted instance, the promoted instance will be used. If no promoted instance exists, the latest instance will be used. If set, the 'sync_data' parameter must be 'false'.</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" aliases="none"> <maml:name>FolderId</maml:name> <maml:Description> <maml:para>The ID of the folder to add the recovered virtual machine to. Could be a folder or a datacenter.</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" aliases="none"> <maml:name>ComputeResourceId</maml:name> <maml:Description> <maml:para>The compute resource to which the virtual machine should be attached. Could be a resource pool, a cluster or a host system.</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" aliases="none"> <maml:name>ExcludedDiskBackings</maml:name> <maml:Description> <maml:para>File backings for excluded disks. If 'destination_path' and 'destination_datastore_id' properties are not specified then the disk will be detached from the VM.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vr.Model.DiskBacking></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vr.Model.DiskBacking></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PowerOn</maml:name> <maml:Description> <maml:para>Whether to power on the VM after the recovery completes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SyncData</maml:name> <maml:Description> <maml:para>Whether to perform offline sync to replicate the latest changes. If 'true', the protected site must still be available and the VMs powered off, else the recovery will fail. If the protected site is not available, and the user confirms the recovery should run, sync_data must be set to 'false'.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $DiskBacking = Initialize-VrDiskBacking -DiskKey 0 -DestinationPath my_vm_folder/my_vm_disk_1.vmdk -DestinationDatastoreId Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd $RunRecoverySpec = Initialize-VrRunRecoverySpec -InstanceId "MyInstanceId" -FolderId Folder:folder-19:f26599ec-ff35-4da6-8c4d-72f6761309f3 -ComputeResourceId "MyComputeResourceId" -ExcludedDiskBackings $DiskBacking -PowerOn $false -SyncData $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrRunRecoverySpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $RunRecoverySpec = Initialize-VrRunRecoverySpec -FolderId Folder:folder-19:f26599ec-ff35-4da6-8c4d-72f6761309f3 -ComputeResourceId "MyComputeResourceId" -PowerOn $false -SyncData $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrRunRecoverySpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/data-structures/RunRecoverySpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VrRunTestRecoverySpec</command:name> <command:verb>Initialize</command:verb> <command:noun>RunTestRecoverySpec</command:noun> <maml:description> <maml:para>Spec containing run test recovery settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Spec containing run test recovery settings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VrRunTestRecoverySpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>InstanceId</maml:name> <maml:Description> <maml:para>The instance of the replicated VM to use for test recovery.</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" aliases="none"> <maml:name>FolderId</maml:name> <maml:Description> <maml:para>The ID of the folder to add the recovered virtual machine to. Could be a folder or a datacenter.</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" aliases="none"> <maml:name>ComputeResourceId</maml:name> <maml:Description> <maml:para>The compute resource to which the virtual machine should be attached. Could be a resource pool, a cluster or a host system.</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" aliases="none"> <maml:name>ExcludedDiskBackings</maml:name> <maml:Description> <maml:para>File backings for excluded disks. If 'destination_path' and 'destination_datastore_id' properties are not specified then the disk will be detached from the VM.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vr.Model.DiskBacking></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vr.Model.DiskBacking></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PowerOn</maml:name> <maml:Description> <maml:para>Whether to power on the VM after the recovery completes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</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" aliases="none"> <maml:name>InstanceId</maml:name> <maml:Description> <maml:para>The instance of the replicated VM to use for test recovery.</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" aliases="none"> <maml:name>FolderId</maml:name> <maml:Description> <maml:para>The ID of the folder to add the recovered virtual machine to. Could be a folder or a datacenter.</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" aliases="none"> <maml:name>ComputeResourceId</maml:name> <maml:Description> <maml:para>The compute resource to which the virtual machine should be attached. Could be a resource pool, a cluster or a host system.</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" aliases="none"> <maml:name>ExcludedDiskBackings</maml:name> <maml:Description> <maml:para>File backings for excluded disks. If 'destination_path' and 'destination_datastore_id' properties are not specified then the disk will be detached from the VM.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vr.Model.DiskBacking></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vr.Model.DiskBacking></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>PowerOn</maml:name> <maml:Description> <maml:para>Whether to power on the VM after the recovery completes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $DiskBacking = Initialize-VrDiskBacking -DiskKey 0 -DestinationPath my_vm_folder/my_vm_disk_1.vmdk -DestinationDatastoreId Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd $RunTestRecoverySpec = Initialize-VrRunTestRecoverySpec -InstanceId "MyInstanceId" -FolderId Folder:folder-19:f26599ec-ff35-4da6-8c4d-72f6761309f3 -ComputeResourceId "MyComputeResourceId" -ExcludedDiskBackings $DiskBacking -PowerOn $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrRunTestRecoverySpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $RunTestRecoverySpec = Initialize-VrRunTestRecoverySpec -InstanceId "MyInstanceId" -FolderId Folder:folder-19:f26599ec-ff35-4da6-8c4d-72f6761309f3 -ComputeResourceId "MyComputeResourceId" -PowerOn $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrRunTestRecoverySpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/data-structures/RunTestRecoverySpec</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VrSessionIdData</command:name> <command:verb>Initialize</command:verb> <command:noun>SessionIdData</command:noun> <maml:description> <maml:para>Data including the new session ID.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Data including the new session ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VrSessionIdData</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SessionId</maml:name> <maml:Description> <maml:para>The ID of the session.</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" aliases="none"> <maml:name>SessionId</maml:name> <maml:Description> <maml:para>The ID of the session.</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$SessionIdData = Initialize-VrSessionIdData -SessionId "MySessionId" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrSessionIdData with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$SessionIdData = Initialize-VrSessionIdData </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrSessionIdData with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/data-structures/SessionIdData</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VrSessionInfo</command:name> <command:verb>Initialize</command:verb> <command:noun>SessionInfo</command:noun> <maml:description> <maml:para>Information about the current session.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Information about the current session.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VrSessionInfo</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>The user name in the session.</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" aliases="none"> <maml:name>Username</maml:name> <maml:Description> <maml:para>The user name in the session.</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$SessionInfo = Initialize-VrSessionInfo -Username "MyUsername" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrSessionInfo with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$SessionInfo = Initialize-VrSessionInfo </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrSessionInfo with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/data-structures/SessionInfo</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VrStoragePolicyComplianceCheckDataDrResponseEntity</command:name> <command:verb>Initialize</command:verb> <command:noun>StoragePolicyComplianceCheckDataDrResponseEntity</command:noun> <maml:description> <maml:para>Datastore compliance status against a storage policy.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Datastore compliance status against a storage policy.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VrStoragePolicyComplianceCheckDataDrResponseEntity</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StoragePolicyId</maml:name> <maml:Description> <maml:para>The ID of the storage policy.</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" aliases="none"> <maml:name>Datastore</maml:name> <maml:Description> <maml:para>The datastore to check compliance for.</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" aliases="none"> <maml:name>Compliant</maml:name> <maml:Description> <maml:para>Indicate whether the storage policy is compliant.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NotCompliantDetailedMessage</maml:name> <maml:Description> <maml:para>The detailed information if the datastore is not compliant.</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" aliases="none"> <maml:name>StoragePolicyId</maml:name> <maml:Description> <maml:para>The ID of the storage policy.</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" aliases="none"> <maml:name>Datastore</maml:name> <maml:Description> <maml:para>The datastore to check compliance for.</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" aliases="none"> <maml:name>Compliant</maml:name> <maml:Description> <maml:para>Indicate whether the storage policy is compliant.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>NotCompliantDetailedMessage</maml:name> <maml:Description> <maml:para>The detailed information if the datastore is not compliant.</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$StoragePolicyComplianceCheckDataDrResponseEntity = Initialize-VrStoragePolicyComplianceCheckDataDrResponseEntity -StoragePolicyId "MyStoragePolicyId" -Datastore "MyDatastore" -Compliant $false -NotCompliantDetailedMessage "MyNotCompliantDetailedMessage" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrStoragePolicyComplianceCheckDataDrResponseEntity with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$StoragePolicyComplianceCheckDataDrResponseEntity = Initialize-VrStoragePolicyComplianceCheckDataDrResponseEntity </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrStoragePolicyComplianceCheckDataDrResponseEntity with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/data-structures/StoragePolicyComplianceCheckDataDrResponseEntity</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VrStoragePolicyDrResponseEntity</command:name> <command:verb>Initialize</command:verb> <command:noun>StoragePolicyDrResponseEntity</command:noun> <maml:description> <maml:para>Storage policy defined in the vCenter Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Storage policy defined in the vCenter Server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VrStoragePolicyDrResponseEntity</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>StoragePolicyName</maml:name> <maml:Description> <maml:para>The name of the storage policy.</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" aliases="none"> <maml:name>StoragePolicyId</maml:name> <maml:Description> <maml:para>The ID of the storage policy defined in the vCenter Server.</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" aliases="none"> <maml:name>VmEncryptionSupported</maml:name> <maml:Description> <maml:para>Indicate whether this profile has encryption capability.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</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" aliases="none"> <maml:name>StoragePolicyName</maml:name> <maml:Description> <maml:para>The name of the storage policy.</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" aliases="none"> <maml:name>StoragePolicyId</maml:name> <maml:Description> <maml:para>The ID of the storage policy defined in the vCenter Server.</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" aliases="none"> <maml:name>VmEncryptionSupported</maml:name> <maml:Description> <maml:para>Indicate whether this profile has encryption capability.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$StoragePolicyDrResponseEntity = Initialize-VrStoragePolicyDrResponseEntity -StoragePolicyName "MyStoragePolicyName" -StoragePolicyId "MyStoragePolicyId" -VmEncryptionSupported $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrStoragePolicyDrResponseEntity with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$StoragePolicyDrResponseEntity = Initialize-VrStoragePolicyDrResponseEntity </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrStoragePolicyDrResponseEntity with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/data-structures/StoragePolicyDrResponseEntity</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VrStringDrData</command:name> <command:verb>Initialize</command:verb> <command:noun>StringDrData</command:noun> <maml:description> <maml:para>Contains string representation of a data.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Contains string representation of a data.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VrStringDrData</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>The string representation of a data.</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" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>The string representation of a data.</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$StringDrData = Initialize-VrStringDrData -Value "MyValue" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrStringDrData with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$StringDrData = Initialize-VrStringDrData </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrStringDrData with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/data-structures/StringDrData</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VrVirtualMachineDrResponseEntity</command:name> <command:verb>Initialize</command:verb> <command:noun>VirtualMachineDrResponseEntity</command:noun> <maml:description> <maml:para>Information about a virtual machine</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Information about a virtual machine</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VrVirtualMachineDrResponseEntity</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The unique identifier of the VM.</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" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the VM.</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" aliases="none"> <maml:name>PowerState</maml:name> <maml:Description> <maml:para>The VM power state.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ConnectionState</maml:name> <maml:Description> <maml:para>The state of the VM connection.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Template</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ManagedByInfo</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.VirtualMachineManagedByInfo</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.VirtualMachineManagedByInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VrPrivilegeGranted</maml:name> <maml:Description> <maml:para>Indicate whether the current user has the VirtualMachine.Hbr.ConfigureReplication privilege.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Disks</maml:name> <maml:Description> <maml:para>Information about the VM disks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vr.Model.VmDisk></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vr.Model.VmDisk></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" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>The unique identifier of the VM.</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" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the VM.</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" aliases="none"> <maml:name>PowerState</maml:name> <maml:Description> <maml:para>The VM power state.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ConnectionState</maml:name> <maml:Description> <maml:para>The state of the VM connection.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Template</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ManagedByInfo</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.VirtualMachineManagedByInfo</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.VirtualMachineManagedByInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VrPrivilegeGranted</maml:name> <maml:Description> <maml:para>Indicate whether the current user has the VirtualMachine.Hbr.ConfigureReplication privilege.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Disks</maml:name> <maml:Description> <maml:para>Information about the VM disks.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<VMware.Bindings.Vr.Model.VmDisk></command:parameterValue> <dev:type> <maml:name>List<VMware.Bindings.Vr.Model.VmDisk></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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $DatastorePathData = Initialize-VrDatastorePathData -DatastoreId Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd -DatastoreName local-datastore -Path /path/to/folder -Filename vmDisk1.vmdk $VmDisk = Initialize-VrVmDisk -VmId VirtualMachine:vm-80:e594ad24-5f75-41e3-a276-88a2116dbed0 -DeviceKey 0 -IsVmHome $false -Encrypted $false -Capacity 0 -SourceDiskFormat "SAME_AS_SOURCE" -SourcePath $DatastorePathData -SourceStoragePolicyName "MySourceStoragePolicyName" -SourceStoragePolicyId dsbrowser.defaultStoragePolicy -Label "MyLabel" -ControllerKey 0 -ControllerLabel "MyControllerLabel" -SupportedForReplication $false $VirtualMachineDrResponseEntity = Initialize-VrVirtualMachineDrResponseEntity -Id "MyId" -Name "MyName" -PowerState "POWERED_OFF" -ConnectionState "CONNECTED" -Template $false -ManagedByInfo $VirtualMachineManagedByInfo -VrPrivilegeGranted $false -Disks $VmDisk </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrVirtualMachineDrResponseEntity with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $VirtualMachineDrResponseEntity = Initialize-VrVirtualMachineDrResponseEntity </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrVirtualMachineDrResponseEntity with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/data-structures/VirtualMachineDrResponseEntity</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-Vr</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VrVmDisk</command:name> <command:verb>Initialize</command:verb> <command:noun>VmDisk</command:noun> <maml:description> <maml:para>The VM disk information.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The VM disk information.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VrVmDisk</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmId</maml:name> <maml:Description> <maml:para>The ID of the VM this disk is part of.</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" aliases="none"> <maml:name>DeviceKey</maml:name> <maml:Description> <maml:para>The device key of the source VM disk.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsVmHome</maml:name> <maml:Description> <maml:para>Each VM has one disk item, representing a VM home.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Encrypted</maml:name> <maml:Description> <maml:para>Indicate whether the VM disk is encrypted.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Capacity</maml:name> <maml:Description> <maml:para>The capacity of the source VM disk, in KBs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SourceDiskFormat</maml:name> <maml:Description> <maml:para>The format of the virtual disk.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SourcePath</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.DatastorePathData</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.DatastorePathData</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SourceStoragePolicyName</maml:name> <maml:Description> <maml:para>The name of the storage policy of the source storage.</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" aliases="none"> <maml:name>SourceStoragePolicyId</maml:name> <maml:Description> <maml:para>The ID of the storage policy of the source storage.</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" aliases="none"> <maml:name>Label</maml:name> <maml:Description> <maml:para>The label of the VM disk.</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" aliases="none"> <maml:name>ControllerKey</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ControllerLabel</maml:name> <maml:Description> <maml:para>The label of the VM disk.</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" aliases="none"> <maml:name>SupportedForReplication</maml:name> <maml:Description> <maml:para>Disks with certain types of controllers are not supported for replication. For example, NVMe, PCI, and SATA.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</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" aliases="none"> <maml:name>VmId</maml:name> <maml:Description> <maml:para>The ID of the VM this disk is part of.</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" aliases="none"> <maml:name>DeviceKey</maml:name> <maml:Description> <maml:para>The device key of the source VM disk.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsVmHome</maml:name> <maml:Description> <maml:para>Each VM has one disk item, representing a VM home.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Encrypted</maml:name> <maml:Description> <maml:para>Indicate whether the VM disk is encrypted.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Capacity</maml:name> <maml:Description> <maml:para>The capacity of the source VM disk, in KBs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SourceDiskFormat</maml:name> <maml:Description> <maml:para>The format of the virtual disk.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SourcePath</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.DatastorePathData</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.DatastorePathData</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SourceStoragePolicyName</maml:name> <maml:Description> <maml:para>The name of the storage policy of the source storage.</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" aliases="none"> <maml:name>SourceStoragePolicyId</maml:name> <maml:Description> <maml:para>The ID of the storage policy of the source storage.</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" aliases="none"> <maml:name>Label</maml:name> <maml:Description> <maml:para>The label of the VM disk.</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" aliases="none"> <maml:name>ControllerKey</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ControllerLabel</maml:name> <maml:Description> <maml:para>The label of the VM disk.</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" aliases="none"> <maml:name>SupportedForReplication</maml:name> <maml:Description> <maml:para>Disks with certain types of controllers are not supported for replication. For example, NVMe, PCI, and SATA.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $DatastorePathData = Initialize-VrDatastorePathData -DatastoreId Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd -DatastoreName local-datastore -Path /path/to/folder -Filename vmDisk1.vmdk $VmDisk = Initialize-VrVmDisk -VmId VirtualMachine:vm-80:e594ad24-5f75-41e3-a276-88a2116dbed0 -DeviceKey 0 -IsVmHome $false -Encrypted $false -Capacity 0 -SourceDiskFormat "SAME_AS_SOURCE" -SourcePath $DatastorePathData -SourceStoragePolicyName "MySourceStoragePolicyName" -SourceStoragePolicyId dsbrowser.defaultStoragePolicy -Label "MyLabel" -ControllerKey 0 -ControllerLabel "MyControllerLabel" -SupportedForReplication $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrVmDisk with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $VmDisk = Initialize-VrVmDisk -VmId VirtualMachine:vm-80:e594ad24-5f75-41e3-a276-88a2116dbed0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrVmDisk with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/data-structures/VmDisk</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VrDatastorePathData</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VrVmDiskDrResponseEntity</command:name> <command:verb>Initialize</command:verb> <command:noun>VmDiskDrResponseEntity</command:noun> <maml:description> <maml:para>The VM disk information.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The VM disk information.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VrVmDiskDrResponseEntity</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmId</maml:name> <maml:Description> <maml:para>The ID of the VM this disk is part of.</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" aliases="none"> <maml:name>DeviceKey</maml:name> <maml:Description> <maml:para>The device key of the source VM disk.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsVmHome</maml:name> <maml:Description> <maml:para>Each VM has one disk item, representing a VM home.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Encrypted</maml:name> <maml:Description> <maml:para>Indicate whether the VM disk is encrypted.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Capacity</maml:name> <maml:Description> <maml:para>The capacity of the source VM disk, in KBs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SourceDiskFormat</maml:name> <maml:Description> <maml:para>The format of the virtual disk.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SourcePath</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.DatastorePathData</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.DatastorePathData</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SourceStoragePolicyName</maml:name> <maml:Description> <maml:para>The name of the storage policy of the source storage.</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" aliases="none"> <maml:name>SourceStoragePolicyId</maml:name> <maml:Description> <maml:para>The ID of the storage policy of the source storage.</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" aliases="none"> <maml:name>Label</maml:name> <maml:Description> <maml:para>The label of the VM disk.</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" aliases="none"> <maml:name>ControllerKey</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ControllerLabel</maml:name> <maml:Description> <maml:para>The label of the VM disk.</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" aliases="none"> <maml:name>SupportedForReplication</maml:name> <maml:Description> <maml:para>Disks with certain types of controllers are not supported for replication. For example, NVMe, PCI, and SATA.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</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" aliases="none"> <maml:name>VmId</maml:name> <maml:Description> <maml:para>The ID of the VM this disk is part of.</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" aliases="none"> <maml:name>DeviceKey</maml:name> <maml:Description> <maml:para>The device key of the source VM disk.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>IsVmHome</maml:name> <maml:Description> <maml:para>Each VM has one disk item, representing a VM home.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Encrypted</maml:name> <maml:Description> <maml:para>Indicate whether the VM disk is encrypted.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>Capacity</maml:name> <maml:Description> <maml:para>The capacity of the source VM disk, in KBs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SourceDiskFormat</maml:name> <maml:Description> <maml:para>The format of the virtual disk.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.string</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SourcePath</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.DatastorePathData</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.DatastorePathData</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>SourceStoragePolicyName</maml:name> <maml:Description> <maml:para>The name of the storage policy of the source storage.</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" aliases="none"> <maml:name>SourceStoragePolicyId</maml:name> <maml:Description> <maml:para>The ID of the storage policy of the source storage.</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" aliases="none"> <maml:name>Label</maml:name> <maml:Description> <maml:para>The label of the VM disk.</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" aliases="none"> <maml:name>ControllerKey</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>ControllerLabel</maml:name> <maml:Description> <maml:para>The label of the VM disk.</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" aliases="none"> <maml:name>SupportedForReplication</maml:name> <maml:Description> <maml:para>Disks with certain types of controllers are not supported for replication. For example, NVMe, PCI, and SATA.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $DatastorePathData = Initialize-VrDatastorePathData -DatastoreId Datastore:datastore-16:ff4a23e7-2fed-4be0-be39-479ae372badd -DatastoreName local-datastore -Path /path/to/folder -Filename vmDisk1.vmdk $VmDiskDrResponseEntity = Initialize-VrVmDiskDrResponseEntity -VmId VirtualMachine:vm-80:e594ad24-5f75-41e3-a276-88a2116dbed0 -DeviceKey 0 -IsVmHome $false -Encrypted $false -Capacity 0 -SourceDiskFormat "SAME_AS_SOURCE" -SourcePath $DatastorePathData -SourceStoragePolicyName "MySourceStoragePolicyName" -SourceStoragePolicyId dsbrowser.defaultStoragePolicy -Label "MyLabel" -ControllerKey 0 -ControllerLabel "MyControllerLabel" -SupportedForReplication $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrVmDiskDrResponseEntity with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $VmDiskDrResponseEntity = Initialize-VrVmDiskDrResponseEntity </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrVmDiskDrResponseEntity with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/data-structures/VmDiskDrResponseEntity</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VrDatastorePathData</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VrVmDiskFindSeedSpec</command:name> <command:verb>Initialize</command:verb> <command:noun>VmDiskFindSeedSpec</command:noun> <maml:description> <maml:para>A spec to search for replication seeds based on the specified criteria for a given VM disk.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A spec to search for replication seeds based on the specified criteria for a given VM disk.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VrVmDiskFindSeedSpec</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmDisk</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.VmDiskIdentifier</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.VmDiskIdentifier</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DestinationPath</maml:name> <maml:Description> <maml:para>The disk destination path.</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" aliases="none"> <maml:name>UseWildcard</maml:name> <maml:Description> <maml:para>Indicate whether to use wildcard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</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" aliases="none"> <maml:name>VmDisk</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.VmDiskIdentifier</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.VmDiskIdentifier</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>DestinationPath</maml:name> <maml:Description> <maml:para>The disk destination path.</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" aliases="none"> <maml:name>UseWildcard</maml:name> <maml:Description> <maml:para>Indicate whether to use wildcard.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">bool</command:parameterValue> <dev:type> <maml:name>bool</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $VmDiskIdentifier = Initialize-VrVmDiskIdentifier -VmId VirtualMachine:vm-80:e594ad24-5f75-41e3-a276-88a2116dbed0 -DeviceKey 0 $VmDiskFindSeedSpec = Initialize-VrVmDiskFindSeedSpec -VmDisk $VmDiskIdentifier -DestinationPath "MyDestinationPath" -UseWildcard $false </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrVmDiskFindSeedSpec with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $VmDiskIdentifier = Initialize-VrVmDiskIdentifier -VmId VirtualMachine:vm-80:e594ad24-5f75-41e3-a276-88a2116dbed0 $VmDiskFindSeedSpec = Initialize-VrVmDiskFindSeedSpec -VmDisk $VmDiskIdentifier </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrVmDiskFindSeedSpec with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/data-structures/VmDiskFindSeedSpec</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VrVmDiskIdentifier</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VrVmDiskIdentifier</command:name> <command:verb>Initialize</command:verb> <command:noun>VmDiskIdentifier</command:noun> <maml:description> <maml:para>The unique identifier of the VM disk.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The unique identifier of the VM disk.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VrVmDiskIdentifier</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmId</maml:name> <maml:Description> <maml:para>The ID of the VM this disk is part of.</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" aliases="none"> <maml:name>DeviceKey</maml:name> <maml:Description> <maml:para>The device key of the source VM disk.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</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" aliases="none"> <maml:name>VmId</maml:name> <maml:Description> <maml:para>The ID of the VM this disk is part of.</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" aliases="none"> <maml:name>DeviceKey</maml:name> <maml:Description> <maml:para>The device key of the source VM disk.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$VmDiskIdentifier = Initialize-VrVmDiskIdentifier -VmId VirtualMachine:vm-80:e594ad24-5f75-41e3-a276-88a2116dbed0 -DeviceKey 0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrVmDiskIdentifier with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$VmDiskIdentifier = Initialize-VrVmDiskIdentifier -VmId VirtualMachine:vm-80:e594ad24-5f75-41e3-a276-88a2116dbed0 </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrVmDiskIdentifier with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/data-structures/VmDiskIdentifier</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-VrVmDiskSeedInformationDrResponseEntity</command:name> <command:verb>Initialize</command:verb> <command:noun>VmDiskSeedInformationDrResponseEntity</command:noun> <maml:description> <maml:para>A information about seeds found for a disk.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A information about seeds found for a disk.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-VrVmDiskSeedInformationDrResponseEntity</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>VmDisk</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.VmDiskIdentifier</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.VmDiskIdentifier</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FoundSeeds</maml:name> <maml:Description> <maml:para>The file paths where seed files are found.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<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" aliases="none"> <maml:name>VmDisk</maml:name> <maml:Description> <maml:para>No description available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">VMware.Bindings.Vr.Model.VmDiskIdentifier</command:parameterValue> <dev:type> <maml:name>VMware.Bindings.Vr.Model.VmDiskIdentifier</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" aliases="none"> <maml:name>FoundSeeds</maml:name> <maml:Description> <maml:para>The file paths where seed files are found.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">List<string></command:parameterValue> <dev:type> <maml:name>List<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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code> $VmDiskIdentifier = Initialize-VrVmDiskIdentifier -VmId VirtualMachine:vm-80:e594ad24-5f75-41e3-a276-88a2116dbed0 -DeviceKey 0 $VmDiskSeedInformationDrResponseEntity = Initialize-VrVmDiskSeedInformationDrResponseEntity -VmDisk $VmDiskIdentifier -FoundSeeds "MyFoundSeeds" </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrVmDiskSeedInformationDrResponseEntity with all parameters.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code> $VmDiskSeedInformationDrResponseEntity = Initialize-VrVmDiskSeedInformationDrResponseEntity </dev:code> <dev:remarks> <maml:para>Invoking Initialize-VrVmDiskSeedInformationDrResponseEntity with required parameters only.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://developer.broadcom.com/xapis/vsphere-replication-api/latest/data-structures/VmDiskSeedInformationDrResponseEntity</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Initialize-VrVmDiskIdentifier</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VrOperation</command:name> <command:verb>Get</command:verb> <command:noun>VrOperation</command:noun> <maml:description> <maml:para>This cmdlet retrieves the PowerCLI SDK cmdlets that correspond to one or more Vr API endpoints.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves the PowerCLI SDK cmdlets that correspond to one or more Vr API endpoints.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VrOperation</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Method</maml:name> <maml:description> <maml:para>The HTTP method to match. Can be any of the following "Get", "Head", "Post", "Delete", "Patch", "Put", "Trace", "Options"</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Get</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Head</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Post</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Delete</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Patch</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Put</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Trace</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Options</command:parameterValue> </command:parameterValueGroup> <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="1" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path for the API endpoint.</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="2" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the operation.</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="3" aliases="none"> <maml:name>Tag</maml:name> <maml:description> <maml:para>The tag in the Vr API specification for the target operation.</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>Method</maml:name> <maml:description> <maml:para>The HTTP method to match. Can be any of the following "Get", "Head", "Post", "Delete", "Patch", "Put", "Trace", "Options"</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="2" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the operation.</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="1" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path for the API endpoint.</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="3" aliases="none"> <maml:name>Tag</maml:name> <maml:description> <maml:para>The tag in the Vr API specification for the target operation.</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.Sdk.OpenApi.Cmdlets.ApiOperation</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>PS C:\> Get-VrOperation -Path '/api/example/operation1'</dev:code> <dev:remarks> <maml:para>This is an example of how to retrieve the Invoke-* cmdlet which corresponds to /api/example/operation1</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-VrOperation -Path '/api/example/operation1' -Method Post</dev:code> <dev:remarks> <maml:para>This is an example of how to retrieve the Invoke-* cmdlet which corresponds to the Post method on /api/example/operation1</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-VrOperation -Path '/api/example/*' -Method Post</dev:code> <dev:remarks> <maml:para>This is an example of how to retrieve all Invoke-* cmdlets which correspond to the Post methods on all endpoints under /api/example</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> Get-VrOperation -Path '/api/example/*/operation2'</dev:code> <dev:remarks> <maml:para>This is an example of how to escape dynamic subsections of an API path like entity identifiers. In this example the path contains an identifier that is not in its last segment - /api/example/{id}/operation2</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |