net45/VMware.VimAutomation.Storage.Commands.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <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"> <command:details> <command:name>Add-KeyManagementServer</command:name> <maml:description> <maml:para>This cmdlet adds a key management server to a vCenter Server system.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>KeyManagementServer</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet adds a key management server to a vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-KeyManagementServer</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Key Management Interoperability Protocol server you want to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "2" > <maml:name>KmsCluster</maml:name> <maml:description> <maml:para>Specifies the key management server cluster to which you want to add the key management server. This parameter also accepts objects of type KmsCluster through an ArgumentTransformationAttribute object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Address</maml:name> <maml:description> <maml:para>Specifies the address of the Key Management Interoperability Protocol server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port number of the Key Management Interoperability Protocol server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>TrustKeyManagementServer</maml:name> <maml:description> <maml:para>Indicates whether the vCenter Server system can trust the key management server certificate.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ProxyAddress</maml:name> <maml:description> <maml:para>Specifies the address of the proxy server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Specifies the port number of the proxy server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Username</maml:name> <maml:description> <maml:para>Specifies the user name you want to use for authenticating with the Key Management Interoperability Protocol server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password you want to use for authenticating with the Key Management Interoperability Protocol server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >SecureString</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a PSCredential object that contains credentials for authenticating with the key management server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >PSCredential</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Key Management Interoperability Protocol server you want to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>KmsCluster</maml:name> <maml:description> <maml:para>Specifies the key management server cluster to which you want to add the key management server. This parameter also accepts objects of type KmsCluster through an ArgumentTransformationAttribute 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Address</maml:name> <maml:description> <maml:para>Specifies the address of the Key Management Interoperability Protocol 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port number of the Key Management Interoperability Protocol server.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TrustKeyManagementServer</maml:name> <maml:description> <maml:para>Indicates whether the vCenter Server system can trust the key management server certificate.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProxyAddress</maml:name> <maml:description> <maml:para>Specifies the address of the proxy 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Specifies the port number of the proxy server.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Username</maml:name> <maml:description> <maml:para>Specifies the user name you want to use for authenticating with the Key Management Interoperability Protocol 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password you want to use for authenticating with the Key Management Interoperability Protocol 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a PSCredential object that contains credentials for authenticating with the key management server.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The newly added KeyManagementServer object</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-KeyManagementServer -Name 'KMS' -KmsCluster 'KmsCluster' -Address $kmsAddress -Port $kmsPort -ProxyAddress $proxyAddress -ProxyPort $proxyPort -TrustKeyManagementServer $true</dev:code> <dev:remarks> <maml:para>Adds the key management server named 'KMS' to the 'KmsCuster' cluster that runs at the $kmsAddress address, $kmsPort port, and trusts the key management server certificate.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Add-KeyManagementServer.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-KeyManagementServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-KeyManagementServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-KeyManagementServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Copy-VDisk</command:name> <maml:description> <maml:para>This cmdlet copies the specified VDisk objects to the specified datastore.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Copy</command:verb> <command:noun>VDisk</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet copies the specified VDisk objects to the specified datastore. For RDM (RawVDisk), only one VDisk can be copied at once, and only copying from VMFS to VMFS is supported.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Copy-VDisk</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "1" > <maml:name>VDisk</maml:name> <maml:description> <maml:para>Specifies the VDisk objects you want to copy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VDisk[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the copy of the VDisk object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>StorageFormat</maml:name> <maml:description> <maml:para>Specifies the storage format of the copy of the VDisk object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VDiskStorageFormat</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "true" pipelineInput = "false" position = "2" > <maml:name>Datastore</maml:name> <maml:description> <maml:para>Specifies the datastore to which you want to copy the metadata of the VDisk object. For flat disk, the contents of the disk are also copied to the specified datastore.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Datastore</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Copy-VDisk</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "1" > <maml:name>VDisk</maml:name> <maml:description> <maml:para>Specifies the VDisk objects you want to copy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VDisk[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the copy of the VDisk object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "true" pipelineInput = "false" position = "2" > <maml:name>Datastore</maml:name> <maml:description> <maml:para>Specifies the datastore to which you want to copy the metadata of the VDisk object. For flat disk, the contents of the disk are also copied to the specified datastore.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Datastore</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ScsiLun</maml:name> <maml:description> <maml:para>Specifies the backing SCSI LUN for the copy of the VDisk object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ScsiLun</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>VDisk</maml:name> <maml:description> <maml:para>Specifies the VDisk objects you want to copy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VDisk[]</command:parameterValue> <dev:type> <maml:name>VDisk[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the copy of the VDisk 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageFormat</maml:name> <maml:description> <maml:para>Specifies the storage format of the copy of the VDisk object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VDiskStorageFormat</command:parameterValue> <dev:type> <maml:name>VDiskStorageFormat</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="false" position="2"> <maml:name>Datastore</maml:name> <maml:description> <maml:para>Specifies the datastore to which you want to copy the metadata of the VDisk object. For flat disk, the contents of the disk are also copied to the specified datastore.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Datastore</command:parameterValue> <dev:type> <maml:name>Datastore</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ScsiLun</maml:name> <maml:description> <maml:para>Specifies the backing SCSI LUN for the copy of the VDisk object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ScsiLun</command:parameterValue> <dev:type> <maml:name>ScsiLun</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The newly created copies of the specified VDisk objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Copy-VDisk -VDisk $vDisk -Datastore $ds</dev:code> <dev:remarks> <maml:para>Copies the flat VDisk object $vDisk on the $ds datastore.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Copy-VDisk -VDisk $vDisk -ScsiLun $scsiLun -Datastore $ds</dev:code> <dev:remarks> <maml:para>Copies the raw VDisk object $vDisk on the $scsiLun SCSI LUN and stores metadata of this object on the $ds datastore.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Copy-VDisk.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Export-SpbmStoragePolicy</command:name> <maml:description> <maml:para>This cmdlet exports the specified storage policy to a file.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Export</command:verb> <command:noun>SpbmStoragePolicy</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet exports the specified storage policy to a file. If the Force parameter is not specified and the destination file exists or the target parent directory does not exist, a terminating error is generated. If the folder specified for the FilePath parameter exists, the policy name is used to name the target file. The Force and Destination parameters follow the rules described in PowerCLI Usability Guidelines, Destination and Force parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-SpbmStoragePolicy</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>FilePath</maml:name> <maml:description> <maml:para>Specifies the path to the file or directory where you want to export the storage policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "true" pipelineInput = "true (ByValue)" position = "2" > <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies the storage policy you want to export.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >SpbmStoragePolicy</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates whether the cmdlet overwrites the existing destination files.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VIServer</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Specifies the path to the file or directory where you want to export 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="true (ByValue)" position="2"> <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies the storage policy you want to export.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SpbmStoragePolicy</command:parameterValue> <dev:type> <maml:name>SpbmStoragePolicy</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates whether the cmdlet overwrites the existing destination files.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VIServer</command:parameterValue> <dev:type> <maml:name>VIServer</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo for the exported file</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Works only with vCenter Server 5.5 or later. For more information, see the VMware Storage Policy API Reference: https://pubs.vmware.com/vsphere-60/index.jsp#com.vmware.vspsdk.apiref.doc/right-pane.html</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Export-SpbmStoragePolicy -StoragePolicy $policy -FilePath C:\policies\</dev:code> <dev:remarks> <maml:para>Exports a storage policy to a file in C:\policies\. If the C:\policies\ directory exists, a file with the name of the policy is created in this directory.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Export-SpbmStoragePolicy -StoragePolicy $policy -FilePath C:\policy.xml -Force</dev:code> <dev:remarks> <maml:para>Exports a storage policy to the policy.xml file in C:\. If a file with the same name already exists in this location, the file is overwritten. Note: If you do not use the Force parameter, the command returns an error about the existing file.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Export-SpbmStoragePolicy.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-KeyManagementServer</command:name> <maml:description> <maml:para>This cmdlet retrieves the key management servers registered on the vCenter Server system.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>KeyManagementServer</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves the key management servers registered on the vCenter Server system and can filter the result by name, key management server cluster, key management server address, and ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-KeyManagementServer</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name or alias of the key management server you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "2" > <maml:name>KmsCluster</maml:name> <maml:description> <maml:para>Specifies the list of the key management server clusters by which you want to filter the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >KmsCluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-KeyManagementServer</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Address</maml:name> <maml:description> <maml:para>Specifies the IPv4, IPv6, or DNS address of the key management server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-KeyManagementServer</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the IDs of the key management servers you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name or alias of the key management server you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="2"> <maml:name>KmsCluster</maml:name> <maml:description> <maml:para>Specifies the list of the key management server clusters by which you want to filter the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">KmsCluster[]</command:parameterValue> <dev:type> <maml:name>KmsCluster[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Address</maml:name> <maml:description> <maml:para>Specifies the IPv4, IPv6, or DNS address of the key management server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the IDs of the key management servers you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more KeyManagementServer objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-KeyManagementServer -Server $myServer</dev:code> <dev:remarks> <maml:para>Retrieves all key management servers on the $myServer vCenter Server system.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-KeyManagementServer -Name 'KMS'</dev:code> <dev:remarks> <maml:para>Retrieves a key management server named 'KMS'.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-KeyManagementServer.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-KeyManagementServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-KeyManagementServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-KeyManagementServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-KmipClientCertificate</command:name> <maml:description> <maml:para>This cmdlet retrieves the latest generated self-signed certificate or certificate-signing request for the key management server cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>KmipClientCertificate</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves the latest generated self-signed certificate or certificate-signing request for the key management server cluster. The self-signed certificate or certificate-signing request is available until the key management server cluster is updated with the generated certificate by using the Set-KmsCluster cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-KmipClientCertificate</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>KmsCluster</maml:name> <maml:description> <maml:para>Specifies the key management server cluster for which you want to use the certificate as a client certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >KmsCluster</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CertificateSigningRequest</maml:name> <maml:description> <maml:para>Indicates whether a certificate-signing request should be retrieved. This certificate-signing request should be signed by the key management server and uploaded to the vCenter Server system.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>FilePath</maml:name> <maml:description> <maml:para>Specifies the file path to which you want to export the self-signed certificate or certificate-signing request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>KmsCluster</maml:name> <maml:description> <maml:para>Specifies the key management server cluster for which you want to use the certificate as a client certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">KmsCluster</command:parameterValue> <dev:type> <maml:name>KmsCluster</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CertificateSigningRequest</maml:name> <maml:description> <maml:para>Indicates whether a certificate-signing request should be retrieved. This certificate-signing request should be signed by the key management server and uploaded to the vCenter Server system.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Specifies the file path to which you want to export the self-signed certificate or certificate-signing request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The self-signed client certificate or the certificate-signing request to be signed by the key management server</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-KmipClientCertificate -KmsCluster $kmsCluster</dev:code> <dev:remarks> <maml:para>Retrieves the latest generated self-signed client certificate for the $kmsCluster key management server cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-KmipClientCertificate -KmsCluster $kmsCluster -CertificateSigningRequest -FilePath $filePath</dev:code> <dev:remarks> <maml:para>Retrieves the latest generated certificate-signing request for the $kmsCluster key management server cluster and exports it to the $filePath file path.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-KmipClientCertificate.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-KmipClientCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-KmsCluster</command:name> <maml:description> <maml:para>This cmdlet retrieves all key management server clusters from the vCenter Server system.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>KmsCluster</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves all key management server clusters from the vCenter Server system.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-KmsCluster</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the key management server clusters you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-KmsCluster</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the IDs of the key management server clusters you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the key management server clusters you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the IDs of the key management server clusters you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more KmsCluster objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-KmsCluster -Server $myServer</dev:code> <dev:remarks> <maml:para>Retrieves all key management server clusters from the $myServer vCenter Server system.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-KmsCluster -Name 'ThalesCluster'</dev:code> <dev:remarks> <maml:para>Retrieves a key management server cluster named 'ThalesCluster'.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-KmsCluster.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-KmsCluster</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-NfsUser</command:name> <maml:description> <maml:para>This cmdlet retrieves NFS user accounts.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NfsUser</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves NFS user accounts.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NfsUser</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "1" > <maml:name>Username</maml:name> <maml:description> <maml:para>Filters the retrieved NFS user accounts by user name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>VMHost</maml:name> <maml:description> <maml:para>Specifies the virtual machine hosts for which you want to retrieve NFS user accounts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VMHost[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Username</maml:name> <maml:description> <maml:para>Filters the retrieved NFS user accounts by user name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>VMHost</maml:name> <maml:description> <maml:para>Specifies the virtual machine hosts for which you want to retrieve NFS user accounts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VMHost[]</command:parameterValue> <dev:type> <maml:name>VMHost[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more NfsUser objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-NfsUser -VMHost $vmhost</dev:code> <dev:remarks> <maml:para>Retrieves the NFS user accounts from the specified host.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-NfsUser -Username MyUser*</dev:code> <dev:remarks> <maml:para>Retrieves all NFS user accounts that have a user name which starts with MyUser.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-NfsUser.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-NfsUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-NfsUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-NfsUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-SpbmCapability</command:name> <maml:description> <maml:para>This cmdlet retrieves capability schema.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SpbmCapability</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves capability schema sorted by alphabetical order of the Name field. Each capability schema object has a unique identifier and contains the namespace to which the capability schema object belongs. Each registered namespace must be unique. You can relate a capability schema object with a unique vendor and resource type by using the namespace. After any VAIOFilter CRUD operation, there is an expected delay of approximately 30 seconds before the changes are reflected in the Get-SpbmCapability cmdlet. To discover a namespace, run "Get-SpbmCapability | select Namespace -unique".</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SpbmCapability</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Optional filter, based on full name of the capability schema object you want to retrieve. The full name must be in the format <namespace>.<CapabilityId> for the capability that contains only one property or <namespace>.<CapabilityId>.<PropertyId> for the capability that contains more than one property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Category</maml:name> <maml:description> <maml:para>Specifies the capability sub category of the capability schema object you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Optional filter, based on full name of the capability schema object you want to retrieve. The full name must be in the format <namespace>.<CapabilityId> for the capability that contains only one property or <namespace>.<CapabilityId>.<PropertyId> for the capability that contains more than one property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Category</maml:name> <maml:description> <maml:para>Specifies the capability sub category of the capability schema object you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List of SpbmCapability objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Works only with vCenter Server 5.5 or later. For more information, see the VMware Storage Policy API Reference: https://pubs.vmware.com/vsphere-60/index.jsp#com.vmware.vspsdk.apiref.doc/right-pane.html</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-SpbmCapability -Name "VSAN.stripeWidth"</dev:code> <dev:remarks> <maml:para>Returns all SPBM capability schemas named "VSAN.stripeWidth". The name is unique for the capability schemas.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-SpbmCapability -Name VSAN*</dev:code> <dev:remarks> <maml:para>Returns all SPBM capability schemas whose name starts with VSAN.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-SpbmCapability -Name "VSAN*" -Category "Performance"</dev:code> <dev:remarks> <maml:para>Returns all SPBM capability schemas whose name starts with "VSAN" and are of category "Performance".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 4 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-SpbmCapability -Name IOFILTERS*</dev:code> <dev:remarks> <maml:para>Retrieves all capabilities from the VAIOFilter namespace.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-SpbmCapability.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-SpbmCompatibleStorage</command:name> <maml:description> <maml:para>This cmdlet performs placement compatibility checking based on a storage requirement policy.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SpbmCompatibleStorage</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet performs placement compatibility checking based on a storage requirement policy. If the compatibility checking for a hub does not produce any errors, the hub is considered as a viable candidate for virtual machine file storage. When the CandidateStorage parameter is specified, each object in the output is equal to some of the objects in the input (the -eq operation returns true).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SpbmCompatibleStorage</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies a storage requirement policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >SpbmStoragePolicy</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>CandidateStorage</maml:name> <maml:description> <maml:para>Specifies a list of datastores and storage pods that are candidates for storage resources. If you do not specify this parameter, the server uses all of the datastores and storage pods for placement compatibility checking.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >StorageResource[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies a storage requirement policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SpbmStoragePolicy</command:parameterValue> <dev:type> <maml:name>SpbmStoragePolicy</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>CandidateStorage</maml:name> <maml:description> <maml:para>Specifies a list of datastores and storage pods that are candidates for storage resources. If you do not specify this parameter, the server uses all of the datastores and storage pods for placement compatibility checking.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">StorageResource[]</command:parameterValue> <dev:type> <maml:name>StorageResource[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List of storage resources (datastores and storage pods) matching the policy</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Works only with vCenter Server 5.5 or later. For more information, see the VMware Storage Policy API Reference: https://pubs.vmware.com/vsphere-60/index.jsp#com.vmware.vspsdk.apiref.doc/right-pane.html</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-SpbmCompatibileStorage -StoragePolicy $policy</dev:code> <dev:remarks> <maml:para>Returns all datastores and datastore clusters that are in compliance with storage policy.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-SpbmCompatibileStorage -StoragePolicy $policy -CandidateStorage $ListOfDatastoreOrDatastoreCluster</dev:code> <dev:remarks> <maml:para>Returns all datastores and datastore clusters from the $ListOfDatastoreOrDatastoreCluster list that are in compliance with the $policy storage policy.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-SpbmCompatibleStorage.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-SpbmEntityConfiguration</command:name> <maml:description> <maml:para>This cmdlet retrieves SPBM-related configuration data of Virtual Machine, Hard Disk and Cluster objects.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SpbmEntityConfiguration</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves SPBM-related configuration data of Virtual Machine, Hard Disk and Cluster objects. The configuration data includes: 1. Associated storage policy for virtual machines or hard disks. 2. Compliance status for virtual machines or hard disks. 3. SPBM enablement status for cluster.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SpbmEntityConfiguration</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies the storage policies against which the compliance status will be evaluated. A storage policy can be associated with one or multiple StorageObjects (VM Home or Disks). There will be one association object with compliance status for each policy - entity combination. If no storage policy is specified, the cmdlet returns the status for all available storage policies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SpbmStoragePolicy[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>VMsOnly</maml:name> <maml:description> <maml:para>If the value is $true, retrieves the configuration data only for virtual machines.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>HardDisksOnly</maml:name> <maml:description> <maml:para>If the value is $true, retrieves the configuration data only for hard disks.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CheckComplianceNow</maml:name> <maml:description> <maml:para>If the value is $true, checks the compliance status and updates the server cache. If $false, returns the latest available compliance status from the server cache.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SpbmEntityConfiguration</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machines, hard disks, and clusters, for which you want to retrieve SPBM-related configuration data.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIObject[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>HardDisk</maml:name> <maml:description> <maml:para>Specifies virtual disks for which you want to check compliance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >HardDisk[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the clusters, for which you want to check whether SPBM is enabled or disabled on them.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Cluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CheckComplianceNow</maml:name> <maml:description> <maml:para>If the value is $true, checks the compliance status and updates the server cache. If $false, returns the latest available compliance status from the server cache.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies the storage policies against which the compliance status will be evaluated. A storage policy can be associated with one or multiple StorageObjects (VM Home or Disks). There will be one association object with compliance status for each policy - entity combination. If no storage policy is specified, the cmdlet returns the status for all available storage policies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SpbmStoragePolicy[]</command:parameterValue> <dev:type> <maml:name>SpbmStoragePolicy[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VMsOnly</maml:name> <maml:description> <maml:para>If the value is $true, retrieves the configuration data only for virtual machines.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HardDisksOnly</maml:name> <maml:description> <maml:para>If the value is $true, retrieves the configuration data only for hard disks.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CheckComplianceNow</maml:name> <maml:description> <maml:para>If the value is $true, checks the compliance status and updates the server cache. If $false, returns the latest available compliance status from the server cache.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machines, hard disks, and clusters, for which you want to retrieve SPBM-related configuration data.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIObject[]</command:parameterValue> <dev:type> <maml:name>VIObject[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>HardDisk</maml:name> <maml:description> <maml:para>Specifies virtual disks for which you want to check compliance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">HardDisk[]</command:parameterValue> <dev:type> <maml:name>HardDisk[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the clusters, for which you want to check whether SPBM is enabled or disabled on them.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Cluster[]</command:parameterValue> <dev:type> <maml:name>Cluster[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more objects derived from SpbmEntityConfiguration</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Works only with vCenter Server 5.5 or later. For more information, see the VMware Storage Policy API Reference: https://pubs.vmware.com/vsphere-60/index.jsp#com.vmware.vspsdk.apiref.doc/right-pane.html</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-SpbmEntityConfiguration -StoragePolicy $policy</dev:code> <dev:remarks> <maml:para>Returns the SPBM configuration and compliance status of all Virtual Machine and Hard Disk objects associated with the $policy storage policy.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-SpbmEntityConfiguration -StoragePolicy $policy -CheckComplianceNow</dev:code> <dev:remarks> <maml:para>Returns the SPBM configuration and compliance status of all Virtual Machine and Hard Disk objects associated with the $policy storage policy and updates the server cache.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-SpbmEntityConfiguration -StoragePolicy $policy -HardDisksOnly</dev:code> <dev:remarks> <maml:para>Returns the SPBM configuration and compliance status of all Hard Disk objects associated with the $policy storage policy.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 4 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-SpbmEntityConfiguration -VM $vm1, $vm2 -CheckComplianceNow</dev:code> <dev:remarks> <maml:para>Returns the SPBM configuration and compliance status of the $vm1 and $vm2 virtual machines and updates the server cache.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 5 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-SpbmEntityConfiguration -HardDisk (Get-HardDisk -VM $vm1) -Cluster $cluster1</dev:code> <dev:remarks> <maml:para>Returns the SPBM configuration and compliance status of all Hard Disk objects of the $vm1 virtual machine and the SPBM configuration status of the $cluster1 cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 6 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-SpbmEntityConfiguration $vm1, $vm2, $hd1, $cluster1</dev:code> <dev:remarks> <maml:para>Returns the SPBM configuration and compliance status of the $vm1 and $vm2 virtual machines, the $hd1 hard disk, and the $cluster1 cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-SpbmEntityConfiguration.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-SpbmEntityConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-SpbmFaultDomain</command:name> <maml:description> <maml:para>This cmdlet retrieves fault domains based on name or ID filter.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SpbmFaultDomain</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves fault domains based on name or ID filter. The fault domain ID is globally unique.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SpbmFaultDomain</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Filters the retrieved fault domains by name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>VasaProvider</maml:name> <maml:description> <maml:para>Specifies the list of VASA providers. You can retrieve fault domains reported by these VASA providers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VasaProvider[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SpbmFaultDomain</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Id</maml:name> <maml:description> <maml:para>Filters the retrieved fault domains by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filters the retrieved fault domains by name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>VasaProvider</maml:name> <maml:description> <maml:para>Specifies the list of VASA providers. You can retrieve fault domains reported by these VASA providers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VasaProvider[]</command:parameterValue> <dev:type> <maml:name>VasaProvider[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Filters the retrieved fault domains by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more SpbmFaultDomain objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-SpbmFaultDomain -Name 'FaultDomain' -VasaProvider $vasaProvider</dev:code> <dev:remarks> <maml:para>Retrieves fault domains named 'FaultDomain' from the $vasaProvider VASA provider.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-SpbmFaultDomain -Id 'FaultDomainId'</dev:code> <dev:remarks> <maml:para>Retrieves the fault domain with ID 'FaultDomainId'.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-SpbmFaultDomain.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-SpbmPointInTimeReplica</command:name> <maml:description> <maml:para>This cmdlet retrieves the point in time replica objects for the specified target replication groups.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SpbmPointInTimeReplica</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves the point in time replica objects for the specified target replication groups. The cmdlet retrieves the point in time replicas by replication group, from date (inclusive), to date (exclusive), name, VASA tag, VASA provider, and replica ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SpbmPointInTimeReplica</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Filters the retrieved point in time replica objects by name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>ReplicationGroup</maml:name> <maml:description> <maml:para>Specifies the target replication group for which you want to retrieve replica objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SpbmReplicationGroup[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>VasaTag</maml:name> <maml:description> <maml:para>Restricts results to replica objects that have at least one of the specified VASA tags. The tags are case-sensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>VasaProvider</maml:name> <maml:description> <maml:para>Specifies the VASA provider from which you want to retrieve replica objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VasaProvider[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>FromDate</maml:name> <maml:description> <maml:para>Retrieves point in time replica objects created on the specified date or later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DateTime</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ToDate</maml:name> <maml:description> <maml:para>Retrieves point in time replica objects created earlier than the specified date.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DateTime</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Count</maml:name> <maml:description> <maml:para>Specifies the number of point in time replica objects you want to retrieve for each replication group. This restricts the result to a maximum count number of replica objects for each replication group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SpbmPointInTimeReplica</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Id</maml:name> <maml:description> <maml:para>Filters the retrieved point in time replica objects by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filters the retrieved point in time replica objects by name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>ReplicationGroup</maml:name> <maml:description> <maml:para>Specifies the target replication group for which you want to retrieve replica objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SpbmReplicationGroup[]</command:parameterValue> <dev:type> <maml:name>SpbmReplicationGroup[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>VasaTag</maml:name> <maml:description> <maml:para>Restricts results to replica objects that have at least one of the specified VASA tags. The tags are case-sensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>VasaProvider</maml:name> <maml:description> <maml:para>Specifies the VASA provider from which you want to retrieve replica objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VasaProvider[]</command:parameterValue> <dev:type> <maml:name>VasaProvider[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FromDate</maml:name> <maml:description> <maml:para>Retrieves point in time replica objects created on the specified date or later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ToDate</maml:name> <maml:description> <maml:para>Retrieves point in time replica objects created earlier than the specified date.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Count</maml:name> <maml:description> <maml:para>Specifies the number of point in time replica objects you want to retrieve for each replication group. This restricts the result to a maximum count number of replica objects for each replication group.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Filters the retrieved point in time replica objects by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more SpbmPointInTimeReplica objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-SpbmPointInTimeReplica -ReplicationGroup $targetRg</dev:code> <dev:remarks> <maml:para>Retrieves all point in time replicas from the $targetRg target replication group.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-SpbmPointInTimeReplica -VasaProvider $vasaProvider -FromDate $from -ToDate $to</dev:code> <dev:remarks> <maml:para>Retrieves point in time replicas created between $from and $to by the $vasaProvider VASA provider for all its target replication groups.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-SpbmPointInTimeReplica.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-SpbmReplicationGroup</command:name> <maml:description> <maml:para>This cmdlet retrieves replication groups.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SpbmReplicationGroup</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves replication groups. The replication groups can be of type source or target.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SpbmReplicationGroup</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies names of replication groups you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>FaultDomain</maml:name> <maml:description> <maml:para>Specifies the fault domains which the replication groups are in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SpbmFaultDomain[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>VasaProvider</maml:name> <maml:description> <maml:para>Specifies the VASA provider to retrieve replication groups from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VasaProvider[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>FailedOver</maml:name> <maml:description> <maml:para>Returns only failed over replication groups.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SpbmReplicationGroup</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies names of replication groups you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies the storage policy to which the replication groups comply.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >SpbmStoragePolicy</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Datastore</maml:name> <maml:description> <maml:para>Specifies the datastore to which replication groups apply. If not specified, all datastores which are compatible with the specified storage policy are considered.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Datastore[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SpbmReplicationGroup</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Id</maml:name> <maml:description> <maml:para>Filters the retrieved replication groups by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SpbmReplicationGroup</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machines to which replication groups apply. This parameter accepts both virtual machine and hard disk objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIObject[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>HardDisk</maml:name> <maml:description> <maml:para>Specifies virtual disk objects to which replication groups apply.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >HardDisk[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies names of replication groups you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>FaultDomain</maml:name> <maml:description> <maml:para>Specifies the fault domains which the replication groups are in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SpbmFaultDomain[]</command:parameterValue> <dev:type> <maml:name>SpbmFaultDomain[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>VasaProvider</maml:name> <maml:description> <maml:para>Specifies the VASA provider to retrieve replication groups from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VasaProvider[]</command:parameterValue> <dev:type> <maml:name>VasaProvider[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FailedOver</maml:name> <maml:description> <maml:para>Returns only failed over replication groups.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies the storage policy to which the replication groups comply.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SpbmStoragePolicy</command:parameterValue> <dev:type> <maml:name>SpbmStoragePolicy</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Datastore</maml:name> <maml:description> <maml:para>Specifies the datastore to which replication groups apply. If not specified, all datastores which are compatible with the specified storage policy are considered.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Datastore[]</command:parameterValue> <dev:type> <maml:name>Datastore[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Filters the retrieved replication groups by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>VM</maml:name> <maml:description> <maml:para>Specifies the virtual machines to which replication groups apply. This parameter accepts both virtual machine and hard disk objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIObject[]</command:parameterValue> <dev:type> <maml:name>VIObject[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>HardDisk</maml:name> <maml:description> <maml:para>Specifies virtual disk objects to which replication groups apply.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">HardDisk[]</command:parameterValue> <dev:type> <maml:name>HardDisk[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more SpbmReplicationGroup objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-SpbmReplicationGroup -Name 'ReplicationGroup' -FaultDomain $faultDomain</dev:code> <dev:remarks> <maml:para>Retrieves replication groups named 'ReplicationGroup' in the $faultDomain fault domain.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-SpbmReplicationGroup -Datastore $datastore -StoragePolicy $policy</dev:code> <dev:remarks> <maml:para>Retrieves replication groups which are applicable to the $datastore datastore and comply with the $policy storage policy.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-SpbmReplicationGroup -VM $vm -HardDisk $hd</dev:code> <dev:remarks> <maml:para>Retrieves replication groups which are associated with the $vm virtual machine and the $hd hard disk.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-SpbmReplicationGroup.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-SpbmReplicationPair</command:name> <maml:description> <maml:para>This cmdlet retrieves the relation of replication groups in a pair of source and target replication group.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SpbmReplicationPair</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves the relation of replication groups in a pair of source and target replication group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SpbmReplicationPair</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>SourceFaultDomain</maml:name> <maml:description> <maml:para>Specifies the list of fault domains to get source replication group of the pair.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SpbmFaultDomain[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>TargetFaultDomain</maml:name> <maml:description> <maml:para>Specifies the list of fault domains to get target replication group of the pair.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SpbmFaultDomain[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Source</maml:name> <maml:description> <maml:para>Specifies the source replication group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SpbmReplicationGroup[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the target replication group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SpbmReplicationGroup[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>SourceFaultDomain</maml:name> <maml:description> <maml:para>Specifies the list of fault domains to get source replication group of the pair.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SpbmFaultDomain[]</command:parameterValue> <dev:type> <maml:name>SpbmFaultDomain[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>TargetFaultDomain</maml:name> <maml:description> <maml:para>Specifies the list of fault domains to get target replication group of the pair.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SpbmFaultDomain[]</command:parameterValue> <dev:type> <maml:name>SpbmFaultDomain[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Source</maml:name> <maml:description> <maml:para>Specifies the source replication group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SpbmReplicationGroup[]</command:parameterValue> <dev:type> <maml:name>SpbmReplicationGroup[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the target replication group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SpbmReplicationGroup[]</command:parameterValue> <dev:type> <maml:name>SpbmReplicationGroup[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more SpbmReplicationPair objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-SpbmReplicationPair -Source $rg</dev:code> <dev:remarks> <maml:para>Retrieves replication pairs for which the $rg replication group is source group.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-SpbmReplicationPair -SourceFaultDomain $sourceFd -TargetFaultDomain $targetFd</dev:code> <dev:remarks> <maml:para>Retrieves replication pairs for which the source replication group is in the $sourceFd fault domain and the target replication group is in the $targetFd fault domain.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-SpbmReplicationPair.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-SpbmStoragePolicy</command:name> <maml:description> <maml:para>This cmdlet returns all available requirement policies and resource policies.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SpbmStoragePolicy</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet returns all available requirement policies and resource policies.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SpbmStoragePolicy</maml:name> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Requirement</maml:name> <maml:description> <maml:para>Specifies the policy category. Policy category can be either "requirement" or "resource". If nothing specified, retrieves both.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Resource</maml:name> <maml:description> <maml:para>Specifies the policy category. Policy category can be either "requirement" or "resource". If nothing specified, retrieves both.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Filters the storage policies by name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Namespace</maml:name> <maml:description> <maml:para>Filters the storage policies by namespace.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Capability</maml:name> <maml:description> <maml:para>Filters the storage policies by capability schema.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SpbmCapability[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Tag</maml:name> <maml:description> <maml:para>Filters the storage policies by tag.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Tag[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SpbmStoragePolicy</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Id</maml:name> <maml:description> <maml:para>Filters the storage policies by ID. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Requirement</maml:name> <maml:description> <maml:para>Specifies the policy category. Policy category can be either "requirement" or "resource". If nothing specified, retrieves both.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Specifies the policy category. Policy category can be either "requirement" or "resource". If nothing specified, retrieves both.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filters the storage policies by name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Namespace</maml:name> <maml:description> <maml:para>Filters the storage policies by namespace.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Capability</maml:name> <maml:description> <maml:para>Filters the storage policies by capability schema.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SpbmCapability[]</command:parameterValue> <dev:type> <maml:name>SpbmCapability[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Filters the storage policies by tag.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Tag[]</command:parameterValue> <dev:type> <maml:name>Tag[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Filters the storage policies by ID. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List of SpbmStoragePolicy objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Works only with vCenter Server 5.5 or later. For more information, see the VMware Storage Policy API Reference: https://pubs.vmware.com/vsphere-60/index.jsp#com.vmware.vspsdk.apiref.doc/right-pane.html</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-SpbmStoragePolicy -Name "MyPolicy"</dev:code> <dev:remarks> <maml:para>Returns all storage policies named "MyPolicy".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-SpbmStoragePolicy -Requirement -Namespace "VSAN" -Tag $tag1, $tag2</dev:code> <dev:remarks> <maml:para>Returns all storage policies of type Requirement containing one or more rules which contain one or more capabilities from the "VSAN" namespace and any of the $tag1 or $tag2 tags.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-SpbmStoragePolicy -Id "PolicyId"</dev:code> <dev:remarks> <maml:para>Returns a storage policy with ID "PolicyId".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-SpbmStoragePolicy.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-VAIOFilter</command:name> <maml:description> <maml:para>This cmdlet returns a list of VAIOFilter objects filtered by the specified parameters.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>VAIOFilter</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet returns a list of VAIOFilter objects filtered by the specified parameters. If no parameters are specified, the cmdlet returns all filters installed on all default servers.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VAIOFilter</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the VAIO filter you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the clusters on which to search for VAIO filters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Cluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VAIOFilter</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Id</maml:name> <maml:description> <maml:para>Filters the VAIO filters by ID. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the VAIO filter you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the clusters on which to search for VAIO filters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Cluster[]</command:parameterValue> <dev:type> <maml:name>Cluster[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Filters the VAIO filters by ID. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more VAIOFilter objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Works only with vCenter Server 6.0 or later.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VAIOFilter -Name "MyVAIOFilter"</dev:code> <dev:remarks> <maml:para>Retrieves all VAIO filters named "MyVAIOFilter".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VAIOFilter -Name "MyVAIOFilter" -Cluster $cluster</dev:code> <dev:remarks> <maml:para>Retrieves the VAIO filter named "MyVAIOFilter" from the $cluster cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VAIOFilter -Id "MyVAIOFilterId"</dev:code> <dev:remarks> <maml:para>Retrieves all VAIO filters with ID "MyVAIOFilterId".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-VAIOFilter.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VAIOFilter</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VAIOFilter</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VAIOFilter</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-VasaProvider</command:name> <maml:description> <maml:para>This cmdlet retrieves the list of VASA providers that are currently registered with Storage Manager.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>VasaProvider</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves the list of VASA providers that are currently registered with Storage Manager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VasaProvider</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Filters the retrieved providers by name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Refresh</maml:name> <maml:description> <maml:para>Synchronizes the providers before retrieving data. The operation is synchronous.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VasaProvider</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Id</maml:name> <maml:description> <maml:para>Filters the retrieved providers by ID. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Refresh</maml:name> <maml:description> <maml:para>Synchronizes the providers before retrieving data. The operation is synchronous.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filters the retrieved providers by name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Synchronizes the providers before retrieving data. The operation is synchronous.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Filters the retrieved providers by ID. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more VasaProvider objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VasaProvider -Name "MyProvider"</dev:code> <dev:remarks> <maml:para>Retrieves all VASA providers named "MyProvider".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VasaProvider -Name "MyProvider" -Refresh</dev:code> <dev:remarks> <maml:para>Synchronizes the providers and retrieves the VASA provider named "MyProvider".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VasaProvider -Id "MyProviderId"</dev:code> <dev:remarks> <maml:para>Retrieves all VASA providers with ID set to "MyProviderId".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-VasaProvider.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VasaProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VasaProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-VasaStorageArray</command:name> <maml:description> <maml:para>This cmdlet retrieves the list of storage arrays managed by registered VASA providers.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>VasaStorageArray</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves the list of storage arrays managed by registered VASA providers.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VasaStorageArray</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Filters the retrieved storage arrays by name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>VasaProvider</maml:name> <maml:description> <maml:para>Filters the retrieved storage arrays by provider. If not specified, all storage arrays are retrieved. You can retrieve the provider objects by using the Get-VasaProvider cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VasaProvider[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Refresh</maml:name> <maml:description> <maml:para>Synchronizes the storage arrays before retrieving data. The operation is synchronous.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VasaStorageArray</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Id</maml:name> <maml:description> <maml:para>Filters the retrieved storage arrays by ID. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Refresh</maml:name> <maml:description> <maml:para>Synchronizes the storage arrays before retrieving data. The operation is synchronous.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VasaStorageArray</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Lun</maml:name> <maml:description> <maml:para>Filters the retrieved storage arrays by LUN. If not specified, all storage arrays are retrieved. You can retrieve LUN objects by using the Get-ScsiLun cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >ScsiLun[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Refresh</maml:name> <maml:description> <maml:para>Synchronizes the storage arrays before retrieving data. The operation is synchronous.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filters the retrieved storage arrays by name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>VasaProvider</maml:name> <maml:description> <maml:para>Filters the retrieved storage arrays by provider. If not specified, all storage arrays are retrieved. You can retrieve the provider objects by using the Get-VasaProvider cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VasaProvider[]</command:parameterValue> <dev:type> <maml:name>VasaProvider[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Refresh</maml:name> <maml:description> <maml:para>Synchronizes the storage arrays before retrieving data. The operation is synchronous.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Filters the retrieved storage arrays by ID. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Lun</maml:name> <maml:description> <maml:para>Filters the retrieved storage arrays by LUN. If not specified, all storage arrays are retrieved. You can retrieve LUN objects by using the Get-ScsiLun cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ScsiLun[]</command:parameterValue> <dev:type> <maml:name>ScsiLun[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more VasaStorageArray objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VasaStorageArray -Name "MyArray" -Refresh</dev:code> <dev:remarks> <maml:para>Synchronizes the providers and retrieves the storage array named "MyArray".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VasaStorageArray -Id "MyArrayId"</dev:code> <dev:remarks> <maml:para>Retrieves all storage arrays with ID set to "MyArrayId".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-VasaStorageArray.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-VDisk</command:name> <maml:description> <maml:para>This cmdlet lists VDisk objects based on the specified filters.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>VDisk</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet lists VDisk objects based on the specified filters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VDisk</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Datastore</maml:name> <maml:description> <maml:para>Specifies the datastore from which you want to retrieve the VDisk objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Datastore[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Filters the VDisk objects by name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VDisk</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Id</maml:name> <maml:description> <maml:para>Filters the VDisk objects by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Datastore</maml:name> <maml:description> <maml:para>Specifies the datastore from which you want to retrieve the VDisk objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Datastore[]</command:parameterValue> <dev:type> <maml:name>Datastore[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filters the VDisk objects by name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Filters the VDisk objects by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more VDisk objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VDisk -Name 'MyDisk' -Datastore $ds</dev:code> <dev:remarks> <maml:para>Retrieves the VDisk objects named 'MyDisk' from the $ds datastore.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VDisk -Id 'VDiskId'</dev:code> <dev:remarks> <maml:para>Retrieves the VDisk with Id 'VDiskId'.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-VDisk.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-VsanClusterConfiguration</command:name> <maml:description> <maml:para>This cmdlet retrieves vSAN related configuration data from clusters.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>VsanClusterConfiguration</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves vSAN related configuration data from clusters. Some fields are smart lazy initialized.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VsanClusterConfiguration</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the clusters from which you want to retrieve vSAN configuration data. If not specified, retrieves vSAN configuration data from all clusters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Cluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the clusters from which you want to retrieve vSAN configuration data. If not specified, retrieves vSAN configuration data from all clusters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Cluster[]</command:parameterValue> <dev:type> <maml:name>Cluster[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more VsanClusterConfiguration objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanClusterConfiguration -Cluster "MyCluster"</dev:code> <dev:remarks> <maml:para>Retrieves the vSAN cluster configuration of the clusters named "MyCluster".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-VsanClusterConfiguration.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VsanClusterConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-VsanDisk</command:name> <maml:description> <maml:para>This cmdlet retrieves the host disks that belong to a vSAN disk group.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>VsanDisk</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves the host disks that belong to a vSAN disk group. The cmdlet retrieves both SSD and HDD types of disks.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VsanDisk</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>VsanDiskGroup</maml:name> <maml:description> <maml:para>Specifies the vSAN disk groups that the disks are part of.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VsanDiskGroup[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>CanonicalName</maml:name> <maml:description> <maml:para>Specifies the canonical names of the retrieved disks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VsanDisk</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CanonicalName</maml:name> <maml:description> <maml:para>Specifies the canonical names of the retrieved disks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>VMHost</maml:name> <maml:description> <maml:para>Specifies the hosts that the retrieved disks are attached to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VMHost[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VsanDisk</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the IDs of the retrieved disks. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>VsanDiskGroup</maml:name> <maml:description> <maml:para>Specifies the vSAN disk groups that the disks are part of.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VsanDiskGroup[]</command:parameterValue> <dev:type> <maml:name>VsanDiskGroup[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>CanonicalName</maml:name> <maml:description> <maml:para>Specifies the canonical names of the retrieved disks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>VMHost</maml:name> <maml:description> <maml:para>Specifies the hosts that the retrieved disks are attached to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VMHost[]</command:parameterValue> <dev:type> <maml:name>VMHost[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the IDs of the retrieved disks. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more VsanDisk objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Works only with vCenter Server 5.5 or later.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanDisk -CanonicalName "DiskCanonicalName" -VMHost $vmHost</dev:code> <dev:remarks> <maml:para>Retrieves all vSAN disks with canonical name "DiskCanonicalName" from the $vmHost virtual machine host.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanDisk -CanonicalName "DiskCanonicalName" -VsanDiskGroup $vsanDiskGroup</dev:code> <dev:remarks> <maml:para>Retrieves all vSAN disks with canonical name "DiskCanonicalName" from the $vsanDiskGroup vSAN disk group.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanDisk -Id "MyVsanDiskId"</dev:code> <dev:remarks> <maml:para>Retrieves the vSAN disk with ID "MyVsanDiskId".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-VsanDisk.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VsanDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VsanDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-VsanDiskGroup</command:name> <maml:description> <maml:para>This cmdlet retrieves vSAN disk groups.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>VsanDiskGroup</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves vSAN disk groups in a cluster or a host, by ID, name, or the canonical name of a disk within the disk group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VsanDiskGroup</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the clusters that the retrieved groups are on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Cluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the vSAN disk group you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VsanDiskGroup</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the IDs of disks that are part of the retrieved groups. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VsanDiskGroup</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DiskCanonicalName</maml:name> <maml:description> <maml:para>Specifies the canonical names of disks that are part of the retrieved groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>VMHost</maml:name> <maml:description> <maml:para>Specifies the hosts that the retrieved groups are on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VMHost[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the clusters that the retrieved groups are on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Cluster[]</command:parameterValue> <dev:type> <maml:name>Cluster[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the vSAN disk group you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the IDs of disks that are part of the retrieved groups. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskCanonicalName</maml:name> <maml:description> <maml:para>Specifies the canonical names of disks that are part of the retrieved groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>VMHost</maml:name> <maml:description> <maml:para>Specifies the hosts that the retrieved groups are on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VMHost[]</command:parameterValue> <dev:type> <maml:name>VMHost[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more VsanDiskGroup objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Works only with vCenter Server 5.5 or later.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanDiskGroup -DiskCanonicalName "DiskCanonicalName" -VMHost $vmHost</dev:code> <dev:remarks> <maml:para>Retrieves all vSAN disk groups that contain a disk with canonical name "DiskCanonicalName" from the $vmHost virtual machine host.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanDiskGroup -Name "MyVsanDiskGroup" -Cluster $cluster</dev:code> <dev:remarks> <maml:para>Retrieves all vSAN disk groups named "MyVsanDiskGroup" from the $cluster cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanDiskGroup -Id "MyVsanDiskGroupId"</dev:code> <dev:remarks> <maml:para>Retrieves the vSAN disk group with ID "MyVsanDiskGroupId".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-VsanDiskGroup.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VsanDiskGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VsanDiskGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-VsanEvacuationPlan</command:name> <maml:description> <maml:para>This cmdlet retrieves information about the entity (disk, disk group, or host) you want to evacuate in various modes.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>VsanEvacuationPlan</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves information about the entity (disk, disk group, or host) you want to evacuate in various modes. You receive information about capacity usage only when the cmdlet determines that an entity can be evacuated in a given mode.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VsanEvacuationPlan</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Entity</maml:name> <maml:description> <maml:para>Specifies the entity for which you want to retrieve evacuation information. This parameter accepts VMHost, VsanDisk, and VsanDiskGroup entity types. OBN and wildcard are supported for VMHost type only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIObjectCore[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>EvacuationMode</maml:name> <maml:description> <maml:para>Filters the results by data migration mode options.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VsanDataMigrationMode[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>Entity</maml:name> <maml:description> <maml:para>Specifies the entity for which you want to retrieve evacuation information. This parameter accepts VMHost, VsanDisk, and VsanDiskGroup entity types. OBN and wildcard are supported for VMHost type only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIObjectCore[]</command:parameterValue> <dev:type> <maml:name>VIObjectCore[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EvacuationMode</maml:name> <maml:description> <maml:para>Filters the results by data migration mode options.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VsanDataMigrationMode[]</command:parameterValue> <dev:type> <maml:name>VsanDataMigrationMode[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more VsanEvacuationPlan objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanEvacuationPlan -Entity $vmHost</dev:code> <dev:remarks> <maml:para>Retrieves the evacuation plan about removing the $vmHost virtual machine host from the cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanEvacuationPlan -Entity $diskGroup -EvacuationPlan Full</dev:code> <dev:remarks> <maml:para>Retrieves the evacuation plan about removing the $diskGroup vSAN disk group for vSAN full data migration mode.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-VsanEvacuationPlan.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-VsanFaultDomain</command:name> <maml:description> <maml:para>This cmdlet retrieves vSAN fault domains based on name or ID filter.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>VsanFaultDomain</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves vSAN fault domains based on name or ID filter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VsanFaultDomain</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the vSAN cluster to which the fault domain belongs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Cluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>VMHost</maml:name> <maml:description> <maml:para>Specifies the list of virtual machine hosts to filter the vSAN fault domains. Filters the fault domains that contain any of the given hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VMHost[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Filters the retrieved vSAN fault domains by name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VsanFaultDomain</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Id</maml:name> <maml:description> <maml:para>Filters the retrieved vSAN fault domains by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the vSAN cluster to which the fault domain belongs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Cluster[]</command:parameterValue> <dev:type> <maml:name>Cluster[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>VMHost</maml:name> <maml:description> <maml:para>Specifies the list of virtual machine hosts to filter the vSAN fault domains. Filters the fault domains that contain any of the given hosts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VMHost[]</command:parameterValue> <dev:type> <maml:name>VMHost[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filters the retrieved vSAN fault domains by name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Filters the retrieved vSAN fault domains by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more VsanFaultDomain objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanFaultDomain -VMHost $vmHost</dev:code> <dev:remarks> <maml:para>Retrieves the vSAN fault domain which contains the $vmHost virtual machine host.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanFaultDomain -Cluster $cluster -Name "MyFaultDomain"</dev:code> <dev:remarks> <maml:para>Retrieves the vSAN fault domain named "MyFaultDomain" from the $cluster vSAN cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-VsanFaultDomain.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VsanFaultDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VsanFaultDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VsanFaultDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-VsanIscsiInitiatorGroup</command:name> <maml:description> <maml:para>This cmdlet retrieves vSAN iSCSI initiator groups.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>VsanIscsiInitiatorGroup</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves vSAN iSCSI initiator groups.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VsanIscsiInitiatorGroup</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Filters the retrieved initiator groups by name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the list of clusters to query for initiator groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Cluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VsanIscsiInitiatorGroup</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Id</maml:name> <maml:description> <maml:para>Filters the retrieved initiator groups by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filters the retrieved initiator groups by name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the list of clusters to query for initiator groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Cluster[]</command:parameterValue> <dev:type> <maml:name>Cluster[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Filters the retrieved initiator groups by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more VsanIscsiInitiatorGroup objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanIscsiInitiatorGroup -Cluster "vsan-cluster"</dev:code> <dev:remarks> <maml:para>Retrieves all vSAN iSCSI initiator groups from the "vsan-cluster" cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-VsanIscsiInitiatorGroup.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VsanIscsiInitiatorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VsanIscsiInitiatorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VsanIscsiInitiatorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-VsanIscsiInitiatorGroupTargetAssociation</command:name> <maml:description> <maml:para>This cmdlet retrieves all pairs of associations between vSAN iSCSI targets and initiator groups, which have access to the corresponding targets.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>VsanIscsiInitiatorGroupTargetAssociation</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves all pairs of associations between vSAN iSCSI targets and initiator groups, which have access to the corresponding targets.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VsanIscsiInitiatorGroupTargetAssociation</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the vSAN iSCSI targets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VsanIscsiTarget[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>InitiatorGroup</maml:name> <maml:description> <maml:para>Specifies the vSAN iSCSI initiator groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VsanIscsiInitiatorGroup[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the vSAN iSCSI targets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VsanIscsiTarget[]</command:parameterValue> <dev:type> <maml:name>VsanIscsiTarget[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>InitiatorGroup</maml:name> <maml:description> <maml:para>Specifies the vSAN iSCSI initiator groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VsanIscsiInitiatorGroup[]</command:parameterValue> <dev:type> <maml:name>VsanIscsiInitiatorGroup[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more VsanIscsiInitiatorGroupTargetAssociation objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanIscsiInitiatorGroupTargetAssociation -Target $target</dev:code> <dev:remarks> <maml:para>Retrieves all initiator group associations for the $target iSCSI target.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanIscsiInitiatorGroupTargetAssociation -InitiatorGroup $initiatorGroup</dev:code> <dev:remarks> <maml:para>Retrieves all target associations for the $initiatorGroup initiator group.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-VsanIscsiInitiatorGroupTargetAssociation.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VsanIscsiInitiatorGroupTargetAssociation</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VsanIscsiInitiatorGroupTargetAssociation</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-VsanIscsiLun</command:name> <maml:description> <maml:para>This cmdlet retrieves the vSAN iSCSI LUNs from a cluster or target.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>VsanIscsiLun</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves the vSAN iSCSI LUNs from a cluster or target.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VsanIscsiLun</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>VsanIscsiTarget</maml:name> <maml:description> <maml:para>Specifies the vSAN iSCSI targets from which to retrieve LUNs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VsanIscsiTarget[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Filters the retrieved vSAN iSCSI LUNs by name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>LunId</maml:name> <maml:description> <maml:para>Filters the retrieved vSAN iSCSI LUNs by LUN ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Int32[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the clusters from which to retrieve LUNs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Cluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VsanIscsiLun</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Id</maml:name> <maml:description> <maml:para>Filters the retrieved vSAN iSCSI LUNs by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>VsanIscsiTarget</maml:name> <maml:description> <maml:para>Specifies the vSAN iSCSI targets from which to retrieve LUNs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VsanIscsiTarget[]</command:parameterValue> <dev:type> <maml:name>VsanIscsiTarget[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filters the retrieved vSAN iSCSI LUNs by name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>LunId</maml:name> <maml:description> <maml:para>Filters the retrieved vSAN iSCSI LUNs by LUN ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the clusters from which to retrieve LUNs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Cluster[]</command:parameterValue> <dev:type> <maml:name>Cluster[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Filters the retrieved vSAN iSCSI LUNs by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more VsanIscsiLun objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanIscsiLun -Cluster "vsan-cluster"</dev:code> <dev:remarks> <maml:para>Retrieves all vSAN iSCSI LUNs from the "vsan-cluster" cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanIscsiLun -Target $target -LunId 1</dev:code> <dev:remarks> <maml:para>Retrieves the vSAN iSCSI LUNs with LunId 1 from the $target iSCSI target.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-VsanIscsiLun.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-VsanIscsiTarget</command:name> <maml:description> <maml:para>This cmdlet retrieves vSAN iSCSI targets from clusters.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>VsanIscsiTarget</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves vSAN iSCSI targets from clusters. The cmdlet can filter targets by IQN and aliases.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VsanIscsiTarget</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the clusters from which to retrieve vSAN iSCSI targets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Cluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Filters the retrieved vSAN iSCSI targets by name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>IscsiQualifiedName</maml:name> <maml:description> <maml:para>Filters the retrieved vSAN iSCSI targets by IQN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VsanIscsiTarget</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Id</maml:name> <maml:description> <maml:para>Filters the retrieved vSAN iSCSI targets by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the clusters from which to retrieve vSAN iSCSI targets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Cluster[]</command:parameterValue> <dev:type> <maml:name>Cluster[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filters the retrieved vSAN iSCSI targets by name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IscsiQualifiedName</maml:name> <maml:description> <maml:para>Filters the retrieved vSAN iSCSI targets by IQN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Filters the retrieved vSAN iSCSI targets by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more VsanIscsiTarget objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanIscsiTarget -Cluster "vsan-cluster"</dev:code> <dev:remarks> <maml:para>Retrieves all vSAN iSCSI targets from the "vsan-cluster" cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanIscsiTarget -Cluster $cluster -Name "Target1"</dev:code> <dev:remarks> <maml:para>Retrieves the vSAN iSCSI target named "Target1" from the $cluster vSAN cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-VsanIscsiTarget .html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VsanIscsiLun</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VsanIscsiLun</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VsanIscsiLun</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-VsanResyncingComponent</command:name> <maml:description> <maml:para>This cmdlet retrieves the details of components going through synchronization in a vSAN cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>VsanResyncingComponent</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves the details of components going through synchronization in a vSAN cluster.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VsanResyncingComponent</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the vSAN cluster for which to retrieve synchronization details.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Cluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the vSAN cluster for which to retrieve synchronization details.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Cluster[]</command:parameterValue> <dev:type> <maml:name>Cluster[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more VsanResyncingComponent objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanResyncingComponent -Cluster $cluster</dev:code> <dev:remarks> <maml:para>Retrieves the vSAN resyncing components from the $cluster cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-VsanResyncingComponent.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-VsanRuntimeInfo</command:name> <maml:description> <maml:para>This cmdlet retrieves the runtime information of a vSAN cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>VsanRuntimeInfo</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves the runtime information and of a vSAN cluster, such as resynchronization traffic information of the ongoing resynchronization operation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VsanRuntimeInfo</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the vSAN cluster from which you want to retrieve runtime information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Cluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the vSAN cluster from which you want to retrieve runtime information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Cluster[]</command:parameterValue> <dev:type> <maml:name>Cluster[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more VsanRuntimeInfo objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanRuntimeInfo -Cluster $vsanCluster</dev:code> <dev:remarks> <maml:para>Retrieves the vSAN runtime information of the $vsanCluster cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-VsanRuntimeInfo.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-VsanSpaceUsage</command:name> <maml:description> <maml:para>This cmdlet retrieves space usage details of a vSAN cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>VsanSpaceUsage</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves space usage details of a vSAN cluster.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VsanSpaceUsage</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the vSAN clusters for which to retrieve space usage details.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Cluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the vSAN clusters for which to retrieve space usage details.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Cluster[]</command:parameterValue> <dev:type> <maml:name>Cluster[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more VsanSpaceUsage objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanSpaceUsage -Cluster $cluster</dev:code> <dev:remarks> <maml:para>Retrieves space usage details of the $cluster vSAN cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-VsanSpaceUsage.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-VsanStat</command:name> <maml:description> <maml:para>This cmdlet retrieves vSAN performance statistics for the specified server entity.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>VsanStat</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves vSAN performance statistics for the specified server entity.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VsanStat</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the performance metrics you want to retrieve. If not specified, all the metrics are returned. The value is in the format 'ViewName.MetricName'. ViewName is applicable to different entity types: Cluster: Backend, VMConsumption VMHost: Backend, VMConsumption, HostNetwork, HostIscsi VirtualMachine: Performance HardDisk: VirtualDisk, Vscsi VsanDisk: Performance VsanDiskGroup: Performance VsanIscsiTarget: Performance VsanIscsiLun: Performance</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Entity</maml:name> <maml:description> <maml:para>Specifies the entity for which you want to retrieve vSAN performance metrics. OBN is supported for the Cluster, VMHost, VirtualMachine, and VsanIscsiTarget entity types.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIObjectCore[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>StartTime</maml:name> <maml:description> <maml:para>Specifies the client local time from which you want to retrieve statistics. The returned samples do not include the sample at StartTime.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DateTime</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>EndTime</maml:name> <maml:description> <maml:para>Specifies the client local time up to which you want to retrieve statistics. If the specified value is later than current server time, the value is replaced by the current server time. The returned samples include the sample at EndTime.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DateTime</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the performance metrics you want to retrieve. If not specified, all the metrics are returned. The value is in the format 'ViewName.MetricName'. ViewName is applicable to different entity types: Cluster: Backend, VMConsumption VMHost: Backend, VMConsumption, HostNetwork, HostIscsi VirtualMachine: Performance HardDisk: VirtualDisk, Vscsi VsanDisk: Performance VsanDiskGroup: Performance VsanIscsiTarget: Performance VsanIscsiLun: Performance</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Entity</maml:name> <maml:description> <maml:para>Specifies the entity for which you want to retrieve vSAN performance metrics. OBN is supported for the Cluster, VMHost, VirtualMachine, and VsanIscsiTarget entity types.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIObjectCore[]</command:parameterValue> <dev:type> <maml:name>VIObjectCore[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>Specifies the client local time from which you want to retrieve statistics. The returned samples do not include the sample at StartTime.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>Specifies the client local time up to which you want to retrieve statistics. If the specified value is later than current server time, the value is replaced by the current server time. The returned samples include the sample at EndTime.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more VsanStatSample objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>$diskGroups = Get-VsanDiskGroup -Cluster "vsan-cluster" Get-VsanStat -Entity $diskGroups</dev:code> <dev:remarks> <maml:para>Retrieves all vSAN performance samples for vSAN disk groups of the "vsan-cluster" cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanStat -Entity "vsan-cluster" -Name "Backend.ReadThroughput"</dev:code> <dev:remarks> <maml:para>Retrieves vSAN performance samples for backend read throughput of the "vsan-cluster" cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>$cluster = Get-Cluster -Name "vsan-cluster" Get-VsanStat -Entity $cluster -Name VMConsumption.ReadIops -StartTime $startTime -EndTime $endTime</dev:code> <dev:remarks> <maml:para>Retrieves the read IOPS stats relevant to the VM consumption view of the "vsan-cluster" cluster in the $startTime to $endTime local time range.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 4 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>$cluster = Get-Cluster -Name "vsan-cluster" Get-VsanStat -Entity $cluster -Name Backend.ReadIops -StartTime $startTime -EndTime $endTime</dev:code> <dev:remarks> <maml:para>Retrieves the read IOPS stats relevant to the backend view of the "vsan-cluster" cluster in the $startTime to $endTime local time range.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 5 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanStat -Entity $iscsiTarget -Name Performance.ReadIops -StartTime $startTime -EndTime $endTime</dev:code> <dev:remarks> <maml:para>Retrieves the read IOPS stats of the $iscsiTarget target in the $startTime to $endTime local time range.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 6 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanStat -Entity $iscsiLUN -Name Performance.ReadIops -StartTime $startTime -EndTime $endTime</dev:code> <dev:remarks> <maml:para>Retrieves the read IOPS stats of the $iscsiLUN iSCSI LUN in the $startTime to $endTime local time range.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 7 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanStat -Entity $vmhost -Name VMConsumption.ReadIops -StartTime $startTime -EndTime $endTime</dev:code> <dev:remarks> <maml:para>Retrieves the read IOPS stats relevant to the VM consumption view of the $vmHost host in the $startTime to $endTime local time range.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 8 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanStat -Entity $vmhost -Name Backend.ReadIops -StartTime $startTime -EndTime $endTime</dev:code> <dev:remarks> <maml:para>Retrieves the read IOPS stats relevant to the backend view of $vmHost host in the $startTime to $endTime local time range.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 9 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanStat -Entity $diskGroup -Name Performance.ReadCacheWriteIops -StartTime $startTime -EndTime $endTime</dev:code> <dev:remarks> <maml:para>Retrieves the read cache write IOPS stats of the $diskGroup vSAN disk group in the $startTime to $endTime local time range.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 10 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanStat -Entity $disk -Name Performance.DeviceReadIops -StartTime $startTime -EndTime $endTime</dev:code> <dev:remarks> <maml:para>Retrieves the device read IOPS stats of the $disk vSAN disk in the $startTime to $endTime local time range.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 11 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanStat -Entity $vmhost -Name HostNetwork.NetworkInboundThroughput -StartTime $startTime -EndTime $endTime</dev:code> <dev:remarks> <maml:para>Retrieves the network inbound throughput stats relevant to the VMKernel adapter aggregation of $vmHost host in the $startTime to $endTime local time range.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 12 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanStat -Entity "MyVM" -Name Performance.ReadIops -StartTime $startTime -EndTime $endTime</dev:code> <dev:remarks> <maml:para>Retrieves the read IOPS stats of "MyVM" virtual machine in the $startTime to $endTime local time range.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 13 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanStat -Entity $hardDisk -Name VirtualDisk.IopsLimit -StartTime $startTime -EndTime $endTime</dev:code> <dev:remarks> <maml:para>Retrieves the IOPS limit stats of the $hardDisk virtual hard disk in the $startTime to $endTime local time range.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-VsanStat.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Get-VsanView</command:name> <maml:description> <maml:para>This cmdlet retrieves vSAN views that match the specified IDs.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>VsanView</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves vSAN views that match the specified IDs. The string value of the ID is in format <type>-<value> as it is in the PowerShell toolkit objects.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VsanView</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ManagedObjectReference for which you want to retrieve the view. This parameter also accepts strings by silently converting them to ManagedObjectReference by using ArgumentTransformationAttribute. If not specified, all vSAN view objects available on the server are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >ManagedObjectReference[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ManagedObjectReference for which you want to retrieve the view. This parameter also accepts strings by silently converting them to ManagedObjectReference by using ArgumentTransformationAttribute. If not specified, all vSAN view objects available on the server are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">ManagedObjectReference[]</command:parameterValue> <dev:type> <maml:name>ManagedObjectReference[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Zero or more VsanView objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanView -Server "MyServer"</dev:code> <dev:remarks> <maml:para>Retrieves all singleton vSAN view objects from the "MyServer" connected server.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VsanView -Id "ManagedObjectId"</dev:code> <dev:remarks> <maml:para>Retrieves the view object of a vSAN managed object with ID "ManagedObjectId".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Get-VsanView.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Import-SpbmStoragePolicy</command:name> <maml:description> <maml:para>This cmdlet imports a storage policy from a file.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Import</command:verb> <command:noun>SpbmStoragePolicy</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet imports a storage policy from a file. The file path must be accessible from the VMware PowerCLI client side.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-SpbmStoragePolicy</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>FilePath</maml:name> <maml:description> <maml:para>Specifies the path to the file, from which you want to import a storage policy. If relative, it is relative to the current PS provider path.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "2" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name of the imported storage policy. The maximum length of the name is 80 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the imported storage policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VIServer</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Specifies the path to the file, from which you want to import a storage policy. If relative, it is relative to the current PS provider 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name of the imported storage policy. The maximum length of the name is 80 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the imported 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VIServer</command:parameterValue> <dev:type> <maml:name>VIServer</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>SpbmStoragePolicy</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Works only with vCenter Server 5.5 or later. For more information, see the VMware Storage Policy API Reference: https://pubs.vmware.com/vsphere-60/index.jsp#com.vmware.vspsdk.apiref.doc/right-pane.html</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Import-SpbmStoragePolicy -Name "MyPolicy" -Description "PolicyDescription" -FilePath C:\policy.xml</dev:code> <dev:remarks> <maml:para>Imports a storage policy with name "MyPolicy" and description "PolicyDescription" from the policy.xml file to a server. A new storage policy is created on the server.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Import-SpbmStoragePolicy.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Move-VDisk</command:name> <maml:description> <maml:para>This cmdlet moves the specified VDisk objects to the specified datastore.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Move</command:verb> <command:noun>VDisk</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet moves the specified VDisk objects to the specified datastore. For RDM (RawVDisk), only one VDisk object can be moved at once, and only moving from VMFS to VMFS is supported.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Move-VDisk</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "1" > <maml:name>VDisk</maml:name> <maml:description> <maml:para>Specifies the VDisk objects you want to move.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VDisk[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>StorageFormat</maml:name> <maml:description> <maml:para>Specifies the new storage format of the flat VDisk object that is moved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VDiskStorageFormat</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "true" pipelineInput = "false" position = "2" > <maml:name>Datastore</maml:name> <maml:description> <maml:para>Specifies the datastore to which you want to move the metadata of the VDisk object. For flat disk, the contents of the disk are also moved to the specified datastore.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Datastore</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Move-VDisk</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "1" > <maml:name>VDisk</maml:name> <maml:description> <maml:para>Specifies the VDisk objects you want to move.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VDisk[]</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "true" pipelineInput = "false" position = "2" > <maml:name>Datastore</maml:name> <maml:description> <maml:para>Specifies the datastore to which you want to move the metadata of the VDisk object. For flat disk, the contents of the disk are also moved to the specified datastore.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Datastore</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ScsiLun</maml:name> <maml:description> <maml:para>Specifies the new backing SCSI LUN for the RDM VDisk object that is moved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ScsiLun</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>VDisk</maml:name> <maml:description> <maml:para>Specifies the VDisk objects you want to move.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VDisk[]</command:parameterValue> <dev:type> <maml:name>VDisk[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageFormat</maml:name> <maml:description> <maml:para>Specifies the new storage format of the flat VDisk object that is moved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VDiskStorageFormat</command:parameterValue> <dev:type> <maml:name>VDiskStorageFormat</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="false" position="2"> <maml:name>Datastore</maml:name> <maml:description> <maml:para>Specifies the datastore to which you want to move the metadata of the VDisk object. For flat disk, the contents of the disk are also moved to the specified datastore.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Datastore</command:parameterValue> <dev:type> <maml:name>Datastore</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ScsiLun</maml:name> <maml:description> <maml:para>Specifies the new backing SCSI LUN for the RDM VDisk object that is moved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ScsiLun</command:parameterValue> <dev:type> <maml:name>ScsiLun</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The moved VDisk objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Move-VDisk -VDisk $vDisk -Datastore $ds</dev:code> <dev:remarks> <maml:para>Moves the flat VDisk object $vDisk to the $ds datastore.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Move-VDisk -VDisk $vDisk -ScsiLun $scsiLun -Datastore $ds</dev:code> <dev:remarks> <maml:para>Moves the raw VDisk object $vDisk on the $scsiLun SCSI LUN and stores metadata of this object on the $ds datastore.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Move-VDisk.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>New-KmipClientCertificate</command:name> <maml:description> <maml:para>This cmdlet creates a new self-signed certificate or certificate-signing request for the key management server cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>KmipClientCertificate</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet creates a new self-signed certificate or certificate-signing request for the key management server cluster.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-KmipClientCertificate</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>KmsCluster</maml:name> <maml:description> <maml:para>Specifies the key management server cluster for which you want to use the certificate as a client certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >KmsCluster</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CertificateSigningRequest</maml:name> <maml:description> <maml:para>Indicates whether a certificate-signing request should be retrieved. This certificate-signing request should be signed by the key management server and uploaded to the vCenter Server system.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>FilePath</maml:name> <maml:description> <maml:para>Specifies the file path to which you want to export the self-signed certificate or certificate-signing request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>KmsCluster</maml:name> <maml:description> <maml:para>Specifies the key management server cluster for which you want to use the certificate as a client certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">KmsCluster</command:parameterValue> <dev:type> <maml:name>KmsCluster</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CertificateSigningRequest</maml:name> <maml:description> <maml:para>Indicates whether a certificate-signing request should be retrieved. This certificate-signing request should be signed by the key management server and uploaded to the vCenter Server system.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Specifies the file path to which you want to export the self-signed certificate or certificate-signing request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The newly created self-signed certificate or certificate-signing request</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-KmipClientCertificate -KmsCluster $kmsCluster</dev:code> <dev:remarks> <maml:para>Creates a self-signed client certificate for the $kmsCluster key management server cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-KmipClientCertificate -KmsCluster $kmsCluster -CertificateSigningRequest -FilePath $filePath</dev:code> <dev:remarks> <maml:para>Creates a certificate-signing request for the $kmsCluster key management server cluster and exports it to the $filePath file path.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/New-KmipClientCertificate.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-KmipClientCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>New-NfsUser</command:name> <maml:description> <maml:para>This cmdlet creates an NFS user account on the specified virtual machine host.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>NfsUser</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet creates an NFS user account on the specified virtual machine host. The credentials of the newly created NFS user account are used by NFS v4.1 for Kerberos authentication. If an NFS user account already exists on the virtual machine host, this cmdlet overwrites that NFS user account. The virtual machine host must be part of an Active Directory domain for the cmdlet to run successfully.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NfsUser</maml:name> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>Username</maml:name> <maml:description> <maml:para>Specifies the NFS user name to be used for Kerberos authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "2" > <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies password for authentication. This parameter accepts both secure and plain strings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >SecureString</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>VMHost</maml:name> <maml:description> <maml:para>Specifies the virtual machine host on which you want to add the NFS user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VMHost</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Force</maml:name> <maml:description> <maml:para>By default, the cmdlet fails to create an NFS user account if an NFS user account with the same user name already exists on the virtual machine host. If Force is specified, the cmdlet overwrites the existing NFS user account.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a PSCredential object for Kerberos authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >PSCredential</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Username</maml:name> <maml:description> <maml:para>Specifies the NFS user name to be used for Kerberos authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies password for authentication. This parameter accepts both secure and plain strings.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>VMHost</maml:name> <maml:description> <maml:para>Specifies the virtual machine host on which you want to add the NFS user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMHost</command:parameterValue> <dev:type> <maml:name>VMHost</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>By default, the cmdlet fails to create an NFS user account if an NFS user account with the same user name already exists on the virtual machine host. If Force is specified, the cmdlet overwrites the existing NFS user account.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a PSCredential object for Kerberos authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The newly created NfsUser object</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-NfsUser -VMHost $vmhost -Username "user1" -Password "password1"</dev:code> <dev:remarks> <maml:para>Creates the "user1" NFS user account on the $vmhost virtual machine host and sets the password to "password1".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-NfsUser -VMHost $vmhost -Credential $myCredentialsObject</dev:code> <dev:remarks> <maml:para>Creates an NFS user account by using a credential object.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/New-NfsUser.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-NfsUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-NfsUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-NfsUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>New-SpbmRule</command:name> <maml:description> <maml:para>This cmdlet creates an SPBM rule in the client side.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>SpbmRule</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet creates an SPBM rule in the client side. There are two types of rules - capability-based rules and tag-based rules. To create a capability-based rule, perform the following steps: 1. Select an available schema namespace. To get all available schema namespaces, run Get-SpbmCapability | select Namespace -unique. 2. Choose a capability ID within the selected schema namespace by using the Get-SpbmCapability cmdlet. 3. Provide a value for the selected Capability. It can be either a scalar value or a range of values. To create a tag-based rule set, you must select at least one tag. If you select multiple tags, all specified tags should be of the same tag category. To see all available tags, run the Get-Tag cmdlet. You can use the Get-TagCategory and Get-Tag cmdlets to find a specific tag object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-SpbmRule</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "true" pipelineInput = "false" position = "1" > <maml:name>Capability</maml:name> <maml:description> <maml:para>Specifies an SPBM capability object. You must select one of the available capability objects for the given namespace. OBN for this object uses full name of the object, including the namespace name. You can find all available Capability objects and their data types under a namespace by using the Get-SpbmCapability cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >SpbmCapability</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "2" > <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies a capability property value. A property value is a single value or a collection of values. A single property value is expressed as a scalar value (Object), while a collection of values is expressed as a range of values (VMware.VimAutomation.VICore.Types.V1.Range), or an array (Object[]) of values. The type of each value can be Long, Int, String, Boolean, Double, DateTime, or TimeSpan.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Object</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VIServer</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SpbmRule</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>AnyOfTags</maml:name> <maml:description> <maml:para>Specifies tag objects for the new rule. All specified tags should be of the same tag category. You can find all available tags by running the Get-Tag cmdlet. You can use the Get-TagCategory and Get-Tag cmdlets to find a specific tag.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Tag[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VIServer</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="false" position="1"> <maml:name>Capability</maml:name> <maml:description> <maml:para>Specifies an SPBM capability object. You must select one of the available capability objects for the given namespace. OBN for this object uses full name of the object, including the namespace name. You can find all available Capability objects and their data types under a namespace by using the Get-SpbmCapability cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SpbmCapability</command:parameterValue> <dev:type> <maml:name>SpbmCapability</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies a capability property value. A property value is a single value or a collection of values. A single property value is expressed as a scalar value (Object), while a collection of values is expressed as a range of values (VMware.VimAutomation.VICore.Types.V1.Range), or an array (Object[]) of values. The type of each value can be Long, Int, String, Boolean, Double, DateTime, or TimeSpan.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VIServer</command:parameterValue> <dev:type> <maml:name>VIServer</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>AnyOfTags</maml:name> <maml:description> <maml:para>Specifies tag objects for the new rule. All specified tags should be of the same tag category. You can find all available tags by running the Get-Tag cmdlet. You can use the Get-TagCategory and Get-Tag cmdlets to find a specific tag.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Tag[]</command:parameterValue> <dev:type> <maml:name>Tag[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The newly created SpbmRule object</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Works only with vCenter Server 5.5 or later. For more information, see the VMware Storage Policy API Reference: https://pubs.vmware.com/vsphere-60/index.jsp#com.vmware.vspsdk.apiref.doc/right-pane.html</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-SpbmRule -Capability (Get-SpbmCapability -Name "VSAN.forceProvisioning") -Value $true</dev:code> <dev:remarks> <maml:para>Creates a new SPBM rule with capability named "VSAN.forceProvisioning" and Boolean value set to true.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-SpbmRule -Capability (Get-SpbmCapability -Name VSAN.stripeWidth) -Value 2</dev:code> <dev:remarks> <maml:para>Creates a new SPBM rule with capability named "VSAN.stripewidth" and integer value set to 2.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-SpbmRule -AnyOfTags (Get-Tag -Category "category1")</dev:code> <dev:remarks> <maml:para>Creates a new SPBM rule with all the tags from the "category1" category.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 4 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-SpbmRule -AnyOfTags $tag1, $tag2</dev:code> <dev:remarks> <maml:para>Creates a new SPBM rule with tag objects $tag1 and $tag2.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/New-SpbmRule.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>New-SpbmRuleSet</command:name> <maml:description> <maml:para>This cmdlet creates an SPBM rule set.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>SpbmRuleSet</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet creates an SPBM rule set. An SpbmRuleSet object consists of multiple SpbmRule objects. It contains both capability-based and tag-based rules. Each of the capability-based rules must be of the same namespace.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-SpbmRuleSet</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "1" > <maml:name>AllOfRules</maml:name> <maml:description> <maml:para>Specifies an array of SPBM rule objects for the new rule set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SpbmRule[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the new rule set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>AllOfRules</maml:name> <maml:description> <maml:para>Specifies an array of SPBM rule objects for the new rule set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SpbmRule[]</command:parameterValue> <dev:type> <maml:name>SpbmRule[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the new rule set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The newly created SpbmRuleSet object</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Works only with vCenter Server 5.5 or later. For more information, see the VMware Storage Policy API Reference: https://pubs.vmware.com/vsphere-60/index.jsp#com.vmware.vspsdk.apiref.doc/right-pane.html</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-SpbmRuleSet -AllOfRules (New-SpbmRule -AnyOfTags $tag1, $tag2)</dev:code> <dev:remarks> <maml:para>Creates an SPBM rule set with a rule of tag objects $tag1, $tag2.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-SpbmRuleSet -AllOfRules $rule1, $rule2, $rule3</dev:code> <dev:remarks> <maml:para>Creates an SPBM rule set with rule objects $rule1, $rule2, and $rule3.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/New-SpbmRuleSet.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>New-SpbmStoragePolicy</command:name> <maml:description> <maml:para>This cmdlet creates a requirement storage policy in an SPBM server.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>SpbmStoragePolicy</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet creates a requirement storage policy in an SPBM server. A requirement policy contains requirements that are derived from tag-defined capabilities or from VMware VSAN capabilities. A policy is a collection of rule sets. A rule set references storage capabilities and defines requirements based on those capabilities. Rules from the VAIOFilter namespace are only accepted as value by the CommonRule parameter. These rules apply to all rule sets as common requirements. You can use the following styles when creating a new policy. # Style 1: New-SpbmStoragePolicy -Name ... -RuleSet ( New-SpbmRuleSet ( (New-SpbmRule EmcStorage.Latency.MaxValue 45), (New-SpbmRule EmcStorage.MulPropCap.Property (Range 2 14)), ), New-SpbmRuleSet ( (New-SpbmRule SpbmCore.Throughput 5), (New-SpbmRule -Tag $supportsThinProvisioning) ) ) -CommonRule ((New-SpbmRule IOFilters.EMCCache.MaxValue 1000), (New-SpbmRule IOFilters.EMCCache.OtherRange (Range 2 14))) # Style 2: $r1 = New-SpbmRule -Capability namespace1.capability1.property1 -Value ... $rs1 = New-SpbmRuleSet -Rule $r1 $ca1 = Get-SPBMCapability -Name EMCStorage.Latency.* $r2 = New-SpbmRule -Capability $ca1[0] -Value ... $r3 = New-SpbmRule -Capability EMCStorage.Latency.MaxValue -Value ... $rs2 = New-SpbmRuleSet -Rule ($r2,$r3) $r4 = New-SpbmRule -Capability IOfilters.Replication.Someprop -Value ... $ca2 = Get-SPBMCapability -Name IOFilters.* $r5 = New-SpbmRule -Capability $ca2[0] -Value ... $sp = New-SpbmStoragePolicy -RuleSet ($rs1,$rs2) -CommonRule ($r4,$r5) # Style 3: Creating a storage policy with only VAIOFilter-based common rules $ca1 = Get-SPBMCapability -Name IOFilters.* $r1 = New-SpbmRule -Capability $ca1[0] -Value ... $sp1 = New-SpbmStoragePolicy -CommonRule ($r1) #Style 4: Creating a storage policy without VAIOFilter-based common rules $ca1 = Get-SPBMCapability -Name EMCStorage.Latency.* $r1= New-SpbmRule -Capability $ca1[0] -Value ... $r2 = New-SpbmRule -Capability EMCStorage.Latency.MaxValue -Value ... $rs1 = New-SpbmRuleSet -Rule ($r1,$r2) $sp1= New-SpbmStoragePolicy -RuleSet ($rs1)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-SpbmStoragePolicy</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the capability-based policy to be created. The maximum length of the name is 80 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the text description associated with the policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "named" > <maml:name>AnyOfRuleSets</maml:name> <maml:description> <maml:para>Specifies an array of rule sets that define the storage requirements. An SPBM rule with the VAIOFilter namespace cannot be added in any of these rule sets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SpbmRuleSet[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CommonRule</maml:name> <maml:description> <maml:para>Specifies the SPBM rules from the VAIOFilter namespace only. These rules are considered with all the SPBM rule sets as common requirements.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SpbmRule[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VIServer</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the capability-based policy to be created. The maximum length of the name is 80 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the text description associated with the 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>AnyOfRuleSets</maml:name> <maml:description> <maml:para>Specifies an array of rule sets that define the storage requirements. An SPBM rule with the VAIOFilter namespace cannot be added in any of these rule sets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SpbmRuleSet[]</command:parameterValue> <dev:type> <maml:name>SpbmRuleSet[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>CommonRule</maml:name> <maml:description> <maml:para>Specifies the SPBM rules from the VAIOFilter namespace only. These rules are considered with all the SPBM rule sets as common requirements.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SpbmRule[]</command:parameterValue> <dev:type> <maml:name>SpbmRule[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VIServer</command:parameterValue> <dev:type> <maml:name>VIServer</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The newly created SpbmStoragePolicy object</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Works only with vCenter Server 5.5 or later. For more information, see the VMware Storage Policy API Reference: https://pubs.vmware.com/vsphere-60/index.jsp#com.vmware.vspsdk.apiref.doc/right-pane.html</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-SpbmStoragePolicy -Name "MyPolicy" -Description "MyPolicyDescription" -AnyOfRuleSets $ruleset1, $ruleset2, $ruleset3</dev:code> <dev:remarks> <maml:para>Creates a new storage policy named "MyPolicy", with description "MyPolicyDescription" and with rule set objects $ruleset1, $ruleset2 and $ruleset3.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-SpbmStoragePolicy -Name "MyPolicy" -AnyOfRuleSets (New-SpbmRuleSet -AllOfRules $rule1, $rule2, $rule3)</dev:code> <dev:remarks> <maml:para>Creates a new storage policy named "MyPolicy" with a rule set containing rule objects $rule1, $rule2, and $rule3.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>$c = Get-SpbmCapability -Name IOFILTERS* $cr = New-SpbmRule -Capability $c[0] -Value 10 $p = New-SpbmStoragePolicy -Name policy1 -AnyOfRuleSets (New-SpbmRuleSet -Name ruleset1 -AllOfRules @($rule1, $rule2)) -CommonRule ($cr)</dev:code> <dev:remarks> <maml:para>Creates a storage policy with one rule set and one VAIOFilter common rule.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/New-SpbmStoragePolicy.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>New-VAIOFilter</command:name> <maml:description> <maml:para>This cmdlet installs a VAIO filter on the specified cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>VAIOFilter</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet installs a VAIO filter on the specified cluster. The SPBM metadata of the VAIO filter might not appear immediately in the list of capabilities.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-VAIOFilter</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the cluster on which to install the VAIO filter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Cluster</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "2" > <maml:name>VibUrl</maml:name> <maml:description> <maml:para>Specifies the URL that points to the VAIO filter VIB package. The accepted formats are HTTP and HTTPS.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VIServer</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the cluster on which to install the VAIO filter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Cluster</command:parameterValue> <dev:type> <maml:name>Cluster</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>VibUrl</maml:name> <maml:description> <maml:para>Specifies the URL that points to the VAIO filter VIB package. The accepted formats are HTTP and HTTPS.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VIServer</command:parameterValue> <dev:type> <maml:name>VIServer</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The newly created VAIOFilter object</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Works only with vCenter Server 6.0 or later.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-VAIOFilter -Cluster $cluster -VibUrl "MyVibUrl"</dev:code> <dev:remarks> <maml:para>Installs a new VAIO filter defined by "MyVibUrl" on the $cluster cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/New-VAIOFilter.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VAIOFilter</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VAIOFilter</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VAIOFilter</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>New-VasaProvider</command:name> <maml:description> <maml:para>This cmdlet registers a VASA provider.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>VasaProvider</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet registers a VASA provider.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-VasaProvider</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the provider. The maximum length of the name is 80 characters. If not specified, a default name based on the provider namespace and ID is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the VASA provider service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies credentials in the form of a PSCredential object. The Username and Password parameter pair is an alternative to the Credential parameter. If sufficient information about user and password, or credential is not specified, the cmdlet provides a credential prompt.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >PSCredential</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Username</maml:name> <maml:description> <maml:para>Specifies the user name for connecting to a provider. The maximum length of the user name is 255 characters. The Username and Password parameter pair is an alternative to the Credential parameter. If sufficient information about user and password, or credential is not specified, the cmdlet provides a credential prompt.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password for connecting to a provider. The maximum length of the password is 255 characters. The Username and Password parameter pair is an alternative to the Credential parameter. If sufficient information about user and password, or credential is not specified, the cmdlet provides a credential prompt. This parameter is of type SecureString but it also accepts objects of type System.String.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >SecureString</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the provider.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Certificate</maml:name> <maml:description> <maml:para>Specifies the VASA provider certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the server to trust the provider and store the provider certificate for future reference. If not set, the server throws error in case the provider certificate is not in the list of trusted certificates.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VIServer</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the provider. The maximum length of the name is 80 characters. If not specified, a default name based on the provider namespace and ID 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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Specifies the URL of the VASA provider service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies credentials in the form of a PSCredential object. The Username and Password parameter pair is an alternative to the Credential parameter. If sufficient information about user and password, or credential is not specified, the cmdlet provides a credential prompt.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Username</maml:name> <maml:description> <maml:para>Specifies the user name for connecting to a provider. The maximum length of the user name is 255 characters. The Username and Password parameter pair is an alternative to the Credential parameter. If sufficient information about user and password, or credential is not specified, the cmdlet provides a credential prompt.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the password for connecting to a provider. The maximum length of the password is 255 characters. The Username and Password parameter pair is an alternative to the Credential parameter. If sufficient information about user and password, or credential is not specified, the cmdlet provides a credential prompt. This parameter is of type SecureString but it also accepts objects of type System.String.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies the description of the provider.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>Specifies the VASA provider certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the server to trust the provider and store the provider certificate for future reference. If not set, the server throws error in case the provider certificate is not in the list of trusted certificates.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VIServer</command:parameterValue> <dev:type> <maml:name>VIServer</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The newly created VasaProvider object</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-VasaProvider -Name "MyProvider" -Username "UserName" -Password "Password" -Url "MyUrl"</dev:code> <dev:remarks> <maml:para>Registers a VASA provider running at "MyUrl" with the Storage Monitoring Service.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-VasaProvider -Name "MyProvider" -Credential "MyCredential" -Url "MyUrl" -Force</dev:code> <dev:remarks> <maml:para>Registers a VASA provider by using the "MyCredential" credential and forcing the Storage Monitoring Service to accept the certificate of the provider.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/New-VasaProvider.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VasaProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VasaProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>New-VDisk</command:name> <maml:description> <maml:para>This cmdlet creates a managed VDisk object whose lifecycle is independent of a virtual machine`s lifecycle on the specified datastore.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>VDisk</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet creates a managed VDisk object whose lifecycle is independent of a virtual machine`s lifecycle on the specified datastore. For RDM (RawVDisk), you must specify the device name of the SCSI LUN and the virtual machine host which is connected to the SCSI LUN.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-VDisk</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the newly created VDisk object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>StorageFormat</maml:name> <maml:description> <maml:para>Specifies the storage format of the newly created VDisk object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VDiskStorageFormat</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CapacityGB</maml:name> <maml:description> <maml:para>Specifies the capacity of the newly created VDisk object in gigabytes (GB).</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Decimal</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DiskType</maml:name> <maml:description> <maml:para>Specifies the type of the newly created VDisk object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DiskType</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Datastore</maml:name> <maml:description> <maml:para>Specifies the datastore on which you want to store the metadata of the VDisk object. For flat disk, the contents of the disk are also stored on the specified datastore.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Datastore</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-VDisk</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the newly created VDisk object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DiskType</maml:name> <maml:description> <maml:para>Specifies the type of the newly created VDisk object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DiskType</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>VMHost</maml:name> <maml:description> <maml:para>Specifies the virtual machine host which is connected to the SCSI LUN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VMHost</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Datastore</maml:name> <maml:description> <maml:para>Specifies the datastore on which you want to store the metadata of the VDisk object. For flat disk, the contents of the disk are also stored on the specified datastore.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Datastore</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ScsiLun</maml:name> <maml:description> <maml:para>Specifies the backing SCSI LUN for the newly created VDisk object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ScsiLun</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-VDisk</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the newly created VDisk object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByValue)" position = "named" > <maml:name>HardDisk</maml:name> <maml:description> <maml:para>Specifies the virtual hard disk object which you want to promote as a VDisk object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >HardDisk</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the newly created VDisk 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StorageFormat</maml:name> <maml:description> <maml:para>Specifies the storage format of the newly created VDisk object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VDiskStorageFormat</command:parameterValue> <dev:type> <maml:name>VDiskStorageFormat</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CapacityGB</maml:name> <maml:description> <maml:para>Specifies the capacity of the newly created VDisk object in gigabytes (GB).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskType</maml:name> <maml:description> <maml:para>Specifies the type of the newly created VDisk object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DiskType</command:parameterValue> <dev:type> <maml:name>DiskType</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Datastore</maml:name> <maml:description> <maml:para>Specifies the datastore on which you want to store the metadata of the VDisk object. For flat disk, the contents of the disk are also stored on the specified datastore.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Datastore</command:parameterValue> <dev:type> <maml:name>Datastore</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="named"> <maml:name>VMHost</maml:name> <maml:description> <maml:para>Specifies the virtual machine host which is connected to the SCSI LUN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMHost</command:parameterValue> <dev:type> <maml:name>VMHost</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ScsiLun</maml:name> <maml:description> <maml:para>Specifies the backing SCSI LUN for the newly created VDisk object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ScsiLun</command:parameterValue> <dev:type> <maml:name>ScsiLun</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>HardDisk</maml:name> <maml:description> <maml:para>Specifies the virtual hard disk object which you want to promote as a VDisk object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">HardDisk</command:parameterValue> <dev:type> <maml:name>HardDisk</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The newly created VDisk objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-VDisk -Name 'MyDisk' -CapacityGB 1 -Datastore $ds -DiskType Flat -StorageFormat Thin</dev:code> <dev:remarks> <maml:para>Creates a new thin-provisioned flat VDisk object named 'MyDisk' on the $ds datastore with capacity of 1 GB.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-VDisk -Name 'MyDisk' -Datastore $ds -DiskType RawPhysical -ScsiLun $scsiLun</dev:code> <dev:remarks> <maml:para>Creates a new physical raw VDisk object named 'MyDisk' backed by the $scsiLun SCSI LUN and with metadata on the $ds datastore.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-VDisk -HardDisk $hd -Name $newName</dev:code> <dev:remarks> <maml:para>Promotes the $hd virtual hard disk to a VDisk object.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/New-VDisk.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>New-VsanDisk</command:name> <maml:description> <maml:para>This cmdlet adds a host SCSI disk to a vSAN disk group.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>VsanDisk</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet adds a host SCSI disk to a vSAN disk group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-VsanDisk</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByValue)" position = "named" > <maml:name>VsanDiskGroup</maml:name> <maml:description> <maml:para>Specifies the disk group that the disk is added to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VsanDiskGroup</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CanonicalName</maml:name> <maml:description> <maml:para>Specifies the canonical name of the host SCSI disk that is added to the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>VsanDiskGroup</maml:name> <maml:description> <maml:para>Specifies the disk group that the disk is added to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VsanDiskGroup</command:parameterValue> <dev:type> <maml:name>VsanDiskGroup</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CanonicalName</maml:name> <maml:description> <maml:para>Specifies the canonical name of the host SCSI disk that is added to the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The newly created VsanDisk object</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Works only with vCenter Server 5.5 or later.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-VsanDisk -CanonicalName "DiskCanonicalName" -VsanDiskGroup $vsanDiskGroup</dev:code> <dev:remarks> <maml:para>Creates a new vSAN disk and adds the disk to the $vsanDiskGroup vSAN disk group.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/New-VsanDisk.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsanDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VsanDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>New-VsanDiskGroup</command:name> <maml:description> <maml:para>This cmdlet creates a new vSAN disk group backed by the specified devices.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>VsanDiskGroup</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet creates a new vSAN disk group backed by the specified solid-state device and hard disk devices.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-VsanDiskGroup</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>VMHost</maml:name> <maml:description> <maml:para>Specifies the hosts that the created groups are on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VMHost</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>SsdCanonicalName</maml:name> <maml:description> <maml:para>Specifies the canonical name of a solid-state device that would be used by this disk group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DataDiskCanonicalName</maml:name> <maml:description> <maml:para>Specifies the canonical name of hard disks that should be included in this disk group and used for data.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>VMHost</maml:name> <maml:description> <maml:para>Specifies the hosts that the created groups are on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMHost</command:parameterValue> <dev:type> <maml:name>VMHost</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SsdCanonicalName</maml:name> <maml:description> <maml:para>Specifies the canonical name of a solid-state device that would be used by this disk group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>DataDiskCanonicalName</maml:name> <maml:description> <maml:para>Specifies the canonical name of hard disks that should be included in this disk group and used for data.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The newly created VsanDiskGroup object</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Works only with vCenter Server 5.5 or later.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-VsanDiskGroup -VMHost $vmHost -SsdCanonicalName "MySsdCanonicalName" -DataDiskCanonicalName DataDisk1,DataDisk2</dev:code> <dev:remarks> <maml:para>Creates a new vSAN disk group at the $vmHost virtual machine host with a solid-state drive named "MySsdCanonicalName" and hard disks named DataDisk1 and DataDisk2.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/New-VsanDiskGroup.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsanDiskGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VsanDiskGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>New-VsanFaultDomain</command:name> <maml:description> <maml:para>This cmdlet creates a new vSAN fault domain in a cluster with specified virtual machine hosts.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>VsanFaultDomain</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet creates a new vSAN fault domain in a cluster with specified virtual machine hosts.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-VsanFaultDomain</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>VMHost</maml:name> <maml:description> <maml:para>Specifies the list of virtual machine hosts to become part of the fault domain. These hosts should be in same cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VMHost[]</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the new vSAN fault domain. The name should be unique within a cluster. The length of fault domain name should not exceed 256 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>VMHost</maml:name> <maml:description> <maml:para>Specifies the list of virtual machine hosts to become part of the fault domain. These hosts should be in same cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VMHost[]</command:parameterValue> <dev:type> <maml:name>VMHost[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the new vSAN fault domain. The name should be unique within a cluster. The length of fault domain name should not exceed 256 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The newly created VsanFaultDomain object</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-VsanFaultDomain -VMHost $vmHost1, $vmHost2 -Name "MyFaultDomainName"</dev:code> <dev:remarks> <maml:para>Creates a new vSAN fault domain named "MyFaultDomainName", which has virtual machine hosts $vmHost1 and $vmHost2.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/New-VsanFaultDomain.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsanFaultDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VsanFaultDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VsanFaultDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>New-VsanIscsiInitiatorGroup</command:name> <maml:description> <maml:para>This cmdlet adds a new vSAN iSCSI initiator group to a cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>VsanIscsiInitiatorGroup</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet adds a new vSAN iSCSI initiator group to a cluster.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-VsanIscsiInitiatorGroup</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the new vSAN iSCSI initiator group. The name should be unique within a cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "true" pipelineInput = "true (ByValue)" position = "2" > <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the clusters to which you want to add the vSAN iSCSI initiator group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Cluster</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the new vSAN iSCSI initiator group. The name should be unique within a cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="true (ByValue)" position="2"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the clusters to which you want to add the vSAN iSCSI initiator group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Cluster</command:parameterValue> <dev:type> <maml:name>Cluster</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The newly created VsanIscsiInitiatorGroup object</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-VsanIscsiInitiatorGroup -Name "Group1" -Cluster "vsan-cluster"</dev:code> <dev:remarks> <maml:para>Creates a new vSAN iSCSI initiator group named "Group1" in the "vsan-cluster" cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/New-VsanIscsiInitiatorGroup.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsanIscsiInitiatorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VsanIscsiInitiatorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VsanIscsiInitiatorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>New-VsanIscsiInitiatorGroupTargetAssociation</command:name> <maml:description> <maml:para>This cmdlet associates the specified vSAN iSCSI initiator group with specified vSAN iSCSI target to provide access to the target.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>VsanIscsiInitiatorGroupTargetAssociation</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet associates the specified vSAN iSCSI initiator group with specified vSAN iSCSI target to provide access to the target.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-VsanIscsiInitiatorGroupTargetAssociation</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>InitiatorGroup</maml:name> <maml:description> <maml:para>Specifies the vSAN iSCSI initiator group associated with the vSAN iSCSI target to which you have provided access.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VsanIscsiInitiatorGroup</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "true" pipelineInput = "true (ByValue)" position = "2" > <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the vSAN iSCSI target to which you want to provide access.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VsanIscsiTarget</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>InitiatorGroup</maml:name> <maml:description> <maml:para>Specifies the vSAN iSCSI initiator group associated with the vSAN iSCSI target to which you have provided access.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VsanIscsiInitiatorGroup</command:parameterValue> <dev:type> <maml:name>VsanIscsiInitiatorGroup</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="true (ByValue)" position="2"> <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the vSAN iSCSI target to which you want to provide access.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VsanIscsiTarget</command:parameterValue> <dev:type> <maml:name>VsanIscsiTarget</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The newly created VsanIscsiInitiatorGroupTargetAssociation object</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-VsanIscsiInitiatorGroupTargetAssociation -InitiatorGroup $initiatorGroup -Target $target</dev:code> <dev:remarks> <maml:para>Associates the $initiatorGroup initiator group with the $target iSCSI target.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/New-VsanIscsiInitiatorGroupTargetAssociation.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsanIscsiInitiatorGroupTargetAssociation</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VsanIscsiInitiatorGroupTargetAssociation</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>New-VsanIscsiLun</command:name> <maml:description> <maml:para>This cmdlet adds a new vSAN iSCSI LUN to a target.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>VsanIscsiLun</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet adds a new vSAN iSCSI LUN to a target.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-VsanIscsiLun</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the vSAN iSCSI target to which you want to add the LUN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VsanIscsiTarget</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the newly created vSAN iSCSI LUN. The name can indicate additional information about the LUN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>LunId</maml:name> <maml:description> <maml:para>Specifies the ID of the LUN. The value must be in the range from 0 to 255. If specified, the ID should be unique within a target.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CapacityGB</maml:name> <maml:description> <maml:para>Specifies the capacity of the newly created vSAN iSCSI LUN in gigabytes (GB).</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Decimal</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies the storage policy associated with the newly created vSAN iSCSI LUN. If not specified, the default storage policy defined in the iSCSI service is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >SpbmStoragePolicy</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="false" position="named"> <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the vSAN iSCSI target to which you want to add the LUN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VsanIscsiTarget</command:parameterValue> <dev:type> <maml:name>VsanIscsiTarget</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the newly created vSAN iSCSI LUN. The name can indicate additional information about the LUN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LunId</maml:name> <maml:description> <maml:para>Specifies the ID of the LUN. The value must be in the range from 0 to 255. If specified, the ID should be unique within a target.</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></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CapacityGB</maml:name> <maml:description> <maml:para>Specifies the capacity of the newly created vSAN iSCSI LUN in gigabytes (GB).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="named"> <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies the storage policy associated with the newly created vSAN iSCSI LUN. If not specified, the default storage policy defined in the iSCSI service is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SpbmStoragePolicy</command:parameterValue> <dev:type> <maml:name>SpbmStoragePolicy</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The newly created VsanIscsiLun object</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-VsanIscsiLun -Name "FirstLun" -Target $target -LunId 3 -CapacityGB 2</dev:code> <dev:remarks> <maml:para>Creates a new vSAN iSCSI LUN of capacity 2 GB named "FirstLun" in the $target iSCSI target and sets the value of LunId to 3.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/New-VsanIscsiLun.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsanIscsiLun</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VsanIscsiLun</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VsanIscsiLun</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>New-VsanIscsiTarget</command:name> <maml:description> <maml:para>This cmdlet adds a new vSAN iSCSI target to a cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>VsanIscsiTarget</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet adds a new vSAN iSCSI target to a cluster.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-VsanIscsiTarget</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the vSAN cluster on which you want to create the vSAN iSCSI target.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Cluster</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the newly created vSAN iSCSI target. The name should be unique within a cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>IscsiQualifiedName</maml:name> <maml:description> <maml:para>Specifies the IQN of the target. This parameter is optional and should be unique if specified. If not specified, the server generates a unique IQN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>NetworkInterface</maml:name> <maml:description> <maml:para>Specifies the VMkernel network interface which handles the iSCSI traffic. If not specified, the default VMkernel network interface defined in iSCSI target service is used. This parameter accepts an object of type HostVMKernelVirtualNic by silently converting it to the string name by using ArgumentTransformationAttribute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>TcpPort</maml:name> <maml:description> <maml:para>Specifies the network port on which the target is accessible. If specified, NetworkInterface should also be specified. If not specified, and if NetworkInterface is also not specified, the default port specified in iSCSI target service is used. If NetworkInterface is specified, the default port 3260 is used. The server automatically opens the firewall for the specified port.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AuthenticationType</maml:name> <maml:description> <maml:para>Specifies the authentication type for the vSAN iSCSI target.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VsanIscsiTargetAuthenticationType</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>IncomingChapUser</maml:name> <maml:description> <maml:para>Specifies the CHAP user name for the target. Applicable when the authentication type is Chap or MutualChap.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>IncomingChapSecret</maml:name> <maml:description> <maml:para>Specifies the CHAP user secret for the target. Applicable when the authentication type is Chap or MutualChap.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >SecureString</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>OutgoingChapUser</maml:name> <maml:description> <maml:para>Specifies the CHAP user name you want to attach to the initiator. Applicable when the authentication type is MutualChap.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>OutgoingChapSecret</maml:name> <maml:description> <maml:para>Specifies the CHAP user secret you want to attach to the initiator. Applicable when the authentication type is MutualChap.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >SecureString</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies the storage policy applied to the vSAN namespace of the iSCSI target. If not specified, the default storage policy defined in iSCSI service is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >SpbmStoragePolicy</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the vSAN cluster on which you want to create the vSAN iSCSI target.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Cluster</command:parameterValue> <dev:type> <maml:name>Cluster</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the newly created vSAN iSCSI target. The name should be unique within a cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IscsiQualifiedName</maml:name> <maml:description> <maml:para>Specifies the IQN of the target. This parameter is optional and should be unique if specified. If not specified, the server generates a unique IQN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkInterface</maml:name> <maml:description> <maml:para>Specifies the VMkernel network interface which handles the iSCSI traffic. If not specified, the default VMkernel network interface defined in iSCSI target service is used. This parameter accepts an object of type HostVMKernelVirtualNic by silently converting it to the string name by using ArgumentTransformationAttribute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TcpPort</maml:name> <maml:description> <maml:para>Specifies the network port on which the target is accessible. If specified, NetworkInterface should also be specified. If not specified, and if NetworkInterface is also not specified, the default port specified in iSCSI target service is used. If NetworkInterface is specified, the default port 3260 is used. The server automatically opens the firewall for the specified port.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthenticationType</maml:name> <maml:description> <maml:para>Specifies the authentication type for the vSAN iSCSI target.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VsanIscsiTargetAuthenticationType</command:parameterValue> <dev:type> <maml:name>VsanIscsiTargetAuthenticationType</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncomingChapUser</maml:name> <maml:description> <maml:para>Specifies the CHAP user name for the target. Applicable when the authentication type is Chap or MutualChap.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncomingChapSecret</maml:name> <maml:description> <maml:para>Specifies the CHAP user secret for the target. Applicable when the authentication type is Chap or MutualChap.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutgoingChapUser</maml:name> <maml:description> <maml:para>Specifies the CHAP user name you want to attach to the initiator. Applicable when the authentication type is MutualChap.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutgoingChapSecret</maml:name> <maml:description> <maml:para>Specifies the CHAP user secret you want to attach to the initiator. Applicable when the authentication type is MutualChap.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="named"> <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies the storage policy applied to the vSAN namespace of the iSCSI target. If not specified, the default storage policy defined in iSCSI service is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SpbmStoragePolicy</command:parameterValue> <dev:type> <maml:name>SpbmStoragePolicy</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The newly created VsanIscsiTarget target</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-VsanIscsiTarget -Name "Target1" -Cluster "vsan-cluster" -NetworkInterface "vmk0"</dev:code> <dev:remarks> <maml:para>Creates a new vSAN iSCSI target named "Target1" in the "vsan-cluster" cluster which uses a VMkernel network interface named "vmk0" for traffic.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/New-VsanIscsiTarget.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VsanIscsiTarget</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsanIscsiTarget</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VsanIscsiTarget</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VsanIscsiTarget</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Remove-KeyManagementServer</command:name> <maml:description> <maml:para>This cmdlet removes the specified key management servers from the vCenter Server systems.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>KeyManagementServer</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet removes the specified key management servers from the vCenter Server systems.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-KeyManagementServer</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>KeyManagementServer</maml:name> <maml:description> <maml:para>Specifies the key management server list you want to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >KeyManagementServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>KeyManagementServer</maml:name> <maml:description> <maml:para>Specifies the key management server list you want to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">KeyManagementServer[]</command:parameterValue> <dev:type> <maml:name>KeyManagementServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-KeyManagementServer $kms -Confirm:$false</dev:code> <dev:remarks> <maml:para>Removes the $kms key management server without asking for confirmation.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Remove-KeyManagementServer.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-KeyManagementServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-KeyManagementServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-KeyManagementServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Remove-NfsUser</command:name> <maml:description> <maml:para>This cmdlet deletes the specified NFS user accounts.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NfsUser</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet deletes the specified NFS user accounts.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NfsUser</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "1" > <maml:name>NfsUser</maml:name> <maml:description> <maml:para>Specifies the NFS user account you want to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NfsUser[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>NfsUser</maml:name> <maml:description> <maml:para>Specifies the NFS user account you want to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NfsUser[]</command:parameterValue> <dev:type> <maml:name>NfsUser[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-NfsUser -NfsUser $n1</dev:code> <dev:remarks> <maml:para>Deletes the specified NFS user account.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Remove-NfsUser.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-NfsUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-NfsUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-NfsUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Remove-SpbmStoragePolicy</command:name> <maml:description> <maml:para>This cmdlet deletes storage policies.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SpbmStoragePolicy</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet deletes storage policies.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-SpbmStoragePolicy</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies the storage policies to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SpbmStoragePolicy[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies the storage policies to be deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SpbmStoragePolicy[]</command:parameterValue> <dev:type> <maml:name>SpbmStoragePolicy[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Works only with vCenter Server 5.5 or later. For more information, see the VMware Storage Policy API Reference: https://pubs.vmware.com/vsphere-60/index.jsp#com.vmware.vspsdk.apiref.doc/right-pane.html</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-SpbmStoragePolicy -StoragePolicy $policy1, $policy2</dev:code> <dev:remarks> <maml:para>Deletes all storage policies represented by the $policy1 and $policy2 objects.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-SpbmStoragePolicy -StoragePolicy policytest*</dev:code> <dev:remarks> <maml:para>Deletes all storage policies whose name starts with "policytest".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Remove-SpbmStoragePolicy.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Remove-VAIOFilter</command:name> <maml:description> <maml:para>This cmdlet uninstalls VAIO filters from the clusters on which they are installed.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>VAIOFilter</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet uninstalls VAIO filters from the clusters on which they are installed. In case of failure, the exception references to the VAIOFilter as target object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VAIOFilter</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies the VAIO filter to be uninstalled from the cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VAIOFilter[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies the VAIO filter to be uninstalled from the cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VAIOFilter[]</command:parameterValue> <dev:type> <maml:name>VAIOFilter[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Works only with vCenter Server 6.0 or later.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-VAIOFilter -Filter $filter -Confirm:$false</dev:code> <dev:remarks> <maml:para>Uninstalls the $filter VAIO filter from the cluster it is installed on without asking for user confirmation.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Remove-VAIOFilter.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VAIOFilter</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VAIOFilter</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VAIOFilter</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Remove-VasaProvider</command:name> <maml:description> <maml:para>This cmdlet unregisters the specified VASA providers.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>VasaProvider</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet unregisters the specified VASA providers.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VasaProvider</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Provider</maml:name> <maml:description> <maml:para>Specifies the VASA provider you want to unregister. If not specified, all providers are unregistered.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VasaProvider[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>Provider</maml:name> <maml:description> <maml:para>Specifies the VASA provider you want to unregister. If not specified, all providers are unregistered.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VasaProvider[]</command:parameterValue> <dev:type> <maml:name>VasaProvider[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-VasaProvider -Provider $provider -Confirm:$false</dev:code> <dev:remarks> <maml:para>Unregisters the $provider VASA provider from the Storage Monitoring Service without asking for confirmation.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Remove-VasaProvider.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VasaProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VasaProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Remove-VDisk</command:name> <maml:description> <maml:para>This cmdlet removes VDisk objects and the associated backings from the datastore.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>VDisk</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet removes VDisk objects and the associated backings from the datastore. Removal of VDisk objects which are attached to a virtual machine is not allowed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VDisk</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "1" > <maml:name>VDisk</maml:name> <maml:description> <maml:para>Specifies the VDisk objects you want to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VDisk[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>VDisk</maml:name> <maml:description> <maml:para>Specifies the VDisk objects you want to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VDisk[]</command:parameterValue> <dev:type> <maml:name>VDisk[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-VDisk -VDisk $vDisk</dev:code> <dev:remarks> <maml:para>Removes the $vDisk VDisk object from the server and datastore.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Remove-VDisk.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Remove-VsanDisk</command:name> <maml:description> <maml:para>This cmdlet removes the specified hard disks from the specified vSAN disk group.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>VsanDisk</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet removes the specified hard disks from the specified vSAN disk group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VsanDisk</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "1" > <maml:name>VsanDisk</maml:name> <maml:description> <maml:para>Specifies the hard disks you want to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VsanDisk[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DataMigrationMode</maml:name> <maml:description> <maml:para>Specifies the action pertaining to vSAN data when the disk is removed. If not specified, the default value is Full.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VsanDataMigrationMode</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>VsanDisk</maml:name> <maml:description> <maml:para>Specifies the hard disks you want to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VsanDisk[]</command:parameterValue> <dev:type> <maml:name>VsanDisk[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DataMigrationMode</maml:name> <maml:description> <maml:para>Specifies the action pertaining to vSAN data when the disk is removed. If not specified, the default value is Full.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VsanDataMigrationMode</command:parameterValue> <dev:type> <maml:name>VsanDataMigrationMode</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Works only with vCenter Server 5.5 or later.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-VsanDisk -VsanDisk $vsanDisk -Confirm:$false</dev:code> <dev:remarks> <maml:para>Removes the $vsanDisk vSAN disk without asking for confirmation.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Remove-VsanDisk.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsanDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VsanDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Remove-VsanDiskGroup</command:name> <maml:description> <maml:para>This cmdlet removes vSAN disk groups.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>VsanDiskGroup</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet removes vSAN disk groups.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VsanDiskGroup</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "1" > <maml:name>VsanDiskGroup</maml:name> <maml:description> <maml:para>Specifies the vSAN disk groups you want to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VsanDiskGroup[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DataMigrationMode</maml:name> <maml:description> <maml:para>Specifies the action pertaining to vSAN data when the disk group is removed. If not specified, the default value is Full.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VsanDataMigrationMode</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>VsanDiskGroup</maml:name> <maml:description> <maml:para>Specifies the vSAN disk groups you want to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VsanDiskGroup[]</command:parameterValue> <dev:type> <maml:name>VsanDiskGroup[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DataMigrationMode</maml:name> <maml:description> <maml:para>Specifies the action pertaining to vSAN data when the disk group is removed. If not specified, the default value is Full.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VsanDataMigrationMode</command:parameterValue> <dev:type> <maml:name>VsanDataMigrationMode</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Works only with vCenter Server 5.5 or later.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-VsanDiskGroup -VsanDiskGroup $vsanDiskGroup -Confirm:$false</dev:code> <dev:remarks> <maml:para>Removes the $vsanDiskGroup vSAN disk group without asking for confirmation.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Remove-VsanDiskGroup.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsanDiskGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VsanDiskGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Remove-VsanFaultDomain</command:name> <maml:description> <maml:para>This cmdlet removes vSAN fault domains.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>VsanFaultDomain</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet removes vSAN fault domains.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VsanFaultDomain</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>VsanFaultDomain</maml:name> <maml:description> <maml:para>Specifies the list of VSAN fault domains you want to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VsanFaultDomain[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>VsanFaultDomain</maml:name> <maml:description> <maml:para>Specifies the list of VSAN fault domains you want to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VsanFaultDomain[]</command:parameterValue> <dev:type> <maml:name>VsanFaultDomain[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-VsanFaultDomain -VsanFaultDomain $vsanFaultDomain -Confirm:$false</dev:code> <dev:remarks> <maml:para>Removes the $vsanFaultDomain vSAN fault domain without asking for confirmation.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Remove-VsanFaultDomain.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsanFaultDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VsanFaultDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VsanFaultDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Remove-VsanIscsiInitiatorGroup</command:name> <maml:description> <maml:para>This cmdlet removes the specified vSAN iSCSI initiator groups from their clusters.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>VsanIscsiInitiatorGroup</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet removes the specified vSAN iSCSI initiator groups from their clusters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VsanIscsiInitiatorGroup</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>InitiatorGroup</maml:name> <maml:description> <maml:para>Specifies the vSAN iSCSI initiator groups you want to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VsanIscsiInitiatorGroup[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>InitiatorGroup</maml:name> <maml:description> <maml:para>Specifies the vSAN iSCSI initiator groups you want to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VsanIscsiInitiatorGroup[]</command:parameterValue> <dev:type> <maml:name>VsanIscsiInitiatorGroup[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-VsanIscsiInitiatorGroup -InitiatorGroup $initiatorGroup -Confirm:$false</dev:code> <dev:remarks> <maml:para>Removes the $initiatorGroup iSCSI initiator group without asking for confirmation.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Remove-VsanIscsiInitiatorGroup.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsanIscsiInitiatorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VsanIscsiInitiatorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VsanIscsiInitiatorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Remove-VsanIscsiInitiatorGroupTargetAssociation</command:name> <maml:description> <maml:para>This cmdlet removes the specified association of vSAN iSCSI initiator group and target.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>VsanIscsiInitiatorGroupTargetAssociation</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet removes the specified association of vSAN iSCSI initiator group and target.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VsanIscsiInitiatorGroupTargetAssociation</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "1" > <maml:name>InitiatorGroupTargetAssociation</maml:name> <maml:description> <maml:para>Specifies the vSAN iSCSI initiator group and target associations you want to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VsanIscsiInitiatorGroupTargetAssociation[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>InitiatorGroupTargetAssociation</maml:name> <maml:description> <maml:para>Specifies the vSAN iSCSI initiator group and target associations you want to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VsanIscsiInitiatorGroupTargetAssociation[]</command:parameterValue> <dev:type> <maml:name>VsanIscsiInitiatorGroupTargetAssociation[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-VsanIscsiInitiatorGroupTargetAssociation -InitiatorGroupTargetAssociation $association -Confirm:$false</dev:code> <dev:remarks> <maml:para>Removes the iSCSI initiator group to the $association target association without asking for confirmation.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Remove-VsanIscsiInitiatorGroupTargetAssociation.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsanIscsiInitiatorGroupTargetAssociation</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VsanIscsiInitiatorGroupTargetAssociation</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Remove-VsanIscsiLun</command:name> <maml:description> <maml:para>This cmdlet removes vSAN iSCSI LUNs from their iSCSI targets.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>VsanIscsiLun</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet removes vSAN iSCSI LUNs from their iSCSI targets.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VsanIscsiLun</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Lun</maml:name> <maml:description> <maml:para>Specifies the vSAN iSCSI LUNs you want to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VsanIscsiLun[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Lun</maml:name> <maml:description> <maml:para>Specifies the vSAN iSCSI LUNs you want to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VsanIscsiLun[]</command:parameterValue> <dev:type> <maml:name>VsanIscsiLun[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-VsanIscsiLun -Lun $lun -Confirm:$false</dev:code> <dev:remarks> <maml:para>Removes the $lun iSCSI LUN without asking for confirmation.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Remove-VsanIscsiLun.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsanIscsiLun</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VsanIscsiLun</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VsanIscsiLun</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Remove-VsanIscsiTarget</command:name> <maml:description> <maml:para>This cmdlet removes vSAN iSCSI targets form their clusters.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>VsanIscsiTarget</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet removes vSAN iSCSI targets form their clusters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VsanIscsiTarget</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the vSAN iSCSI targets you want to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VsanIscsiTarget[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the vSAN iSCSI targets you want to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VsanIscsiTarget[]</command:parameterValue> <dev:type> <maml:name>VsanIscsiTarget[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-VsanIscsiTarget -Target $target -Confirm:$false</dev:code> <dev:remarks> <maml:para>Removes the $target iSCSI target without asking for confirmation.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Remove-VsanIscsiTarget.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsanIscsiTarget</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VsanIscsiTarget</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VsanIscsiTarget</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Repair-VsanObject</command:name> <maml:description> <maml:para>This cmdlet puts a list of vSAN cluster objects in a repair queue.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Repair</command:verb> <command:noun>VsanObject</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet puts a list of vSAN cluster objects in a repair queue.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Repair-VsanObject</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the vSAN cluster from which you want to repair objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Cluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the vSAN cluster from which you want to repair objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Cluster[]</command:parameterValue> <dev:type> <maml:name>Cluster[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Repair-VsanObject -Cluster $vsanCluster</dev:code> <dev:remarks> <maml:para>Puts the vSAN objects of the $vsanCluster cluster in the repair queue.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Repair-VsanObject.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Set-KeyManagementServer</command:name> <maml:description> <maml:para>This cmdlet configures the settings of the key management server.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Set</command:verb> <command:noun>KeyManagementServer</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet configures the settings of the key management server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-KeyManagementServer</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>KeyManagementServer</maml:name> <maml:description> <maml:para>Specifies the key management servers you want to configure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >KeyManagementServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Address</maml:name> <maml:description> <maml:para>Specifies the new address of the key management server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the new port number of the key management server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>TrustKeyManagementServer</maml:name> <maml:description> <maml:para>Indicates whether the vCenter Server system can trust the key management server certificate. Revoking trust of the key management server is not supported.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ProxyAddress</maml:name> <maml:description> <maml:para>Specifies the new address of the proxy server. If you want to unset the address, set the value to an empty string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Specifies the new port number of the proxy server. If you want to unset the port number, set the value to -1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Username</maml:name> <maml:description> <maml:para>Specifies the new user name you want to use for authenticating with the Key Management Interoperability Protocol server. If you want to unset the user name, set the value to an empty string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the new password you want to use for authenticating with the Key Management Interoperability Protocol server. If you want to unset the password, set the value to an empty string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >SecureString</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a PSCredential object that contains credentials for authenticating with the key management server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >PSCredential</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>KeyManagementServer</maml:name> <maml:description> <maml:para>Specifies the key management servers you want to configure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">KeyManagementServer[]</command:parameterValue> <dev:type> <maml:name>KeyManagementServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Address</maml:name> <maml:description> <maml:para>Specifies the new address of the key management 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the new port number of the key management server.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TrustKeyManagementServer</maml:name> <maml:description> <maml:para>Indicates whether the vCenter Server system can trust the key management server certificate. Revoking trust of the key management server is not supported.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProxyAddress</maml:name> <maml:description> <maml:para>Specifies the new address of the proxy server. If you want to unset the address, set the value to an empty string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Specifies the new port number of the proxy server. If you want to unset the port number, set the value to -1.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Username</maml:name> <maml:description> <maml:para>Specifies the new user name you want to use for authenticating with the Key Management Interoperability Protocol server. If you want to unset the user name, set the value to an empty string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the new password you want to use for authenticating with the Key Management Interoperability Protocol server. If you want to unset the password, set the value to an empty string.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a PSCredential object that contains credentials for authenticating with the key management server.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The list of modified KeyManagementServer objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-KeyManagementServer -KeyManagementServer $kms -Address $newKmsAddress -Port $newKmsPort</dev:code> <dev:remarks> <maml:para>Updates the $kms key management server with $newKmsAddress as the new key management server address and $newKmsPort as the new key management server port.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-KeyManagementServer -KeyManagementServer $kms -Name 'NewName'</dev:code> <dev:remarks> <maml:para>Renames the $kms key management server to 'NewName'.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Set-KeyManagementServer.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-KeyManagementServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-KeyManagementServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-KeyManagementServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Set-KmsCluster</command:name> <maml:description> <maml:para>This cmdlet configures the settings of the specified key management server clusters.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Set</command:verb> <command:noun>KmsCluster</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet configures the settings of the specified key management server clusters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-KmsCluster</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>KmsCluster</maml:name> <maml:description> <maml:para>Specifies the key management server clusters you want to configure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >KmsCluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>UseAsDefaultKeyProvider</maml:name> <maml:description> <maml:para>Specifies the key management server cluster you want to use as the default key provider.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>SelfSignedClientCertificate</maml:name> <maml:description> <maml:para>Specifies the self-signed certificate for the key management server IP cluster. The server uses the certificate for authentication with the key management server in the cluster. Either this parameter or the SelfSignedClientCertificateFilePath parameter should be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>SelfSignedClientCertificateFilePath</maml:name> <maml:description> <maml:para>Specifies the file path to the self-signed certificate. Either this parameter or the SelfSignedClientCertificate parameter should be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-KmsCluster</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>KmsCluster</maml:name> <maml:description> <maml:para>Specifies the key management server clusters you want to configure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >KmsCluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>UseAsDefaultKeyProvider</maml:name> <maml:description> <maml:para>Specifies the key management server cluster you want to use as the default key provider.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>KmsSignedClientCertificate</maml:name> <maml:description> <maml:para>Uploads the key management server-signed client certificate for the key management IP cluster. The server uses the certificate for authentication with the key management server in the cluster. Either this parameter or the KmsSignedClientCertificateFilePath parameter should be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>KmsSignedClientCertificateFilePath</maml:name> <maml:description> <maml:para>Specifies the file path to the certificate file signed by the key management server. Either this parameter or the KmsSignedClientCertificate parameter should be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-KmsCluster</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>KmsCluster</maml:name> <maml:description> <maml:para>Specifies the key management server clusters you want to configure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >KmsCluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>UseAsDefaultKeyProvider</maml:name> <maml:description> <maml:para>Specifies the key management server cluster you want to use as the default key provider.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>KmsProvidedClientCertificate</maml:name> <maml:description> <maml:para>Specifies the certificate provided by the key management server and its private key. Either this parameter or the KmsProvidedClientCertificateFilePath parameter should be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>KmsProvidedClientCertificateFilePath</maml:name> <maml:description> <maml:para>Specifies the file path to the certificate file provided by the key management server. Either this parameter or the KmsProvidedClientCertificate parameter should be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>KmsProvidedPrivateKey</maml:name> <maml:description> <maml:para>Specifies the private key for the key management IP client, if it is provided by the key management server. Either this parameter or the KmsProvidedPrivateKeyFilePath parameter should be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >SecureString</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>KmsProvidedPrivateKeyFilePath</maml:name> <maml:description> <maml:para>Specifies the private key file path provided by the key management server. Either this parameter or the KmsProvidedPrivateKey parameter should be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>KmsCluster</maml:name> <maml:description> <maml:para>Specifies the key management server clusters you want to configure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">KmsCluster[]</command:parameterValue> <dev:type> <maml:name>KmsCluster[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseAsDefaultKeyProvider</maml:name> <maml:description> <maml:para>Specifies the key management server cluster you want to use as the default key provider.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SelfSignedClientCertificate</maml:name> <maml:description> <maml:para>Specifies the self-signed certificate for the key management server IP cluster. The server uses the certificate for authentication with the key management server in the cluster. Either this parameter or the SelfSignedClientCertificateFilePath parameter should 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SelfSignedClientCertificateFilePath</maml:name> <maml:description> <maml:para>Specifies the file path to the self-signed certificate. Either this parameter or the SelfSignedClientCertificate parameter should 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KmsSignedClientCertificate</maml:name> <maml:description> <maml:para>Uploads the key management server-signed client certificate for the key management IP cluster. The server uses the certificate for authentication with the key management server in the cluster. Either this parameter or the KmsSignedClientCertificateFilePath parameter should 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KmsSignedClientCertificateFilePath</maml:name> <maml:description> <maml:para>Specifies the file path to the certificate file signed by the key management server. Either this parameter or the KmsSignedClientCertificate parameter should 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KmsProvidedClientCertificate</maml:name> <maml:description> <maml:para>Specifies the certificate provided by the key management server and its private key. Either this parameter or the KmsProvidedClientCertificateFilePath parameter should 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KmsProvidedClientCertificateFilePath</maml:name> <maml:description> <maml:para>Specifies the file path to the certificate file provided by the key management server. Either this parameter or the KmsProvidedClientCertificate parameter should 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KmsProvidedPrivateKey</maml:name> <maml:description> <maml:para>Specifies the private key for the key management IP client, if it is provided by the key management server. Either this parameter or the KmsProvidedPrivateKeyFilePath parameter should be specified.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KmsProvidedPrivateKeyFilePath</maml:name> <maml:description> <maml:para>Specifies the private key file path provided by the key management server. Either this parameter or the KmsProvidedPrivateKey parameter should 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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The list of modified KmsCluster objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-KmsCluster -KmsCluster $kmsCluster -SelfSignedClientCertificate $certificate -UseAsDefaultKeyProvider</dev:code> <dev:remarks> <maml:para>Updates the client certificate with the $certificate self-signed certificate and marks the $kmsCluster key management server cluster as the default key provider.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-KmsCluster -KmsCluster $kmsCluster -KmsProvidedClientCertificate $certificate -KmsProvidedPrivateKey $privateKey</dev:code> <dev:remarks> <maml:para>Updates the client certificate and its private key with $certificate and $privateKey for the $kmsCluster key management server cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Set-KmsCluster.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-KmsCluster</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Set-NfsUser</command:name> <maml:description> <maml:para>This cmdlet configures existing NFS user accounts by changing the password associated with the account.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NfsUser</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet configures existing NFS user accounts by changing the password associated with the account. The virtual machine host must be part of an Active Directory domain for the cmdlet to run successfully.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NfsUser</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "named" > <maml:name>NfsUser</maml:name> <maml:description> <maml:para>Specifies the NFS user account you want to configure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NfsUser[]</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the new password for authentication. This parameter accepts both secure and plain strings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >SecureString</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>NfsUser</maml:name> <maml:description> <maml:para>Specifies the NFS user account you want to configure.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NfsUser[]</command:parameterValue> <dev:type> <maml:name>NfsUser[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the new password for authentication. This parameter accepts both secure and plain strings.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The modified NfsUser object</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-NfsUser -NfsUser $n1 -Password "password2"</dev:code> <dev:remarks> <maml:para>Sets "password2" as the new password for the $n1 NFS user account.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Set-NfsUser.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-NfsUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-NfsUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-NfsUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Set-SpbmEntityConfiguration</command:name> <maml:description> <maml:para>This cmdlet sets SPBM-related configuration data for VirtualMachine, HardDisk and Cluster objects.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SpbmEntityConfiguration</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet sets SPBM-related configuration data for VirtualMachine, HardDisk and Cluster objects. The configuration data includes storage policy association for VirtualMachine and HardDisk objects and SPBM enablement for Cluster objects.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-SpbmEntityConfiguration</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specifies the configuration to modify. The supported types are SpbmClusterConfiguration, SpbmVMConfiguration, and SpbmHardDiskConfiguration. This parameter supports OBN based on the names of the associated Cluster and VirtualMachine objects. This parameter also directly accepts objects of type Cluster, VirtualMachine, and HardDisk by silently converting them to the corresponding configuration object through a ArgumentTransformationAttribute object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SpbmEntityConfiguration[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>SpbmEnabled</maml:name> <maml:description> <maml:para>Indicates whether to enable or disable SPBM on a cluster. Only applicable to SpbmClusterConfiguration objects. Attempts to apply to other configuration objects are ignored.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies the storage policy to be applied to all VirtualMachine and HardDisk objects defined in the Configuration objects. If the value is $null, removes the current policy association. Only applicable to VirtualMachine and HardDisk configuration objects. Attempts to apply to Cluster configuration objects are ignored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >SpbmStoragePolicy</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AutoReplicationGroup</maml:name> <maml:description> <maml:para>Specify this if you do not want to explicitly provide a replication group and instead want to place the entity in the default replication group decided by the VASA provider. If ReplicationGroup and AutoReplicationGroup are both specified, an error is thrown. If none of them are specified, the entity is not placed in any replication group.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ReplicationGroup</maml:name> <maml:description> <maml:para>Specifies the replication group in which to put VirtualMachine and HardDisk objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >SpbmReplicationGroup</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VIServer</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specifies the configuration to modify. The supported types are SpbmClusterConfiguration, SpbmVMConfiguration, and SpbmHardDiskConfiguration. This parameter supports OBN based on the names of the associated Cluster and VirtualMachine objects. This parameter also directly accepts objects of type Cluster, VirtualMachine, and HardDisk by silently converting them to the corresponding configuration object through a ArgumentTransformationAttribute object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SpbmEntityConfiguration[]</command:parameterValue> <dev:type> <maml:name>SpbmEntityConfiguration[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SpbmEnabled</maml:name> <maml:description> <maml:para>Indicates whether to enable or disable SPBM on a cluster. Only applicable to SpbmClusterConfiguration objects. Attempts to apply to other configuration objects are ignored.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="named"> <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies the storage policy to be applied to all VirtualMachine and HardDisk objects defined in the Configuration objects. If the value is $null, removes the current policy association. Only applicable to VirtualMachine and HardDisk configuration objects. Attempts to apply to Cluster configuration objects are ignored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SpbmStoragePolicy</command:parameterValue> <dev:type> <maml:name>SpbmStoragePolicy</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AutoReplicationGroup</maml:name> <maml:description> <maml:para>Specify this if you do not want to explicitly provide a replication group and instead want to place the entity in the default replication group decided by the VASA provider. If ReplicationGroup and AutoReplicationGroup are both specified, an error is thrown. If none of them are specified, the entity is not placed in any replication group.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReplicationGroup</maml:name> <maml:description> <maml:para>Specifies the replication group in which to put VirtualMachine and HardDisk objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SpbmReplicationGroup</command:parameterValue> <dev:type> <maml:name>SpbmReplicationGroup</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VIServer</command:parameterValue> <dev:type> <maml:name>VIServer</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>A list of modified objects derived from SpbmEntityConfiguration. Types include SpbmVMConfiguration, SpbmHardDiskConfiguration, SpbmClusterConfiguration. Returns one output object for each input object. For example, if a virtual machine does not have a storage policy, the cmdlet returns a result for it with the policy property set to $null.</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Works only with vCenter Server 5.5 or later. For more information, see the VMware Storage Policy API Reference: https://pubs.vmware.com/vsphere-60/index.jsp#com.vmware.vspsdk.apiref.doc/right-pane.html</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-SpbmEntityConfiguration -Configuration (Get-SpbmEntityConfiguration $cluster1) -SpbmEnabled $true</dev:code> <dev:remarks> <maml:para>Enables SPBM for the $cluster1 cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-SpbmEntityConfiguration -Configuration (Get-SpbmEntityConfiguration $cluster1) -SpbmEnabled $false</dev:code> <dev:remarks> <maml:para>Disables SPBM for the $cluster1 cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-SpbmEntityConfiguration -Configuration (Get-SpbmEntityConfiguration $vm1, $vm2) -StoragePolicy $policy</dev:code> <dev:remarks> <maml:para>Associates the $policy storage policy to the $vm1 and $vm2 virtual machines.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 4 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-SpbmEntityConfiguration -Configuration (Get-SpbmEntityConfiguration $hd1) -StoragePolicy $policy</dev:code> <dev:remarks> <maml:para>Associates the $policy storage policy to the $hd1 hard disk.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 5 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-SpbmEntityConfiguration -Configuration (Get-SpbmEntityConfiguration $vm1) -StoragePolicy $null</dev:code> <dev:remarks> <maml:para>Removes the association of the $vm1 virtual machine from the storage policy it is associated with, if any.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 6 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-SpbmEntityConfiguration -Configuration (Get-SpbmEntityConfiguration $hd1) -StoragePolicy $null</dev:code> <dev:remarks> <maml:para>Removes the association of the $hd1 hard disk from the storage policy it is associated with, if any.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 7 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-SpbmEntityConfiguration -Configuration "MyVM" -StoragePolicy $null</dev:code> <dev:remarks> <maml:para>Removes the association of the "MyVM" virtual machine from the storage policy it is associated with, if any.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 8 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-SpbmEntityConfiguration -Configuration "MyCluster" -SpbmEnabled $true</dev:code> <dev:remarks> <maml:para>Enables SPBM for the "MyCluster" cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 9 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-SpbmEntityConfiguration -Configuration $vm, $hd -StoragePolicy $replicationPolicy -ReplicationGroup $sourceRg</dev:code> <dev:remarks> <maml:para>Associates the $replicationPolicy storage policy to the $vm virtual machine and $hd hard disk, and puts them in the $sourceRg replication group.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Set-SpbmEntityConfiguration.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-SpbmEntityConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Set-SpbmStoragePolicy</command:name> <maml:description> <maml:para>This cmdlet overrides the current name, description, and rule sets of an existing storage policy in an SPBM server.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SpbmStoragePolicy</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet overrides the current name, description, and rule sets of an existing storage policy in an SPBM server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-SpbmStoragePolicy</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies the storage policy to modify.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SpbmStoragePolicy[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a new name for the storage policy. The maximum length of the name is 80 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a new description for the storage policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AnyOfRuleSets</maml:name> <maml:description> <maml:para>Specifies an array to overwrite the current rule sets in the policy. The SPBM rule sets should not contain SPBM rules from the VAIOFilter namespace.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SpbmRuleSet[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CommonRule</maml:name> <maml:description> <maml:para>Specifies the SPBM rules from the VAIOFilter namespace only. These rules are considered with all the SPBM rule sets as common requirements.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SpbmRule[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VIServer</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies the storage policy to modify.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SpbmStoragePolicy[]</command:parameterValue> <dev:type> <maml:name>SpbmStoragePolicy[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a new name for the storage policy. The maximum length of the name is 80 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a new description for 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AnyOfRuleSets</maml:name> <maml:description> <maml:para>Specifies an array to overwrite the current rule sets in the policy. The SPBM rule sets should not contain SPBM rules from the VAIOFilter namespace.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SpbmRuleSet[]</command:parameterValue> <dev:type> <maml:name>SpbmRuleSet[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>CommonRule</maml:name> <maml:description> <maml:para>Specifies the SPBM rules from the VAIOFilter namespace only. These rules are considered with all the SPBM rule sets as common requirements.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SpbmRule[]</command:parameterValue> <dev:type> <maml:name>SpbmRule[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VIServer</command:parameterValue> <dev:type> <maml:name>VIServer</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The modified SpbmStoragePolicy object</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Works only with vCenter Server 5.5 or later. For more information, see the VMware Storage Policy API Reference: https://pubs.vmware.com/vsphere-60/index.jsp#com.vmware.vspsdk.apiref.doc/right-pane.html</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-SpbmStoragePolicy -StoragePolicy $policy -Name "NewName" -Description NewDescription</dev:code> <dev:remarks> <maml:para>Modifies the name and description of the $policy policy object.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-SpbmStoragePolicy -StoragePolicy $policy -AnyOfRuleSets $ruleset1, $ruleset2</dev:code> <dev:remarks> <maml:para>Updates the $policy policy object with the $ruleset1 and $ruleset2 rule set objects which overwrite the existing rule sets in the policy.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>$p2 = Set-SpbmStoragePolicy -StoragePolicy $p1 -CommonRule $cr</dev:code> <dev:remarks> <maml:para>Modifies a storage policy to add a VAIOFilter rule.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 4 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>$p2 = Set-SpbmStoragePolicy -StoragePolicy $p1 -CommonRule @()</dev:code> <dev:remarks> <maml:para>Modifies a storage policy to remove all VAIOFilter rules.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 5 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>$p2 = Set-SpbmStoragePolicy -StoragePolicy $p1 -CommonRule @($cr1, $cr2)</dev:code> <dev:remarks> <maml:para>Modifies a storage policy to add a VAIOFilter rule $cr2 to an existing VAIOFilter rule $cr1.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Set-SpbmStoragePolicy.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-SpbmStoragePolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Set-VAIOFilter</command:name> <maml:description> <maml:para>This cmdlet upgrades a VAIO filter on the cluster it is installed.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Set</command:verb> <command:noun>VAIOFilter</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet upgrades a VAIO filter on the cluster it is installed. The updated SPBM metadata of the VAIO filter might not appear immediately in the list of capabilities. In case of failure, the exception contains a reference to the VAIO filter as a target object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VAIOFilter</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies the VAIO filter to upgrade.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VAIOFilter[]</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "2" > <maml:name>VibUrl</maml:name> <maml:description> <maml:para>Specifies the URL that points to the VAIO filter VIB package. The accepted formats are HTTP and HTTPS.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VIServer</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies the VAIO filter to upgrade.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VAIOFilter[]</command:parameterValue> <dev:type> <maml:name>VAIOFilter[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>VibUrl</maml:name> <maml:description> <maml:para>Specifies the URL that points to the VAIO filter VIB package. The accepted formats are HTTP and HTTPS.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VIServer</command:parameterValue> <dev:type> <maml:name>VIServer</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The list of upgraded VAIO filters</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-VAIOFilter -Filter $filter -VibUrl "NewVibUr"</dev:code> <dev:remarks> <maml:para>Updates the $filter VAIO filter and sets the VIB URL to "NewVibUrl". The version of the new VIB should be higher than the existing filter version.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Set-VAIOFilter.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VAIOFilter</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VAIOFilter</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VAIOFilter</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Set-VDisk</command:name> <maml:description> <maml:para>This cmdlet renames, inflates, or extends the size of the specified VDisk object.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Set</command:verb> <command:noun>VDisk</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet renames, inflates, or extends the size of the specified VDisk object. If multiple options are specified, they are performed in the following order. 1. Rename 2. Inflate 3. Extend the size VDisk objects cannot be extended to a size that is smaller than or equal to the existing size.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VDisk</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "1" > <maml:name>VDisk</maml:name> <maml:description> <maml:para>Specifies the VDisk objects you want to modify.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VDisk[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the new name you want to set for the VDisk object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Inflate</maml:name> <maml:description> <maml:para>Indicates to inflate the specified VDisk object. Inflating is supported only on thin-provisioned VDisk objects.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CapacityGB</maml:name> <maml:description> <maml:para>Specifies the new capacity of the VDisk object in gigabytes (GB).</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Decimal</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>VDisk</maml:name> <maml:description> <maml:para>Specifies the VDisk objects you want to modify.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VDisk[]</command:parameterValue> <dev:type> <maml:name>VDisk[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the new name you want to set for the VDisk 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Inflate</maml:name> <maml:description> <maml:para>Indicates to inflate the specified VDisk object. Inflating is supported only on thin-provisioned VDisk objects.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CapacityGB</maml:name> <maml:description> <maml:para>Specifies the new capacity of the VDisk object in gigabytes (GB).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The modified VDisk objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-VDisk -VDisk $vDisk -Name 'NewName' -CapacityGB 2</dev:code> <dev:remarks> <maml:para>Renames $vDisk VDisk object to 'NewName' and sets its capacity to 2 GB.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-VDisk -VDisk $vDisk -Inflate</dev:code> <dev:remarks> <maml:para>Inflates the $vDisk VDisk object.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Set-VDisk.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VDisk</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Set-VsanClusterConfiguration</command:name> <maml:description> <maml:para>This cmdlet sets vSAN configuration settings for a cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Set</command:verb> <command:noun>VsanClusterConfiguration</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet sets vSAN configuration settings for a cluster.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VsanClusterConfiguration</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specifies the configurations to modify. This parameter supports OBN based on the names of the associated cluster. This parameter also directly accepts objects of type Cluster by silently converting them to the configuration object through ArgumentTransformationAttribute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VsanClusterConfiguration[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>HealthCheckIntervalMinutes</maml:name> <maml:description> <maml:para>Specifies the health check interval in minutes. If the value of this parameter is non-zero, then health check is enabled on the cluster and health check frequency is set to the specified value. If the value of the parameter is zero, then health check is disabled on the cluster. The accepted values are from 15 minutes to one day (1440 minutes).</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>SpaceEfficiencyEnabled</maml:name> <maml:description> <maml:para>Enables and disables deduplication and compression on a vSAN cluster. Both deduplication and compression are enabled or disabled together.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PerformanceServiceEnabled</maml:name> <maml:description> <maml:para>Enables or disables performance service on a vSAN cluster.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AllowReducedRedundancy</maml:name> <maml:description> <maml:para>Allows reduced redundancy state. This optional parameter is applicable to specific vSAN cluster reconfigure operations that need to migrate data across cluster for changing vSAN disk format. When specified, it might make the process move lesser data in order to ensure storage object accessibility, and some objects will be kept at reduced redundancy state, which means at a higher risk in case of a hardware failure during the migration process. This is applicable to the SpaceEfficiencyEnabled parameter only. The default value is False.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies the storage policy. This parameter is applicable in the context of enabling the VirtualSAN performance service. The vSAN performance history database is stored as a vSAN object. The policy controls the availability, space consumption and performance of that object. If the object becomes unavailable, the performance history for that cluster will also be unavailable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >SpbmStoragePolicy</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>StretchedClusterEnabled</maml:name> <maml:description> <maml:para>Enables or disables stretched cluster configuration.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>PreferredFaultDomain</maml:name> <maml:description> <maml:para>Specifies the preferred fault domain. If stretched cluster configuration is enabled, this becomes the preferred fault domain for this cluster. The other fault domain in this stretched cluster becomes the secondary fault domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VsanFaultDomain</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>WitnessHost</maml:name> <maml:description> <maml:para>Specifies the witness host virtual machine in case StretchedClusterEnabled is enabled. It can also be a vSphere virtual appliance called witness appliance. Requirements for witness host: - Must not be part of any vSAN-enabled cluster. - Must have at least one VMkernel adapter with vSAN traffic enabled. - That adapter must be connected to all hosts in the stretched cluster. In vSAN versions earlier than 6.6, this parameter is only applicable when enabling stretched cluster. If StretchedClusterEnabled is not specified or is false, then this parameter is ignored. In vSAN 6.7 or later, this parameter can be specified to update the witness host in a stretched cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VMHost</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WitnessHostCacheDisk</maml:name> <maml:description> <maml:para>Specifies cache disk canonical name for the disk group to be created on the witness host. Also accepts ScsiLun or VMHostDisk objects through argument transformation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WitnessHostCapacityDisk</maml:name> <maml:description> <maml:para>Specifies the capacity disk canonical names for the disk group to be created on the witness host. Also accepts ScsiLun or VMHostDisk objects through argument transformation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>IscsiTargetServiceEnabled</maml:name> <maml:description> <maml:para>Enables or disables the iSCSI target service on a vSAN cluster.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DefaultIscsiNetworkInterface</maml:name> <maml:description> <maml:para>Specifies the default VMkernel network interface which handles the iSCSI traffic. Can be overridden per target. Mandatory if IscsiTargetServiceEnabled is specified as $true. This parameter accepts an object of type HostVMKernelVirtualNic by silently converting it to the string name by using ArgumentTransformationAttribute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DefaultIscsiTcpPort</maml:name> <maml:description> <maml:para>Specifies the default network port for iSCSI targets. Can be overridden per target. If not provided, the default port 3260 is used. The server automatically opens the firewall for the specified port.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DefaultIscsiTargetAuthenticationType</maml:name> <maml:description> <maml:para>Specifies the default authentication type for vSAN iSCSI targets in this cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VsanIscsiTargetAuthenticationType</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DefaultIncomingChapUser</maml:name> <maml:description> <maml:para>Specifies the default CHAP user name for iSCSI targets on this cluster. Applicable when the authentication type is Chap or MutualChap.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DefaultIncomingChapSecret</maml:name> <maml:description> <maml:para>Specifies the default CHAP secret for iSCSI targets on this cluster. Applicable when the authentication type is Chap or MutualChap.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >SecureString</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DefaultOutgoingChapUser</maml:name> <maml:description> <maml:para>Specifies the default CHAP user name you want to attach to the initiator. Applicable when the authentication type is MutualChap.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DefaultOutgoingChapSecret</maml:name> <maml:description> <maml:para>Specifies the default CHAP user secret you want to attach to the initiator. Applicable when the authentication type is MutualChap.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >SecureString</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>StoragePolicyForIscsiTargetService</maml:name> <maml:description> <maml:para>Specifies the storage policy for the iSCSI target service. When you enable the iSCSI target service, vSAN creates a home object that stores metadata for the iSCSI target service. The storage policy for the home object should have a number of failures to tolerate of 1 or more.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >SpbmStoragePolicy</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AddSilentHealthCheck</maml:name> <maml:description> <maml:para>Specifies the health checks list you want to add to the silent list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RemoveSilentHealthCheck</maml:name> <maml:description> <maml:para>Specifies the health checks list you want to remove from the silent list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ResyncThrottlingMbps</maml:name> <maml:description> <maml:para>Specifies the resynchronization traffic limit in Mbps for each disk group in the cluster. The valid values are from 1 to 512. If the value of the parameter is zero, throttling resynchronization traffic limits are disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>Configuration</maml:name> <maml:description> <maml:para>Specifies the configurations to modify. This parameter supports OBN based on the names of the associated cluster. This parameter also directly accepts objects of type Cluster by silently converting them to the configuration object through ArgumentTransformationAttribute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VsanClusterConfiguration[]</command:parameterValue> <dev:type> <maml:name>VsanClusterConfiguration[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HealthCheckIntervalMinutes</maml:name> <maml:description> <maml:para>Specifies the health check interval in minutes. If the value of this parameter is non-zero, then health check is enabled on the cluster and health check frequency is set to the specified value. If the value of the parameter is zero, then health check is disabled on the cluster. The accepted values are from 15 minutes to one day (1440 minutes).</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SpaceEfficiencyEnabled</maml:name> <maml:description> <maml:para>Enables and disables deduplication and compression on a vSAN cluster. Both deduplication and compression are enabled or disabled together.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PerformanceServiceEnabled</maml:name> <maml:description> <maml:para>Enables or disables performance service on a vSAN cluster.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowReducedRedundancy</maml:name> <maml:description> <maml:para>Allows reduced redundancy state. This optional parameter is applicable to specific vSAN cluster reconfigure operations that need to migrate data across cluster for changing vSAN disk format. When specified, it might make the process move lesser data in order to ensure storage object accessibility, and some objects will be kept at reduced redundancy state, which means at a higher risk in case of a hardware failure during the migration process. This is applicable to the SpaceEfficiencyEnabled parameter only. The default value is False.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="named"> <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies the storage policy. This parameter is applicable in the context of enabling the VirtualSAN performance service. The vSAN performance history database is stored as a vSAN object. The policy controls the availability, space consumption and performance of that object. If the object becomes unavailable, the performance history for that cluster will also be unavailable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SpbmStoragePolicy</command:parameterValue> <dev:type> <maml:name>SpbmStoragePolicy</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StretchedClusterEnabled</maml:name> <maml:description> <maml:para>Enables or disables stretched cluster configuration.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="named"> <maml:name>PreferredFaultDomain</maml:name> <maml:description> <maml:para>Specifies the preferred fault domain. If stretched cluster configuration is enabled, this becomes the preferred fault domain for this cluster. The other fault domain in this stretched cluster becomes the secondary fault domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VsanFaultDomain</command:parameterValue> <dev:type> <maml:name>VsanFaultDomain</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="named"> <maml:name>WitnessHost</maml:name> <maml:description> <maml:para>Specifies the witness host virtual machine in case StretchedClusterEnabled is enabled. It can also be a vSphere virtual appliance called witness appliance. Requirements for witness host: - Must not be part of any vSAN-enabled cluster. - Must have at least one VMkernel adapter with vSAN traffic enabled. - That adapter must be connected to all hosts in the stretched cluster. In vSAN versions earlier than 6.6, this parameter is only applicable when enabling stretched cluster. If StretchedClusterEnabled is not specified or is false, then this parameter is ignored. In vSAN 6.7 or later, this parameter can be specified to update the witness host in a stretched cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VMHost</command:parameterValue> <dev:type> <maml:name>VMHost</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WitnessHostCacheDisk</maml:name> <maml:description> <maml:para>Specifies cache disk canonical name for the disk group to be created on the witness host. Also accepts ScsiLun or VMHostDisk objects through argument transformation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WitnessHostCapacityDisk</maml:name> <maml:description> <maml:para>Specifies the capacity disk canonical names for the disk group to be created on the witness host. Also accepts ScsiLun or VMHostDisk objects through argument transformation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IscsiTargetServiceEnabled</maml:name> <maml:description> <maml:para>Enables or disables the iSCSI target service on a vSAN cluster.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultIscsiNetworkInterface</maml:name> <maml:description> <maml:para>Specifies the default VMkernel network interface which handles the iSCSI traffic. Can be overridden per target. Mandatory if IscsiTargetServiceEnabled is specified as $true. This parameter accepts an object of type HostVMKernelVirtualNic by silently converting it to the string name by using ArgumentTransformationAttribute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultIscsiTcpPort</maml:name> <maml:description> <maml:para>Specifies the default network port for iSCSI targets. Can be overridden per target. If not provided, the default port 3260 is used. The server automatically opens the firewall for the specified port.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultIscsiTargetAuthenticationType</maml:name> <maml:description> <maml:para>Specifies the default authentication type for vSAN iSCSI targets in this cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VsanIscsiTargetAuthenticationType</command:parameterValue> <dev:type> <maml:name>VsanIscsiTargetAuthenticationType</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultIncomingChapUser</maml:name> <maml:description> <maml:para>Specifies the default CHAP user name for iSCSI targets on this cluster. Applicable when the authentication type is Chap or MutualChap.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultIncomingChapSecret</maml:name> <maml:description> <maml:para>Specifies the default CHAP secret for iSCSI targets on this cluster. Applicable when the authentication type is Chap or MutualChap.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultOutgoingChapUser</maml:name> <maml:description> <maml:para>Specifies the default CHAP user name you want to attach to the initiator. Applicable when the authentication type is MutualChap.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultOutgoingChapSecret</maml:name> <maml:description> <maml:para>Specifies the default CHAP user secret you want to attach to the initiator. Applicable when the authentication type is MutualChap.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StoragePolicyForIscsiTargetService</maml:name> <maml:description> <maml:para>Specifies the storage policy for the iSCSI target service. When you enable the iSCSI target service, vSAN creates a home object that stores metadata for the iSCSI target service. The storage policy for the home object should have a number of failures to tolerate of 1 or more.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SpbmStoragePolicy</command:parameterValue> <dev:type> <maml:name>SpbmStoragePolicy</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AddSilentHealthCheck</maml:name> <maml:description> <maml:para>Specifies the health checks list you want to add to the silent list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveSilentHealthCheck</maml:name> <maml:description> <maml:para>Specifies the health checks list you want to remove from the silent list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResyncThrottlingMbps</maml:name> <maml:description> <maml:para>Specifies the resynchronization traffic limit in Mbps for each disk group in the cluster. The valid values are from 1 to 512. If the value of the parameter is zero, throttling resynchronization traffic limits are disabled.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The list of modified vSAN configuration objects for the cluster of type VsanClusterConfiguration</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-VsanClusterConfiguration -Configuration (Get-VsanClusterConfiguration $cluster) -SpaceEfficiencyEnabled $true -HealthCheckIntervalMinutes 120</dev:code> <dev:remarks> <maml:para>Enables the space efficiency on the $cluster cluster and sets the periodic health check interval to 120 minutes.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-VsanClusterConfiguration -Configuration "MyCluster" -StretchedClusterEnabled $true -PreferredFaultDomain $fd -WitnessHost $vmHost</dev:code> <dev:remarks> <maml:para>Enables stretched cluster on the "MyCluster" cluster and specifies $fd as the primary fault domain and $vmHost as the witness host.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-VsanClusterConfiguration -Configuration "MyCluster" -PerformanceServiceEnabled $true -StoragePolicy $policy</dev:code> <dev:remarks> <maml:para>Enables performance service on the "MyCluster" cluster and associates the performance history database object with the $policy storage policy.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 4 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-VsanClusterConfiguration -Configuration (Get-VsanClusterConfiguration $cluster) -HealthCheckIntervalMinutes 0</dev:code> <dev:remarks> <maml:para>Disables periodic health checks on the $cluster cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Set-VsanClusterConfiguration.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsanClusterConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Set-VsanFaultDomain</command:name> <maml:description> <maml:para>This cmdlet changes the configuration of a specified vSAN fault domain.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Set</command:verb> <command:noun>VsanFaultDomain</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet changes the configuration of a specified vSAN fault domain. You can change the name and specify a list of hosts to move in or out.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VsanFaultDomain</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>VsanFaultDomain</maml:name> <maml:description> <maml:para>Specifies the list of vSAN fault domains you want to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VsanFaultDomain[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>AddVMHost</maml:name> <maml:description> <maml:para>Specifies the list of virtual machine hosts you want to move into this vSAN fault domain. Virtual machine hosts should be part of the cluster in which this fault domain exists.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VMHost[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>RemoveVMHost</maml:name> <maml:description> <maml:para>Specifies the list of virtual machine hosts you want to move out of this vSAN fault domain. Virtual machine hosts should be part of this fault domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VMHost[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the new name of the vSAN fault domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>VsanFaultDomain</maml:name> <maml:description> <maml:para>Specifies the list of vSAN fault domains you want to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VsanFaultDomain[]</command:parameterValue> <dev:type> <maml:name>VsanFaultDomain[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>AddVMHost</maml:name> <maml:description> <maml:para>Specifies the list of virtual machine hosts you want to move into this vSAN fault domain. Virtual machine hosts should be part of the cluster in which this fault domain exists.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VMHost[]</command:parameterValue> <dev:type> <maml:name>VMHost[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>RemoveVMHost</maml:name> <maml:description> <maml:para>Specifies the list of virtual machine hosts you want to move out of this vSAN fault domain. Virtual machine hosts should be part of this fault domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VMHost[]</command:parameterValue> <dev:type> <maml:name>VMHost[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the new name of the vSAN fault domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The list of updated VsanFaultDomain objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-VsanFaultDomain -VsanFaultDomain $fd -Name "NewName" -AddVMHost $vmHost1, $vmHost2 -RemoveVMHost $vmHost3</dev:code> <dev:remarks> <maml:para>Renames the $fd vSAN fault domain to "NewName" and adds the $vmHost1 and $vmHost2 virtual machine hosts to it. Also, removes the $vmHost3 virtual machine host from the renamed vSAN fault domain.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Set-VsanFaultDomain.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsanFaultDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VsanFaultDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VsanFaultDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Set-VsanIscsiInitiatorGroup</command:name> <maml:description> <maml:para>This cmdlet modifies the specified vSAN iSCSI initiator groups.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Set</command:verb> <command:noun>VsanIscsiInitiatorGroup</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet modifies the specified vSAN iSCSI initiator groups.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VsanIscsiInitiatorGroup</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>InitiatorGroup</maml:name> <maml:description> <maml:para>Specifies the vSAN iSCSI initiator group to which you want to add or remove initiators.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VsanIscsiInitiatorGroup[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AddInitiator</maml:name> <maml:description> <maml:para>Specifies the names of the vSAN iSCSI initiators which you want to add to the initiator group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RemoveInitiator</maml:name> <maml:description> <maml:para>Specifies the names of the vSAN iSCSI initiators which you want to remove from the initiator group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>InitiatorGroup</maml:name> <maml:description> <maml:para>Specifies the vSAN iSCSI initiator group to which you want to add or remove initiators.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VsanIscsiInitiatorGroup[]</command:parameterValue> <dev:type> <maml:name>VsanIscsiInitiatorGroup[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AddInitiator</maml:name> <maml:description> <maml:para>Specifies the names of the vSAN iSCSI initiators which you want to add to the initiator group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveInitiator</maml:name> <maml:description> <maml:para>Specifies the names of the vSAN iSCSI initiators which you want to remove from the initiator group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The list of modified VsanIscsiInitiatorGroup objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-VsanIscsiInitiatorGroup -InitiatorGroup $initiatorGroup -AddInitiator "initiator1-iqn", "initiator2-iqn" -RemoveInitiator "initiator3-iqn"</dev:code> <dev:remarks> <maml:para>Adds iSCSI initiators with IQN "initiator1-iqn" and "initiator2-iqn" to the $initiatorGroup initiator group and removes iSCSI initiator with IQN "initiator3-iqn" from the initiator group.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Set-VsanIscsiInitiatorGroup.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsanIscsiInitiatorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VsanIscsiInitiatorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VsanIscsiInitiatorGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Set-VsanIscsiLun</command:name> <maml:description> <maml:para>This cmdlet modifies the specified vSAN iSCSI LUNs.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Set</command:verb> <command:noun>VsanIscsiLun</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet modifies the specified vSAN iSCSI LUNs.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VsanIscsiLun</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Lun</maml:name> <maml:description> <maml:para>Specifies the vSAN iSCSI LUNs you want to modify.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VsanIscsiLun[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the new name of the vSAN iSCSI LUN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>IsOnline</maml:name> <maml:description> <maml:para>Puts the iSCSI LUN in offline or online state.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CapacityGB</maml:name> <maml:description> <maml:para>Specifies the new capacity of the vSAN iSCSI LUN in gigabytes (GB). The LUN size can only increase. This operation is possible only when the LUN is in offline state.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Decimal</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>LunId</maml:name> <maml:description> <maml:para>Specifies the new LUN ID of the iSCSI LUN. The value must be in the range from 0 to 255. The LUN ID can be changed only when the LUN is in offline state.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies the storage policy associated with the vSAN iSCSI LUN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >SpbmStoragePolicy</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Lun</maml:name> <maml:description> <maml:para>Specifies the vSAN iSCSI LUNs you want to modify.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VsanIscsiLun[]</command:parameterValue> <dev:type> <maml:name>VsanIscsiLun[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the new name of the vSAN iSCSI LUN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsOnline</maml:name> <maml:description> <maml:para>Puts the iSCSI LUN in offline or online state.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CapacityGB</maml:name> <maml:description> <maml:para>Specifies the new capacity of the vSAN iSCSI LUN in gigabytes (GB). The LUN size can only increase. This operation is possible only when the LUN is in offline state.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Decimal</command:parameterValue> <dev:type> <maml:name>Decimal</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LunId</maml:name> <maml:description> <maml:para>Specifies the new LUN ID of the iSCSI LUN. The value must be in the range from 0 to 255. The LUN ID can be changed only when the LUN is in offline state.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="named"> <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies the storage policy associated with the vSAN iSCSI LUN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SpbmStoragePolicy</command:parameterValue> <dev:type> <maml:name>SpbmStoragePolicy</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The list of modified VsanIscsiLun objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-VsanIscsiLun -Lun $lun -CapacityGB 3</dev:code> <dev:remarks> <maml:para>Increases the capacity of the $lun iSCSI LUN to 3 GB.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-VsanIscsiLun -Lun $lun -IsOnline $false</dev:code> <dev:remarks> <maml:para>Puts the $lun iSCSI LUN in offline state.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Set-VsanIscsiLun.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsanIscsiLun</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VsanIscsiLun</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VsanIscsiLun</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Set-VsanIscsiTarget</command:name> <maml:description> <maml:para>This cmdlet modifies the settings of the specified vSAN iSCSI targets.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Set</command:verb> <command:noun>VsanIscsiTarget</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet modifies the settings of the specified vSAN iSCSI targets. The cmdlet first adds and then removes the initiators if specified. After those operations are completed, other reconfigurations can occur.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VsanIscsiTarget</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the list of vSAN iSCSI targets you want to modify.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VsanIscsiTarget[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the new name of the vSAN iSCSI target. The name should be unique within a cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>NetworkInterface</maml:name> <maml:description> <maml:para>Specifies the VMkernel network interface which handles the iSCSI traffic. This parameter accepts an object of type HostVMKernelVirtualNic by silently converting it to the string name by using ArgumentTransformationAttribute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>TcpPort</maml:name> <maml:description> <maml:para>Specifies the network port on which the target is accessible. If specified, NetworkInterface should also be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AuthenticationType</maml:name> <maml:description> <maml:para>Specifies the authentication type for the iSCSI target.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VsanIscsiTargetAuthenticationType</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>IncomingChapUser</maml:name> <maml:description> <maml:para>Specifies the CHAP user name for the target. Applicable when the authentication type is Chap or MutualChap.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>IncomingChapSecret</maml:name> <maml:description> <maml:para>Specifies the CHAP user secret for the target. Applicable when the authentication type is Chap or MutualChap.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >SecureString</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>OutgoingChapUser</maml:name> <maml:description> <maml:para>Specifies the CHAP user name you want to attach to the initiator. Applicable when the authentication type is MutualChap.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>OutgoingChapSecret</maml:name> <maml:description> <maml:para>Specifies the CHAP user secret you want to attach to the initiator. Applicable when the authentication type is MutualChap.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >SecureString</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies the storage policy applied to the vSAN namespace of the iSCSI target.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >SpbmStoragePolicy</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AddInitiator</maml:name> <maml:description> <maml:para>Specifies the names of the vSAN iSCSI initiators which you want to add to the allowed access list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RemoveInitiator</maml:name> <maml:description> <maml:para>Specifies the names of the vSAN iSCSI initiators which you want to remove from the allowed access list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the list of vSAN iSCSI targets you want to modify.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VsanIscsiTarget[]</command:parameterValue> <dev:type> <maml:name>VsanIscsiTarget[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the new name of the vSAN iSCSI target. The name should be unique within a cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkInterface</maml:name> <maml:description> <maml:para>Specifies the VMkernel network interface which handles the iSCSI traffic. This parameter accepts an object of type HostVMKernelVirtualNic by silently converting it to the string name by using ArgumentTransformationAttribute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TcpPort</maml:name> <maml:description> <maml:para>Specifies the network port on which the target is accessible. If specified, NetworkInterface should also be specified.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthenticationType</maml:name> <maml:description> <maml:para>Specifies the authentication type for the iSCSI target.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VsanIscsiTargetAuthenticationType</command:parameterValue> <dev:type> <maml:name>VsanIscsiTargetAuthenticationType</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncomingChapUser</maml:name> <maml:description> <maml:para>Specifies the CHAP user name for the target. Applicable when the authentication type is Chap or MutualChap.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncomingChapSecret</maml:name> <maml:description> <maml:para>Specifies the CHAP user secret for the target. Applicable when the authentication type is Chap or MutualChap.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutgoingChapUser</maml:name> <maml:description> <maml:para>Specifies the CHAP user name you want to attach to the initiator. Applicable when the authentication type is MutualChap.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutgoingChapSecret</maml:name> <maml:description> <maml:para>Specifies the CHAP user secret you want to attach to the initiator. Applicable when the authentication type is MutualChap.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="named"> <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies the storage policy applied to the vSAN namespace of the iSCSI target.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SpbmStoragePolicy</command:parameterValue> <dev:type> <maml:name>SpbmStoragePolicy</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AddInitiator</maml:name> <maml:description> <maml:para>Specifies the names of the vSAN iSCSI initiators which you want to add to the allowed access list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveInitiator</maml:name> <maml:description> <maml:para>Specifies the names of the vSAN iSCSI initiators which you want to remove from the allowed access list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The modified VsanIscsiTarget objects</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Set-VsanIscsiTarget -Target $target -Name "NewName" -AddInitiator "initiator1-iqn", "initiator2-iqn" -RemoveInitiator "initiator3-iqn"</dev:code> <dev:remarks> <maml:para>Renames the $target vSAN iSCSI target to "NewName" and adds iSCSI initiators with IQN "initiator1-iqn" and "initiator2-iqn" to iSCSI target. The command removes iSCSI initiator with IQN "initiator3-iqn" from the iSCSI target.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Set-VsanIscsiTarget.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsanIscsiTarget</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-VsanIscsiTarget</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VsanIscsiTarget</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Start-SpbmReplicationFailover</command:name> <maml:description> <maml:para>This cmdlet performs a failover of the devices in the specified replication groups.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Start</command:verb> <command:noun>SpbmReplicationFailover</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet performs a failover of the devices in the specified replication groups. This cmdlet should be called at the replication target location. After the operation succeeds, the devices will be ready to be registered by using the virtual machine file path.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-SpbmReplicationFailover</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>ReplicationGroup</maml:name> <maml:description> <maml:para>Specifies the target replication groups to failover at.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SpbmReplicationGroup[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CheckOnly</maml:name> <maml:description> <maml:para>Does not perform the failover, but checks if the configuration is correct to perform the failover.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Unplanned</maml:name> <maml:description> <maml:para>Specifies an unplanned failover.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>SourceVvolIdMap</maml:name> <maml:description> <maml:para>If this is a planned failover, this parameter is mandatory. This will contain a map of sourceVvolId (of the devices) to containerId (of the VVol datastore) for all the devices in the specified replication groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Hashtable</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PointInTimeReplica</maml:name> <maml:description> <maml:para>Specifies the point in time replica object you want to use for the corresponding replication group failover. If no replica is specified for a replication group, the latest available replica is used by default by the VASA provider. If more than one replica is specified for a replication group, a non-terminating error is generated for that replication group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SpbmPointInTimeReplica[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VIServer</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>ReplicationGroup</maml:name> <maml:description> <maml:para>Specifies the target replication groups to failover at.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SpbmReplicationGroup[]</command:parameterValue> <dev:type> <maml:name>SpbmReplicationGroup[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CheckOnly</maml:name> <maml:description> <maml:para>Does not perform the failover, but checks if the configuration is correct to perform the failover.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Unplanned</maml:name> <maml:description> <maml:para>Specifies an unplanned failover.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceVvolIdMap</maml:name> <maml:description> <maml:para>If this is a planned failover, this parameter is mandatory. This will contain a map of sourceVvolId (of the devices) to containerId (of the VVol datastore) for all the devices in the specified replication groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PointInTimeReplica</maml:name> <maml:description> <maml:para>Specifies the point in time replica object you want to use for the corresponding replication group failover. If no replica is specified for a replication group, the latest available replica is used by default by the VASA provider. If more than one replica is specified for a replication group, a non-terminating error is generated for that replication group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SpbmPointInTimeReplica[]</command:parameterValue> <dev:type> <maml:name>SpbmPointInTimeReplica[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VIServer</command:parameterValue> <dev:type> <maml:name>VIServer</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VM file paths corresponding to recovered devices. One VM file path for a VM and all its disks together.</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Start-SpbmReplicationFailover -ReplicationGroup $targetRg -CheckOnly</dev:code> <dev:remarks> <maml:para>Checks whether the target replication group has the correct configuration to perform the failover.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Start-SpbmReplicationFailover -ReplicationGroup $targetRg -Unplanned</dev:code> <dev:remarks> <maml:para>Performs an unplanned failover on the $targetRg target replication group.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Start-SpbmReplicationFailover.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Start-SpbmReplicationPrepareFailover</command:name> <maml:description> <maml:para>This cmdlet prepares the specified replication groups to fail over.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Start</command:verb> <command:noun>SpbmReplicationPrepareFailover</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet prepares the specified replication groups to fail over.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-SpbmReplicationPrepareFailover</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>ReplicationGroup</maml:name> <maml:description> <maml:para>Specifies the replication group you want to prepare for failover. The replication group should be a source replication group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SpbmReplicationGroup[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>ReplicationGroup</maml:name> <maml:description> <maml:para>Specifies the replication group you want to prepare for failover. The replication group should be a source replication group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SpbmReplicationGroup[]</command:parameterValue> <dev:type> <maml:name>SpbmReplicationGroup[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Start-SpbmReplicationPrepareFailover -ReplicationGroup $sourceRg</dev:code> <dev:remarks> <maml:para>Performs the preparation of a planned failover on the $sourceRg source replication group.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Start-SpbmReplicationPrepareFailover.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Start-SpbmReplicationPromote</command:name> <maml:description> <maml:para>This cmdlet promotes a target replication group from InTest to FailedOver state.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Start</command:verb> <command:noun>SpbmReplicationPromote</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet promotes a target replication group from InTest to FailedOver state.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-SpbmReplicationPromote</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>ReplicationGroup</maml:name> <maml:description> <maml:para>Specifies the replication groups to promote to FailedOver state.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SpbmReplicationGroup[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Unplanned</maml:name> <maml:description> <maml:para>Indicates if the promote operation is unplanned or planned.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>ReplicationGroup</maml:name> <maml:description> <maml:para>Specifies the replication groups to promote to FailedOver state.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SpbmReplicationGroup[]</command:parameterValue> <dev:type> <maml:name>SpbmReplicationGroup[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Unplanned</maml:name> <maml:description> <maml:para>Indicates if the promote operation is unplanned or planned.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The failed over replication groups</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Start-SpbmReplicationPromote -ReplicationGroup $targetRg</dev:code> <dev:remarks> <maml:para>Promotes the $targetRg target replication group from InTest state to FailedOver.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Start-SpbmReplicationPromote.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Start-SpbmReplicationReverse</command:name> <maml:description> <maml:para>This cmdlet initiates reverse replication, by making the currently failed over replication group the source and its peer replication group the target.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Start</command:verb> <command:noun>SpbmReplicationReverse</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet initiates reverse replication, by making the currently failed over replication group the source and its peer replication group the target. The devices in the replication group will start getting replicated to this new target site, which was the source before the failover.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-SpbmReplicationReverse</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>ReplicationGroup</maml:name> <maml:description> <maml:para>Specifies the replication groups which are in failed over state and are to be converted to source group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SpbmReplicationGroup[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>ReplicationGroup</maml:name> <maml:description> <maml:para>Specifies the replication groups which are in failed over state and are to be converted to source group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SpbmReplicationGroup[]</command:parameterValue> <dev:type> <maml:name>SpbmReplicationGroup[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The new replication group objects after being made a source replication group</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Start-SpbmReplicationReverse -ReplicationGroup $targetRg</dev:code> <dev:remarks> <maml:para>Reverses the direction of replication for $targetRg target replication group. The $targetRg replication group becomes the source replication group and the corresponding source replication group becomes the target replication group.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Start-SpbmReplicationReverse.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Start-SpbmReplicationTestFailover</command:name> <maml:description> <maml:para>This cmdlet performs a test failover of a target replication group.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Start</command:verb> <command:noun>SpbmReplicationTestFailover</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet performs a test failover of a target replication group. If the operation succeeds, the replication state of the replication group becomes InTest.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-SpbmReplicationTestFailover</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>ReplicationGroup</maml:name> <maml:description> <maml:para>Specifies the replication group on which you want to perform the test failover.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SpbmReplicationGroup[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CheckOnly</maml:name> <maml:description> <maml:para>Does not perform the test failover, but checks if the configuration is correct to perform the test failover.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Unplanned</maml:name> <maml:description> <maml:para>Specifies an unplanned test failover.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>SourceVvolIdMap</maml:name> <maml:description> <maml:para>If this is a planned test failover, this parameter is mandatory. This will contain a map of sourceVvolId (of the devices) to containerId (of the VVol datastore) for all the devices in the specified replication groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Hashtable</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PointInTimeReplica</maml:name> <maml:description> <maml:para>Specifies the point in time replica object you want to use for the corresponding replication group test failover. If no replica is specified for a replication group, the latest available replica is used by default by the VASA provider. If more than one replica is specified for a replication group, a non-terminating error is generated for that replication group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SpbmPointInTimeReplica[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VIServer</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>ReplicationGroup</maml:name> <maml:description> <maml:para>Specifies the replication group on which you want to perform the test failover.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SpbmReplicationGroup[]</command:parameterValue> <dev:type> <maml:name>SpbmReplicationGroup[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CheckOnly</maml:name> <maml:description> <maml:para>Does not perform the test failover, but checks if the configuration is correct to perform the test failover.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Unplanned</maml:name> <maml:description> <maml:para>Specifies an unplanned test failover.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceVvolIdMap</maml:name> <maml:description> <maml:para>If this is a planned test failover, this parameter is mandatory. This will contain a map of sourceVvolId (of the devices) to containerId (of the VVol datastore) for all the devices in the specified replication groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PointInTimeReplica</maml:name> <maml:description> <maml:para>Specifies the point in time replica object you want to use for the corresponding replication group test failover. If no replica is specified for a replication group, the latest available replica is used by default by the VASA provider. If more than one replica is specified for a replication group, a non-terminating error is generated for that replication group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SpbmPointInTimeReplica[]</command:parameterValue> <dev:type> <maml:name>SpbmPointInTimeReplica[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VIServer</command:parameterValue> <dev:type> <maml:name>VIServer</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VM file paths corresponding to recovered devices. One VM file path for a VM and all its disks together.</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Start-SpbmReplicationTestFailover -ReplicationGroup $targetRg -CheckOnly</dev:code> <dev:remarks> <maml:para>Checks if the target replication group has the correct configuration to perform a test failover.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Start-SpbmReplicationTestFailover -ReplicationGroup $targetRg -Unplanned -PointInTimeReplica $replica</dev:code> <dev:remarks> <maml:para>Performs a test failover of an unplanned type on the $targetRg target replication group by using the $replica point in time replica.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Start-SpbmReplicationTestFailover.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-SpbmReplicationTestFailover</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Start-VsanClusterDiskUpdate</command:name> <maml:description> <maml:para>This cmdlet starts the update of all vSAN disks of a cluster to the latest vSAN disk format version supported by the cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Start</command:verb> <command:noun>VsanClusterDiskUpdate</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet starts the update of all vSAN disks of a cluster to the latest vSAN disk format version supported by the cluster. After the update finishes successfully, all vSAN disks in the cluster use the latest disk format version supported by the cluster. The cmdlet returns a task object that you can wait upon and query for progress.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-VsanClusterDiskUpdate</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the cluster for which you want to update all vSAN disks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Cluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AllowReducedRedundancy</maml:name> <maml:description> <maml:para>This optional parameter is applicable to specific vSAN cluster reconfigure operations that need to migrate data for changing the vSAN disk format across the cluster. When specified, the process might move less data to ensure storage object accessibility, and some objects might be kept at "reduced redundancy" state, which means at a higher risk in case of a hardware failure during the migration process. The default value is $false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>SpaceEfficiencyEnabled</maml:name> <maml:description> <maml:para>Specifies whether to enable or disable vSAN data efficiency from the disk format layer. This parameter is only applicable to all-flash clusters. The encryption configuration of the cluster does not change when you set this parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>EncryptionEnabled</maml:name> <maml:description> <maml:para>Specifies that you want to use encryption to format the disks in the cluster. The encryption configuration of the cluster does not change when you set this parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>EraseDisksBeforeUse</maml:name> <maml:description> <maml:para>Specifies whether disks should be formatted when a normal disk is converted to an encrypted disk. The encryption configuration of the cluster does not change when you set this parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>KmsCluster</maml:name> <maml:description> <maml:para>Specifies the key provider you want to use to format disks in the cluster. The encryption configuration of the cluster does not change when you set this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >KmsCluster</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>SkipHostRemediation</maml:name> <maml:description> <maml:para>Indicates that host configuration remediation is skipped as part of the disk format conversion. By default, remediation runs to ensure hosts are consistent. If hosts are inconsistent, the disk format conversion prevents errors. If all hosts are already consistent and have the latest configuration, you can set the value to $true.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the cluster for which you want to update all vSAN disks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Cluster[]</command:parameterValue> <dev:type> <maml:name>Cluster[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowReducedRedundancy</maml:name> <maml:description> <maml:para>This optional parameter is applicable to specific vSAN cluster reconfigure operations that need to migrate data for changing the vSAN disk format across the cluster. When specified, the process might move less data to ensure storage object accessibility, and some objects might be kept at "reduced redundancy" state, which means at a higher risk in case of a hardware failure during the migration process. The default value is $false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SpaceEfficiencyEnabled</maml:name> <maml:description> <maml:para>Specifies whether to enable or disable vSAN data efficiency from the disk format layer. This parameter is only applicable to all-flash clusters. The encryption configuration of the cluster does not change when you set this parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EncryptionEnabled</maml:name> <maml:description> <maml:para>Specifies that you want to use encryption to format the disks in the cluster. The encryption configuration of the cluster does not change when you set this parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EraseDisksBeforeUse</maml:name> <maml:description> <maml:para>Specifies whether disks should be formatted when a normal disk is converted to an encrypted disk. The encryption configuration of the cluster does not change when you set this parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KmsCluster</maml:name> <maml:description> <maml:para>Specifies the key provider you want to use to format disks in the cluster. The encryption configuration of the cluster does not change when you set this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">KmsCluster</command:parameterValue> <dev:type> <maml:name>KmsCluster</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SkipHostRemediation</maml:name> <maml:description> <maml:para>Indicates that host configuration remediation is skipped as part of the disk format conversion. By default, remediation runs to ensure hosts are consistent. If hosts are inconsistent, the disk format conversion prevents errors. If all hosts are already consistent and have the latest configuration, you can set the value to $true.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The task objects to track the operations in the cluster</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Start-VsanClusterDiskUpdate -Cluster "vsan-cluster"</dev:code> <dev:remarks> <maml:para>Updates the disk format of all vSAN disks in the "vsan-cluster" cluster to the latest disk format version supported by that cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Start-VsanClusterDiskUpdate.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Start-VsanClusterRebalance</command:name> <maml:description> <maml:para>This cmdlet starts the proactive rebalance of the vSAN objects on the cluster hosts based on the vSAN disks usage when the disks are in imbalanced state.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Start</command:verb> <command:noun>VsanClusterRebalance</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet starts the proactive rebalance of the vSAN objects on the cluster hosts based on the vSAN disks usage when the disks are in imbalanced state. The typical use case is to add a new host or disk to the vSAN cluster. Rebalancing increases the background I/O requirements for data movements.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-VsanClusterRebalance</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the vSAN cluster on which you want to start the proactive rebalance of the vSAN objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Cluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the vSAN cluster on which you want to start the proactive rebalance of the vSAN objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Cluster[]</command:parameterValue> <dev:type> <maml:name>Cluster[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The task object to track the proactive rebalance operation</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Start-VsanClusterRebalance -Cluster $vsanCluster</dev:code> <dev:remarks> <maml:para>Starts the proactive rebalance of the $vsanCluster vSAN cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Start-VsanClusterRebalance.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stop-VsanClusterRebalance</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Start-VsanEncryptionConfiguration</command:name> <maml:description> <maml:para>This cmdlet starts encryption configuration on a vSAN cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Start</command:verb> <command:noun>VsanEncryptionConfiguration</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet starts encryption configuration on a vSAN cluster. The encryption configuration includes the following actions: - Enable or disable encryption - Change key provider - Perform deep rekey - Perform shallow rekey</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-VsanEncryptionConfiguration</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the vSAN cluster on which you want to start encryption configuration of the vSAN objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Cluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>EncryptionEnabled</maml:name> <maml:description> <maml:para>Specifies whether you want to enable or disable encryption.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>EraseDisksBeforeUse</maml:name> <maml:description> <maml:para>Specifies whether the disk should be formatted when a normal disk is converted to an encrypted disk, it is claimed as encrypted disk, or it runs deep rekey. If the value of this parameter is $true, every sector on the disk is written with random data. Disk cleanup reduces the possibility of data leak and increases the potential intruder's cost to reveal sensitive data. Turn the disk cleanup on only when necessary, as it takes long time to finish. If the value of this parameter is $false, the disk will not be formatted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>KmsCluster</maml:name> <maml:description> <maml:para>Specifies the key provider you want to use for encryption.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >KmsCluster</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AllowReducedRedundancy</maml:name> <maml:description> <maml:para>This optional parameter is applicable to specific vSAN cluster reconfigure operations that need to migrate data for changing the vSAN disk format across the cluster. When specified, the process might move less data to ensure storage object accessibility, and some objects might be kept at "reduced redundancy" state, which means at a higher risk in case of a hardware failure during the migration process. The default value is $false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-VsanEncryptionConfiguration</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the vSAN cluster on which you want to start encryption configuration of the vSAN objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Cluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>ShallowRekey</maml:name> <maml:description> <maml:para>Specifies that you want to perform a shallow rekey operation. When a shallow rekey operation is running, only the key encryption key (KEK) is changed and the data encryption keys (DEKs) are re-wrapped with new key encryption keys.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AllowReducedRedundancy</maml:name> <maml:description> <maml:para>This optional parameter is applicable to specific vSAN cluster reconfigure operations that need to migrate data for changing the vSAN disk format across the cluster. When specified, the process might move less data to ensure storage object accessibility, and some objects might be kept at "reduced redundancy" state, which means at a higher risk in case of a hardware failure during the migration process. The default value is $false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-VsanEncryptionConfiguration</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the vSAN cluster on which you want to start encryption configuration of the vSAN objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Cluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DeepRekey</maml:name> <maml:description> <maml:para>Specifies that you want to perform a deep rekey operation. When a deep rekey operation is running, all disks are re-encrypted with new data encryption keys. The deep rekey operation takes long time to finish.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AllowReducedRedundancy</maml:name> <maml:description> <maml:para>This optional parameter is applicable to specific vSAN cluster reconfigure operations that need to migrate data for changing the vSAN disk format across the cluster. When specified, the process might move less data to ensure storage object accessibility, and some objects might be kept at "reduced redundancy" state, which means at a higher risk in case of a hardware failure during the migration process. The default value is $false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the vSAN cluster on which you want to start encryption configuration of the vSAN objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Cluster[]</command:parameterValue> <dev:type> <maml:name>Cluster[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EncryptionEnabled</maml:name> <maml:description> <maml:para>Specifies whether you want to enable or disable encryption.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EraseDisksBeforeUse</maml:name> <maml:description> <maml:para>Specifies whether the disk should be formatted when a normal disk is converted to an encrypted disk, it is claimed as encrypted disk, or it runs deep rekey. If the value of this parameter is $true, every sector on the disk is written with random data. Disk cleanup reduces the possibility of data leak and increases the potential intruder's cost to reveal sensitive data. Turn the disk cleanup on only when necessary, as it takes long time to finish. If the value of this parameter is $false, the disk will not be formatted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="named"> <maml:name>KmsCluster</maml:name> <maml:description> <maml:para>Specifies the key provider you want to use for encryption.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">KmsCluster</command:parameterValue> <dev:type> <maml:name>KmsCluster</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowReducedRedundancy</maml:name> <maml:description> <maml:para>This optional parameter is applicable to specific vSAN cluster reconfigure operations that need to migrate data for changing the vSAN disk format across the cluster. When specified, the process might move less data to ensure storage object accessibility, and some objects might be kept at "reduced redundancy" state, which means at a higher risk in case of a hardware failure during the migration process. The default value is $false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="named"> <maml:name>ShallowRekey</maml:name> <maml:description> <maml:para>Specifies that you want to perform a shallow rekey operation. When a shallow rekey operation is running, only the key encryption key (KEK) is changed and the data encryption keys (DEKs) are re-wrapped with new key encryption keys.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeepRekey</maml:name> <maml:description> <maml:para>Specifies that you want to perform a deep rekey operation. When a deep rekey operation is running, all disks are re-encrypted with new data encryption keys. The deep rekey operation takes long time to finish.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The task object to track the operations on clusters</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Start-VsanEncryptionConfiguration -Cluster $vsanCluster -EncryptionEnabled $true -KmsCluster 'ThalesCluster'</dev:code> <dev:remarks> <maml:para>Enables encryption on the $vsanCluster vSAN cluster with 'ThalesCluster' as the key provider.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Start-VsanEncryptionConfiguration -Cluster $vsanCluster -EncryptionEnabled $false</dev:code> <dev:remarks> <maml:para>Disables encryption on the $vsanCluster vSAN cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Start-VsanEncryptionConfiguration -Cluster $vsanCluster -DeepRekey</dev:code> <dev:remarks> <maml:para>Performs a deep rekey operation on all disks of the $vsanCluster vSAN cluster. All data on the disks is re-encrypted.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 4 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Start-VsanEncryptionConfiguration -Cluster $vsanCluster -ShallowRekey</dev:code> <dev:remarks> <maml:para>Performs a shallow rekey operation on all disks of the $vsanCluster vSAN cluster. All data encryption keys are re-wrapped with new key encryption key. Data on the disks is not re-encrypted.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Start-VsanEncryptionConfiguration.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Stop-SpbmReplicationTestFailover</command:name> <maml:description> <maml:para>This cmdlet stops the test failover on the specified replication groups and tries to perform a cleanup on the target site.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>SpbmReplicationTestFailover</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet stops the test failover on the specified replication groups and tries to perform a cleanup on the target site. After successful completion the replication group state returns to Target.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-SpbmReplicationTestFailover</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>ReplicationGroup</maml:name> <maml:description> <maml:para>Specifies the replication groups on which you want to stop the test failover.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SpbmReplicationGroup[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Force</maml:name> <maml:description> <maml:para>If specified, VASA Provider should force-unbind all Virtual Volumes and move the replication group from InTest to Target state. If not specified, VP reports all the Virtual Volumes that need to be cleaned up before a failover operation can be initiated.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>ReplicationGroup</maml:name> <maml:description> <maml:para>Specifies the replication groups on which you want to stop the test failover.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SpbmReplicationGroup[]</command:parameterValue> <dev:type> <maml:name>SpbmReplicationGroup[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If specified, VASA Provider should force-unbind all Virtual Volumes and move the replication group from InTest to Target state. If not specified, VP reports all the Virtual Volumes that need to be cleaned up before a failover operation can be initiated.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The successfully updated replication groups with Target state</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Stop-SpbmReplicationTestFailover -ReplicationGroup $targetRg</dev:code> <dev:remarks> <maml:para>Performs the cleanup of a test failover done on the $targetRg target replication group.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Stop-SpbmReplicationTestFailover.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-SpbmReplicationTestFailover</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Stop-VsanClusterRebalance</command:name> <maml:description> <maml:para>This cmdlet stops the proactive rebalance of the vSAN objects on the cluster hosts.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>VsanClusterRebalance</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet stops the proactive rebalance of the vSAN objects on the cluster hosts.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-VsanClusterRebalance</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the vSAN cluster on which you want to stop the proactive rebalance of the vSAN objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Cluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the vSAN cluster on which you want to stop the proactive rebalance of the vSAN objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Cluster[]</command:parameterValue> <dev:type> <maml:name>Cluster[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>The task object to track the stop rebalance operation</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Stop-VsanClusterRebalance -Cluster $vsanCluster</dev:code> <dev:remarks> <maml:para>Stops the ongoing proactive rebalance of the $vsanCluster vSAN cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Stop-VsanClusterRebalance.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Start-VsanClusterRebalance</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Sync-SpbmReplicationGroup</command:name> <maml:description> <maml:para>This cmdlet synchronizes the data between source and replica for the specified replication group.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Sync</command:verb> <command:noun>SpbmReplicationGroup</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet synchronizes the data between source and replica for the specified replication group. The replicas of the devices in the replication group are updated and a new point in time replica is created. This function should be called at the replication target location.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Sync-SpbmReplicationGroup</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>ReplicationGroup</maml:name> <maml:description> <maml:para>Specifies the target replication groups you want to synchronize with their corresponding source replication groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >SpbmReplicationGroup[]</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PointInTimeReplicaName</maml:name> <maml:description> <maml:para>Specifies the name of the point in time replica which will be created by this synchronization operation on the target site.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>ReplicationGroup</maml:name> <maml:description> <maml:para>Specifies the target replication groups you want to synchronize with their corresponding source replication groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">SpbmReplicationGroup[]</command:parameterValue> <dev:type> <maml:name>SpbmReplicationGroup[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PointInTimeReplicaName</maml:name> <maml:description> <maml:para>Specifies the name of the point in time replica which will be created by this synchronization operation on 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List of new SpbmPointInTimeReplica objects created on target site</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Sync-SpbmReplicationGroup -ReplicationGroup $targetRg -PointInTimeReplicaName 'MyReplica'</dev:code> <dev:remarks> <maml:para>Synchronizes the devices in the source replication group that corresponds to the $targetRg target replication group, creates a point in time replica of the devices at the target site, and names the replica 'MyReplica'.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Sync-SpbmReplicationGroup.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Test-VsanClusterHealth</command:name> <maml:description> <maml:para>This cmdlet runs a health test on the specified vSAN clusters and returns the test results.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Test</command:verb> <command:noun>VsanClusterHealth</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet runs a health test on the specified vSAN clusters and returns the test results.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-VsanClusterHealth</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the clusters on which you want to run a vSAN health test.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Cluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>UseCache</maml:name> <maml:description> <maml:para>Indicates to return the result directly from cache instead of running the full health check. The cache is updated periodically and keeps the latest vSAN health summary check result, either triggered from a user on-demand request or the periodical vSAN health check for triggering a health event or alarm.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>VMCreateTimeoutSeconds</maml:name> <maml:description> <maml:para>Specifies the timeout to run virtual machine creation tests in seconds. The default value is 120.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>TestResultFilter</maml:name> <maml:description> <maml:para>Specifies a subset of health test results. Only the specified test result fields are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VsanClusterHealthResultFilter[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the clusters on which you want to run a vSAN health test.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Cluster[]</command:parameterValue> <dev:type> <maml:name>Cluster[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseCache</maml:name> <maml:description> <maml:para>Indicates to return the result directly from cache instead of running the full health check. The cache is updated periodically and keeps the latest vSAN health summary check result, either triggered from a user on-demand request or the periodical vSAN health check for triggering a health event or alarm.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VMCreateTimeoutSeconds</maml:name> <maml:description> <maml:para>Specifies the timeout to run virtual machine creation tests in seconds. The default value is 120.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TestResultFilter</maml:name> <maml:description> <maml:para>Specifies a subset of health test results. Only the specified test result fields are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VsanClusterHealthResultFilter[]</command:parameterValue> <dev:type> <maml:name>VsanClusterHealthResultFilter[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VsanClusterHealthTestResult objects representing the result of the test run</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Test-VsanClusterHealth -Cluster $cluster</dev:code> <dev:remarks> <maml:para>Runs the vSAN cluster health test on $cluster vSAN cluster and returns the result of the test.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Test-VsanVMCreation -Cluster $cluster -UseCache -TestResultFilter NetworkHealth, DiskBalance</dev:code> <dev:remarks> <maml:para>Gets the result of the last health test run on $cluster vSAN cluster. Returns test result fields for network health and disk balance.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Test-VsanClusterHealth.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Test-VsanNetworkPerformance</command:name> <maml:description> <maml:para>This cmdlet runs a network performance test on the specified vSAN clusters and returns the test results.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Test</command:verb> <command:noun>VsanNetworkPerformance</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet runs a network performance test on the specified vSAN clusters and returns the test results.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-VsanNetworkPerformance</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the clusters on which you want to run a vSAN network performance test.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Cluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>UseCache</maml:name> <maml:description> <maml:para>Indicates whether to get a cached result from the server. If specified, a test is not run on the server and the last result cached on the server side is returned. If not specified, a test is run on the server side and the result is returned.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the clusters on which you want to run a vSAN network performance test.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Cluster[]</command:parameterValue> <dev:type> <maml:name>Cluster[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseCache</maml:name> <maml:description> <maml:para>Indicates whether to get a cached result from the server. If specified, a test is not run on the server and the last result cached on the server side is returned. If not specified, a test is run on the server side and the result is returned.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VsanClusterNetworkPerformanceTestResult objects representing the result of the test run</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Test-VsanNetworkPerformance -Cluster $cluster</dev:code> <dev:remarks> <maml:para>Runs the network performance test on the $cluster vSAN cluster and returns the result of the test.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Test-VsanNetworkPerformance -Cluster $cluster -UseCache</dev:code> <dev:remarks> <maml:para>Gets the result of the last network performance test run on the $cluster vSAN cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Test-VsanNetworkPerformance.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Test-VsanStoragePerformance</command:name> <maml:description> <maml:para>This cmdlet runs a storage performance test on the specified vSAN clusters and returns the test results.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Test</command:verb> <command:noun>VsanStoragePerformance</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet runs a storage performance test on the specified vSAN clusters and returns the test results. This cmdlet is obsolete and will be removed in a future release.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-VsanStoragePerformance</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the clusters on which you want to run a vSAN storage performance test.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Cluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>TestDurationSeconds</maml:name> <maml:description> <maml:para>Specifies the duration of the storage performance test in seconds. When the UseCache parameter is not specified, TestDurationSeconds must be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies the storage policy you want to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >SpbmStoragePolicy</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>UseCache</maml:name> <maml:description> <maml:para>Indicates whether to get a cached result from the server. If specified, a test is not run on the server and the last result cached on the server side is returned. If not specified, a test is run on the server side and the result is returned.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Workload</maml:name> <maml:description> <maml:para>Specifies the type of workload which should be run to test the storage performance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VsanStorageWorkloadType</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the clusters on which you want to run a vSAN storage performance test.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Cluster[]</command:parameterValue> <dev:type> <maml:name>Cluster[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TestDurationSeconds</maml:name> <maml:description> <maml:para>Specifies the duration of the storage performance test in seconds. When the UseCache parameter is not specified, TestDurationSeconds must be specified.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="named"> <maml:name>StoragePolicy</maml:name> <maml:description> <maml:para>Specifies the storage policy you want to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SpbmStoragePolicy</command:parameterValue> <dev:type> <maml:name>SpbmStoragePolicy</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseCache</maml:name> <maml:description> <maml:para>Indicates whether to get a cached result from the server. If specified, a test is not run on the server and the last result cached on the server side is returned. If not specified, a test is run on the server side and the result is returned.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Workload</maml:name> <maml:description> <maml:para>Specifies the type of workload which should be run to test the storage performance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VsanStorageWorkloadType</command:parameterValue> <dev:type> <maml:name>VsanStorageWorkloadType</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VsanClusterStoragePerformanceTestResult objects representing the result of the test run</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Test-VsanStoragePerformance -Cluster $cluster -TestDurationsSeconds 120 -StoragePolicy $policy -WorkLoad BasicSanityTest</dev:code> <dev:remarks> <maml:para>Runs the storage performance test of basic sanity workload type with test duration of 120 seconds, using the $policy storage policy on the $cluster vSAN cluster, and returns the result of the test.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Test-VsanStoragePerformance -Cluster $cluster -UseCache</dev:code> <dev:remarks> <maml:para>Gets the result of the last storage performance test run on the $cluster vSAN cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Test-VsanStoragePerformance.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Test-VsanVMCreation</command:name> <maml:description> <maml:para>This cmdlet runs a virtual machine creation test on the specified vSAN clusters and returns the test results.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Test</command:verb> <command:noun>VsanVMCreation</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet runs a virtual machine creation test on the specified vSAN clusters and returns the test results.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-VsanVMCreation</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the clusters on which you want to run a vSAN virtual machine creation test.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Cluster[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>TimeoutSeconds</maml:name> <maml:description> <maml:para>Specifies the timeout for the virtual machine creation test in seconds. The default value is 120 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>UseCache</maml:name> <maml:description> <maml:para>Indicates whether to get a cached result from the server. If specified, a test is not run on the server and the last result cached on the server side is returned. If not specified, a test is run on the server side and the result is returned.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Specifies the clusters on which you want to run a vSAN virtual machine creation test.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Cluster[]</command:parameterValue> <dev:type> <maml:name>Cluster[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutSeconds</maml:name> <maml:description> <maml:para>Specifies the timeout for the virtual machine creation test in seconds. The default value is 120 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UseCache</maml:name> <maml:description> <maml:para>Indicates whether to get a cached result from the server. If specified, a test is not run on the server and the last result cached on the server side is returned. If not specified, a test is run on the server side and the result is returned.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VsanClusterVMCreationTestResult objects representing the result of the test run</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Test-VsanVMCreation -Cluster $cluster -TimeoutSeconds 150</dev:code> <dev:remarks> <maml:para>Runs the virtual machine creation test with a timeout of 150 seconds on the $cluster vSAN cluster and returns the result of the test.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Test-VsanVMCreation -Cluster $cluster -UseCache</dev:code> <dev:remarks> <maml:para>Gets the result of the last virtual machine creation test run on the $cluster vSAN cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Test-VsanVMCreation.html</maml:uri> </maml:navigationLink> </maml: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"> <command:details> <command:name>Update-VsanHclDatabase</command:name> <maml:description> <maml:para>This cmdlet updates the vSAN hardware compatibility list (HCL) database.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Update</command:verb> <command:noun>VsanHclDatabase</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet updates the vSAN hardware compatibility list (HCL) database. It can be updated by using the latest online version or from a file, if Internet is not accessible. The cmdlet updates the HCL database for all clusters on the specified servers.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VsanHclDatabase</maml:name> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>FilePath</maml:name> <maml:description> <maml:para>Specifies the path to file from which vSAN HCL database is updated. If not specified, the database is updated with latest version from the Internet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Specifies the path to file from which vSAN HCL database is updated. If not specified, the database is updated with latest version from the Internet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Void</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Update-VsanHclDatabase -FilePath "LocalHclDbFilepath"</dev:code> <dev:remarks> <maml:para>Updates the vSAN HCL database on the vSphere server by using the content of the "LocalHclDbFilepath" file.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Update-VsanHclDatabase</dev:code> <dev:remarks> <maml:para>Updates the vSAN HCL database on the vSphere server by using the latest version from the Internet.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://code.vmware.com/doc/preview?id=6330#/doc/Update-VsanHclDatabase.html</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |