en-US/NimPSSDK.psm1-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems 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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSAccessControlRecord</command:name> <maml:description> <maml:para>Add an access control record to the specified volume.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSAccessControlRecord</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Add an access control record to the specified volume.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the access control record.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>apply_to</maml:name> <maml:description> <maml:para>Type of object this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>chap_user_id</maml:name> <maml:description> <maml:para>Identifier for the CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>chap_user_name</maml:name> <maml:description> <maml:para>Name of the CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>initiator_group_id</maml:name> <maml:description> <maml:para>Identifier for the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>initiator_group_name</maml:name> <maml:description> <maml:para>Name of the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>lun</maml:name> <maml:description> <maml:para>If this access control record applies to a regular volume, this attribute is the volume's LUN (Logical Unit Number). If the access protocol is iSCSI, the LUN will be 0. However, if the access protocol is Fibre Channel, the LUN will be in the range from 0 to 2047. If this record applies to a Virtual Volume, this attribute is the volume's secondary LUN in the range from 0 to 399999, for both iSCSI and Fibre Channel. If the record applies to a OpenstackV2 volume, the LUN will be in the range from 0 to 2047, for both iSCSI and Fibre Channel. If this record applies to a protocol endpoint or only a snapshot, this attribute is not meaningful and is set to null.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_id</maml:name> <maml:description> <maml:para>Identifier for the volume this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_name</maml:name> <maml:description> <maml:para>Name of the volume this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pe_id</maml:name> <maml:description> <maml:para>Identifier for the protocol endpoint this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pe_name</maml:name> <maml:description> <maml:para>Name of the protocol endpoint this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pe_lun</maml:name> <maml:description> <maml:para>LUN (Logical Unit Number) to associate with this protocol endpoint. Valid LUNs are in the 0-2047 range.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_id</maml:name> <maml:description> <maml:para>Identifier for the snapshot this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_name</maml:name> <maml:description> <maml:para>Name of the snapshot this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pe_ids</maml:name> <maml:description> <maml:para>List of candidate protocol endpoints that may be used to access the Virtual Volume. One of them will be selected for the access control record. This field is required only when creating an access control record for a Virtual Volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snapluns</maml:name> <maml:description> <maml:para>Information about the snapshot LUNs associated with this access control record. This field is meaningful when the online snapshot can be accessed as a LUN in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this access control record was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this access control record was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Access protocol of the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the access control record.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>apply_to</maml:name> <maml:description> <maml:para>Type of object this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>chap_user_id</maml:name> <maml:description> <maml:para>Identifier for the CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>chap_user_name</maml:name> <maml:description> <maml:para>Name of the CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>initiator_group_id</maml:name> <maml:description> <maml:para>Identifier for the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>initiator_group_name</maml:name> <maml:description> <maml:para>Name of the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>lun</maml:name> <maml:description> <maml:para>If this access control record applies to a regular volume, this attribute is the volume's LUN (Logical Unit Number). If the access protocol is iSCSI, the LUN will be 0. However, if the access protocol is Fibre Channel, the LUN will be in the range from 0 to 2047. If this record applies to a Virtual Volume, this attribute is the volume's secondary LUN in the range from 0 to 399999, for both iSCSI and Fibre Channel. If the record applies to a OpenstackV2 volume, the LUN will be in the range from 0 to 2047, for both iSCSI and Fibre Channel. If this record applies to a protocol endpoint or only a snapshot, this attribute is not meaningful and is set to null.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_id</maml:name> <maml:description> <maml:para>Identifier for the volume this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vol_name</maml:name> <maml:description> <maml:para>Name of the volume this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vol_agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pe_id</maml:name> <maml:description> <maml:para>Identifier for the protocol endpoint this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pe_name</maml:name> <maml:description> <maml:para>Name of the protocol endpoint this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pe_lun</maml:name> <maml:description> <maml:para>LUN (Logical Unit Number) to associate with this protocol endpoint. Valid LUNs are in the 0-2047 range.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_id</maml:name> <maml:description> <maml:para>Identifier for the snapshot this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>snap_name</maml:name> <maml:description> <maml:para>Name of the snapshot this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pe_ids</maml:name> <maml:description> <maml:para>List of candidate protocol endpoints that may be used to access the Virtual Volume. One of them will be selected for the access control record. This field is required only when creating an access control record for a Virtual Volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snapluns</maml:name> <maml:description> <maml:para>Information about the snapshot LUNs associated with this access control record. This field is meaningful when the online snapshot can be accessed as a LUN in the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this access control record was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this access control record was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Access protocol of the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> New-NSAccessControlRecord -initiator_group_id 0228eada7f8dd99d3b000000000000000000000056 -vol_id 0628eada7f8dd99d3b0000000000000000000000ca vol_name Initiator_group_name Apply_to Lun snap_name id -------- -------------------- -------- --- --------- -- TestVol-184 TestInit-158 both 0 0d28eada7f8dd99d3b000000000000000000000054 </dev:code> <dev:remarks> <maml:para>This command will create a new access control record. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSAccessControlRecord</command:name> <maml:description> <maml:para>List one or more access control records.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSAccessControlRecord</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List one or more access control records.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the access control record.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>apply_to</maml:name> <maml:description> <maml:para>Type of object this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>chap_user_id</maml:name> <maml:description> <maml:para>Identifier for the CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>chap_user_name</maml:name> <maml:description> <maml:para>Name of the CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>initiator_group_id</maml:name> <maml:description> <maml:para>Identifier for the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>initiator_group_name</maml:name> <maml:description> <maml:para>Name of the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>lun</maml:name> <maml:description> <maml:para>If this access control record applies to a regular volume, this attribute is the volume's LUN (Logical Unit Number). If the access protocol is iSCSI, the LUN will be 0. However, if the access protocol is Fibre Channel, the LUN will be in the range from 0 to 2047. If this record applies to a Virtual Volume, this attribute is the volume's secondary LUN in the range from 0 to 399999, for both iSCSI and Fibre Channel. If the record applies to a OpenstackV2 volume, the LUN will be in the range from 0 to 2047, for both iSCSI and Fibre Channel. If this record applies to a protocol endpoint or only a snapshot, this attribute is not meaningful and is set to null.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_id</maml:name> <maml:description> <maml:para>Identifier for the volume this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_name</maml:name> <maml:description> <maml:para>Name of the volume this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pe_id</maml:name> <maml:description> <maml:para>Identifier for the protocol endpoint this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pe_name</maml:name> <maml:description> <maml:para>Name of the protocol endpoint this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pe_lun</maml:name> <maml:description> <maml:para>LUN (Logical Unit Number) to associate with this protocol endpoint. Valid LUNs are in the 0-2047 range.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_id</maml:name> <maml:description> <maml:para>Identifier for the snapshot this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_name</maml:name> <maml:description> <maml:para>Name of the snapshot this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pe_ids</maml:name> <maml:description> <maml:para>List of candidate protocol endpoints that may be used to access the Virtual Volume. One of them will be selected for the access control record. This field is required only when creating an access control record for a Virtual Volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snapluns</maml:name> <maml:description> <maml:para>Information about the snapshot LUNs associated with this access control record. This field is meaningful when the online snapshot can be accessed as a LUN in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this access control record was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this access control record was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Access protocol of the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the access control record.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>apply_to</maml:name> <maml:description> <maml:para>Type of object this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>chap_user_id</maml:name> <maml:description> <maml:para>Identifier for the CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>chap_user_name</maml:name> <maml:description> <maml:para>Name of the CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>initiator_group_id</maml:name> <maml:description> <maml:para>Identifier for the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>initiator_group_name</maml:name> <maml:description> <maml:para>Name of the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>lun</maml:name> <maml:description> <maml:para>If this access control record applies to a regular volume, this attribute is the volume's LUN (Logical Unit Number). If the access protocol is iSCSI, the LUN will be 0. However, if the access protocol is Fibre Channel, the LUN will be in the range from 0 to 2047. If this record applies to a Virtual Volume, this attribute is the volume's secondary LUN in the range from 0 to 399999, for both iSCSI and Fibre Channel. If the record applies to a OpenstackV2 volume, the LUN will be in the range from 0 to 2047, for both iSCSI and Fibre Channel. If this record applies to a protocol endpoint or only a snapshot, this attribute is not meaningful and is set to null.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_id</maml:name> <maml:description> <maml:para>Identifier for the volume this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vol_name</maml:name> <maml:description> <maml:para>Name of the volume this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vol_agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pe_id</maml:name> <maml:description> <maml:para>Identifier for the protocol endpoint this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pe_name</maml:name> <maml:description> <maml:para>Name of the protocol endpoint this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pe_lun</maml:name> <maml:description> <maml:para>LUN (Logical Unit Number) to associate with this protocol endpoint. Valid LUNs are in the 0-2047 range.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_id</maml:name> <maml:description> <maml:para>Identifier for the snapshot this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>snap_name</maml:name> <maml:description> <maml:para>Name of the snapshot this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pe_ids</maml:name> <maml:description> <maml:para>List of candidate protocol endpoints that may be used to access the Virtual Volume. One of them will be selected for the access control record. This field is required only when creating an access control record for a Virtual Volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snapluns</maml:name> <maml:description> <maml:para>Information about the snapshot LUNs associated with this access control record. This field is meaningful when the online snapshot can be accessed as a LUN in the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this access control record was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this access control record was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Access protocol of the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSAccessControlRecord vol_name Initiator_group_name Apply_to Lun snap_name id -------- -------------------- -------- --- --------- -- starter-vol-29484... * volume 0 0d28eada7f8dd99d3b000000000000000000000014 starter-vol-29484... * volume 0 0d28eada7f8dd99d3b000000000000000000000019 starter-vol-29484... * volume 0 0d28eada7f8dd99d3b00000000000000000000001a starter-vol-29484... * volume 0 0d28eada7f8dd99d3b00000000000000000000001b starter-vol-29484... * volume 0 0d28eada7f8dd99d3b000000000000000000000040 </dev:code> <dev:remarks> <maml:para>This command will retrieves list of access control records. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 2 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSAccessControlRecord -id 0d28eada7f8dd99d3b000000000000000000000014 vol_name Initiator_group_name Apply_to Lun snap_name id -------- -------------------- -------- --- --------- -- starter-vol-2948409147442961723-57 * volume 0 0d28eada7f8dd99d3b000000000000000000000014 </dev:code> <dev:remarks> <maml:para>This command will retrieve a single Access control Record based on an id. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSAccessControlRecord</command:name> <maml:description> <maml:para>Delete an access control record from the specified volume.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSAccessControlRecord</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Delete an access control record from the specified volume.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the access control record.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>apply_to</maml:name> <maml:description> <maml:para>Type of object this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>chap_user_id</maml:name> <maml:description> <maml:para>Identifier for the CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>chap_user_name</maml:name> <maml:description> <maml:para>Name of the CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>initiator_group_id</maml:name> <maml:description> <maml:para>Identifier for the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>initiator_group_name</maml:name> <maml:description> <maml:para>Name of the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>lun</maml:name> <maml:description> <maml:para>If this access control record applies to a regular volume, this attribute is the volume's LUN (Logical Unit Number). If the access protocol is iSCSI, the LUN will be 0. However, if the access protocol is Fibre Channel, the LUN will be in the range from 0 to 2047. If this record applies to a Virtual Volume, this attribute is the volume's secondary LUN in the range from 0 to 399999, for both iSCSI and Fibre Channel. If the record applies to a OpenstackV2 volume, the LUN will be in the range from 0 to 2047, for both iSCSI and Fibre Channel. If this record applies to a protocol endpoint or only a snapshot, this attribute is not meaningful and is set to null.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_id</maml:name> <maml:description> <maml:para>Identifier for the volume this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_name</maml:name> <maml:description> <maml:para>Name of the volume this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pe_id</maml:name> <maml:description> <maml:para>Identifier for the protocol endpoint this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pe_name</maml:name> <maml:description> <maml:para>Name of the protocol endpoint this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pe_lun</maml:name> <maml:description> <maml:para>LUN (Logical Unit Number) to associate with this protocol endpoint. Valid LUNs are in the 0-2047 range.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_id</maml:name> <maml:description> <maml:para>Identifier for the snapshot this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_name</maml:name> <maml:description> <maml:para>Name of the snapshot this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pe_ids</maml:name> <maml:description> <maml:para>List of candidate protocol endpoints that may be used to access the Virtual Volume. One of them will be selected for the access control record. This field is required only when creating an access control record for a Virtual Volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snapluns</maml:name> <maml:description> <maml:para>Information about the snapshot LUNs associated with this access control record. This field is meaningful when the online snapshot can be accessed as a LUN in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this access control record was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this access control record was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAccessControlRecord</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Access protocol of the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the access control record.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>apply_to</maml:name> <maml:description> <maml:para>Type of object this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>chap_user_id</maml:name> <maml:description> <maml:para>Identifier for the CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>chap_user_name</maml:name> <maml:description> <maml:para>Name of the CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>initiator_group_id</maml:name> <maml:description> <maml:para>Identifier for the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>initiator_group_name</maml:name> <maml:description> <maml:para>Name of the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>lun</maml:name> <maml:description> <maml:para>If this access control record applies to a regular volume, this attribute is the volume's LUN (Logical Unit Number). If the access protocol is iSCSI, the LUN will be 0. However, if the access protocol is Fibre Channel, the LUN will be in the range from 0 to 2047. If this record applies to a Virtual Volume, this attribute is the volume's secondary LUN in the range from 0 to 399999, for both iSCSI and Fibre Channel. If the record applies to a OpenstackV2 volume, the LUN will be in the range from 0 to 2047, for both iSCSI and Fibre Channel. If this record applies to a protocol endpoint or only a snapshot, this attribute is not meaningful and is set to null.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_id</maml:name> <maml:description> <maml:para>Identifier for the volume this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vol_name</maml:name> <maml:description> <maml:para>Name of the volume this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vol_agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pe_id</maml:name> <maml:description> <maml:para>Identifier for the protocol endpoint this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pe_name</maml:name> <maml:description> <maml:para>Name of the protocol endpoint this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pe_lun</maml:name> <maml:description> <maml:para>LUN (Logical Unit Number) to associate with this protocol endpoint. Valid LUNs are in the 0-2047 range.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_id</maml:name> <maml:description> <maml:para>Identifier for the snapshot this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>snap_name</maml:name> <maml:description> <maml:para>Name of the snapshot this access control record applies to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pe_ids</maml:name> <maml:description> <maml:para>List of candidate protocol endpoints that may be used to access the Virtual Volume. One of them will be selected for the access control record. This field is required only when creating an access control record for a Virtual Volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snapluns</maml:name> <maml:description> <maml:para>Information about the snapshot LUNs associated with this access control record. This field is meaningful when the online snapshot can be accessed as a LUN in the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this access control record was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this access control record was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Access protocol of the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Remove-NSAccessControlRecord -id 0d28eada7f8dd99d3b000000000000000000000054 </dev:code> <dev:remarks> <maml:para>This command will remove an existing access control record. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSChapUser</command:name> <maml:description> <maml:para>Create a new CHAP user, which is then assigned to an access control record for a volume. CHAP user authentication requires a CHAP secret that agrees as the challenge response.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSChapUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Create a new CHAP user, which is then assigned to an access control record for a volume. CHAP user authentication requires a CHAP secret that agrees as the challenge response.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSChapUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of CHAP user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>CHAP user's fully qualified name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>CHAP user name used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSChapUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>CHAP secret.The CHAP secret should be between 12-16 characters and cannot contain spaces or most punctuation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>initiator_iqns</maml:name> <maml:description> <maml:para>List of iSCSI initiators. To be configured with this CHAP user for iSCSI Group Target CHAP authentication. This attribute cannot be modified at the same time with other attributes. If any specified initiator is already associated with another CHAP user, it will be replaced by this CHAP user for future CHAP authentication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Identifier for the tenant.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this CHAP user was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this CHAP user was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_list</maml:name> <maml:description> <maml:para>List of volumes associated with this CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_count</maml:name> <maml:description> <maml:para>Count of volumes associated with this CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of CHAP user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>CHAP user's fully qualified name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>CHAP user name used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>CHAP secret.The CHAP secret should be between 12-16 characters and cannot contain spaces or most punctuation.</maml:para> </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="true (ByValue)" position="named"> <maml:name>initiator_iqns</maml:name> <maml:description> <maml:para>List of iSCSI initiators. To be configured with this CHAP user for iSCSI Group Target CHAP authentication. This attribute cannot be modified at the same time with other attributes. If any specified initiator is already associated with another CHAP user, it will be replaced by this CHAP user for future CHAP authentication.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Identifier for the tenant.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this CHAP user was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this CHAP user was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_list</maml:name> <maml:description> <maml:para>List of volumes associated with this CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_count</maml:name> <maml:description> <maml:para>Count of volumes associated with this CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> New-NSChapUser -name TestUser1 -description "My Chap User" -password 12to16charsValid creation_time : 1533274153 description : My Chap User full_name : id : 0128eada7f8dd99d3b000000000000000000000033 last_modified : 1533274153 name : TestUser1 search_name : TestUser1 vol_count : 0 vol_list : </dev:code> <dev:remarks> <maml:para>This command will create a new Chap User using the supplied values. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSChapUser</command:name> <maml:description> <maml:para>List a set of CHAP users or a single CHAP user.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSChapUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List a set of CHAP users or a single CHAP user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>CHAP user's fully qualified name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>CHAP user name used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>CHAP secret.The CHAP secret should be between 12-16 characters and cannot contain spaces or most punctuation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>initiator_iqns</maml:name> <maml:description> <maml:para>List of iSCSI initiators. To be configured with this CHAP user for iSCSI Group Target CHAP authentication. This attribute cannot be modified at the same time with other attributes. If any specified initiator is already associated with another CHAP user, it will be replaced by this CHAP user for future CHAP authentication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Identifier for the tenant.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this CHAP user was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this CHAP user was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_list</maml:name> <maml:description> <maml:para>List of volumes associated with this CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_count</maml:name> <maml:description> <maml:para>Count of volumes associated with this CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>CHAP user's fully qualified name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>CHAP user name used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>CHAP secret.The CHAP secret should be between 12-16 characters and cannot contain spaces or most punctuation.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>initiator_iqns</maml:name> <maml:description> <maml:para>List of iSCSI initiators. To be configured with this CHAP user for iSCSI Group Target CHAP authentication. This attribute cannot be modified at the same time with other attributes. If any specified initiator is already associated with another CHAP user, it will be replaced by this CHAP user for future CHAP authentication.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Identifier for the tenant.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this CHAP user was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this CHAP user was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_list</maml:name> <maml:description> <maml:para>List of volumes associated with this CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_count</maml:name> <maml:description> <maml:para>Count of volumes associated with this CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSChapUser creation_time : 1532859878 description : My Chap User1 full_name : id : 0128eada7f8dd99d3b00000000000000000000000b last_modified : 1532859878 name : TestUser2 search_name : TestUser2 vol_count : 0 vol_list : creation_time : 1533274153 description : My Chap User full_name : id : 0128eada7f8dd99d3b000000000000000000000033 last_modified : 1533274153 name : TestUser1 search_name : TestUser1 vol_count : 0 vol_list : </dev:code> <dev:remarks> <maml:para>This command will list all Chap Users. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 2 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSChapUser -name TestUser1 creation_time : 1533274153 description : My Chap User full_name : id : 0128eada7f8dd99d3b000000000000000000000033 last_modified : 1533274153 name : TestUser1 search_name : TestUser1 vol_count : 0 vol_list : </dev:code> <dev:remarks> <maml:para>This command will retrieve only a specific Chap User using the supplied values. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSChapUser</command:name> <maml:description> <maml:para>Modify attributes of specified CHAP user.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSChapUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Modify attributes of specified CHAP user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSChapUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the CHAP user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>CHAP user's fully qualified name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>CHAP user name used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>CHAP secret.The CHAP secret should be between 12-16 characters and cannot contain spaces or most punctuation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>initiator_iqns</maml:name> <maml:description> <maml:para>List of iSCSI initiators. To be configured with this CHAP user for iSCSI Group Target CHAP authentication. This attribute cannot be modified at the same time with other attributes. If any specified initiator is already associated with another CHAP user, it will be replaced by this CHAP user for future CHAP authentication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Identifier for the tenant.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this CHAP user was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this CHAP user was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_list</maml:name> <maml:description> <maml:para>List of volumes associated with this CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_count</maml:name> <maml:description> <maml:para>Count of volumes associated with this CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the CHAP user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>CHAP user's fully qualified name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>CHAP user name used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>CHAP secret.The CHAP secret should be between 12-16 characters and cannot contain spaces or most punctuation.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>initiator_iqns</maml:name> <maml:description> <maml:para>List of iSCSI initiators. To be configured with this CHAP user for iSCSI Group Target CHAP authentication. This attribute cannot be modified at the same time with other attributes. If any specified initiator is already associated with another CHAP user, it will be replaced by this CHAP user for future CHAP authentication.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Identifier for the tenant.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this CHAP user was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this CHAP user was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_list</maml:name> <maml:description> <maml:para>List of volumes associated with this CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_count</maml:name> <maml:description> <maml:para>Count of volumes associated with this CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Set-NSChapUser -id 0128eada7f8dd99d3b000000000000000000000033 -description "My New Description" creation_time : 1533274153 description : My New Description full_name : id : 0128eada7f8dd99d3b000000000000000000000033 last_modified : 1533274155 name : TestUser1 search_name : TestUser1 vol_count : 0 vol_list : </dev:code> <dev:remarks> <maml:para>This command will modify the description for a specific Chap Users. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSChapUser</command:name> <maml:description> <maml:para>Delete specified CHAP user.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSChapUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Delete specified CHAP user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>CHAP user's fully qualified name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>CHAP user name used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>CHAP secret.The CHAP secret should be between 12-16 characters and cannot contain spaces or most punctuation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>initiator_iqns</maml:name> <maml:description> <maml:para>List of iSCSI initiators. To be configured with this CHAP user for iSCSI Group Target CHAP authentication. This attribute cannot be modified at the same time with other attributes. If any specified initiator is already associated with another CHAP user, it will be replaced by this CHAP user for future CHAP authentication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Identifier for the tenant.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this CHAP user was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this CHAP user was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_list</maml:name> <maml:description> <maml:para>List of volumes associated with this CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSChapUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_count</maml:name> <maml:description> <maml:para>Count of volumes associated with this CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>CHAP user's fully qualified name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>CHAP user name used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>CHAP secret.The CHAP secret should be between 12-16 characters and cannot contain spaces or most punctuation.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>initiator_iqns</maml:name> <maml:description> <maml:para>List of iSCSI initiators. To be configured with this CHAP user for iSCSI Group Target CHAP authentication. This attribute cannot be modified at the same time with other attributes. If any specified initiator is already associated with another CHAP user, it will be replaced by this CHAP user for future CHAP authentication.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Identifier for the tenant.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this CHAP user was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this CHAP user was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_list</maml:name> <maml:description> <maml:para>List of volumes associated with this CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_count</maml:name> <maml:description> <maml:para>Count of volumes associated with this CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Remove-NSChapUser -id 0128eada7f8dd99d3b000000000000000000000033 </dev:code> <dev:remarks> <maml:para>This command will Remove a specific Chap User. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSPool</command:name> <maml:description> <maml:para>Creates a pool with given attributes.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSPool</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Creates a pool with given attributes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of pool used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this pool was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this pool was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>capacity</maml:name> <maml:description> <maml:para>Total storage space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage</maml:name> <maml:description> <maml:para>Used space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings</maml:name> <maml:description> <maml:para>Overall space usage savings in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_data_reduction</maml:name> <maml:description> <maml:para>Space usage savings in the pool that does not include thin-provisioning savings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_compression</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to compression.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_dedupe</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to deduplication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_clone</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to cloning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_vol_thin_provisioning</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to thin provisioning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>reserve</maml:name> <maml:description> <maml:para>Reserved space of the pool in bytes. Sum of volume reserve in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>unused_reserve</maml:name> <maml:description> <maml:para>Unused reserve space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>free_space</maml:name> <maml:description> <maml:para>Free space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache_capacity</maml:name> <maml:description> <maml:para>Total usable cache capacity of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pinnable_cache_capacity</maml:name> <maml:description> <maml:para>Total pinnable cache capacity of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pinned_cache_capacity</maml:name> <maml:description> <maml:para>Total pinned cache capacity of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_capacity_bytes</maml:name> <maml:description> <maml:para>The dedupe capacity of a hybrid pool. Does not apply to all-flash pools.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_usage_bytes</maml:name> <maml:description> <maml:para>The dedupe usage of a hybrid pool. Does not apply to all-flash pools.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_ratio</maml:name> <maml:description> <maml:para>Overall space usage savings in the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>data_reduction_ratio</maml:name> <maml:description> <maml:para>Space usage savings in the pool expressed as ratio that does not include thin-provisioning savings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compression_ratio</maml:name> <maml:description> <maml:para>Compression savings for the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_ratio</maml:name> <maml:description> <maml:para>Dedupe savings for the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>clone_ratio</maml:name> <maml:description> <maml:para>Clone savings for the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_thin_provisioning_ratio</maml:name> <maml:description> <maml:para>Thin provisioning savings for volumes in the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snapcoll_count</maml:name> <maml:description> <maml:para>Snapshot collection count.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_count</maml:name> <maml:description> <maml:para>Snapshot count.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_count</maml:name> <maml:description> <maml:para>Number of arrays in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_count</maml:name> <maml:description> <maml:para>Number of volumes assigned to the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_list</maml:name> <maml:description> <maml:para>List of arrays in the pool with detailed information. When create/update array list, only arrays' ID is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>unassigned_array_list</maml:name> <maml:description> <maml:para>List of arrays being unassigned from the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_list</maml:name> <maml:description> <maml:para>The list of volumes in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pinned_vol_list</maml:name> <maml:description> <maml:para>The list of pinned volumes in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folder_list</maml:name> <maml:description> <maml:para>The list of fully qualified names of folders in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified pool even if it contains deleted volumes whose space is being reclaimed. Forcibly remove an array from array_list via an update operation even if the array is not reachable. There should no volumes currently in the pool for the forced update operation to succeed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicates whether the usage of pool is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>uncompressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of volumes in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>uncompressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of snapshots in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>all_flash</maml:name> <maml:description> <maml:para>Indicate whether the pool is an all_flash pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_capable</maml:name> <maml:description> <maml:para>Indicates whether the pool is capable of hosting deduped volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_all_volumes_capable</maml:name> <maml:description> <maml:para>Indicates whether the pool can enable dedupe by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_all_volumes</maml:name> <maml:description> <maml:para>Indicates if dedupe is enabled by default for new volumes on this pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_default</maml:name> <maml:description> <maml:para>Indicates if this is the default pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of pool used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this pool was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this pool was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>capacity</maml:name> <maml:description> <maml:para>Total storage space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage</maml:name> <maml:description> <maml:para>Used space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings</maml:name> <maml:description> <maml:para>Overall space usage savings in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_data_reduction</maml:name> <maml:description> <maml:para>Space usage savings in the pool that does not include thin-provisioning savings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_compression</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to compression.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_dedupe</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to deduplication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_clone</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to cloning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_vol_thin_provisioning</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to thin provisioning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>reserve</maml:name> <maml:description> <maml:para>Reserved space of the pool in bytes. Sum of volume reserve in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>unused_reserve</maml:name> <maml:description> <maml:para>Unused reserve space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>free_space</maml:name> <maml:description> <maml:para>Free space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache_capacity</maml:name> <maml:description> <maml:para>Total usable cache capacity of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pinnable_cache_capacity</maml:name> <maml:description> <maml:para>Total pinnable cache capacity of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pinned_cache_capacity</maml:name> <maml:description> <maml:para>Total pinned cache capacity of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_capacity_bytes</maml:name> <maml:description> <maml:para>The dedupe capacity of a hybrid pool. Does not apply to all-flash pools.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_usage_bytes</maml:name> <maml:description> <maml:para>The dedupe usage of a hybrid pool. Does not apply to all-flash pools.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_ratio</maml:name> <maml:description> <maml:para>Overall space usage savings in the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>data_reduction_ratio</maml:name> <maml:description> <maml:para>Space usage savings in the pool expressed as ratio that does not include thin-provisioning savings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compression_ratio</maml:name> <maml:description> <maml:para>Compression savings for the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_ratio</maml:name> <maml:description> <maml:para>Dedupe savings for the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>clone_ratio</maml:name> <maml:description> <maml:para>Clone savings for the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_thin_provisioning_ratio</maml:name> <maml:description> <maml:para>Thin provisioning savings for volumes in the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snapcoll_count</maml:name> <maml:description> <maml:para>Snapshot collection count.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_count</maml:name> <maml:description> <maml:para>Snapshot count.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>array_count</maml:name> <maml:description> <maml:para>Number of arrays in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_count</maml:name> <maml:description> <maml:para>Number of volumes assigned to the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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>array_list</maml:name> <maml:description> <maml:para>List of arrays in the pool with detailed information. When create/update array list, only arrays' ID is required.</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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>unassigned_array_list</maml:name> <maml:description> <maml:para>List of arrays being unassigned from the pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_list</maml:name> <maml:description> <maml:para>The list of volumes in the pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pinned_vol_list</maml:name> <maml:description> <maml:para>The list of pinned volumes in the pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>folder_list</maml:name> <maml:description> <maml:para>The list of fully qualified names of folders in the pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified pool even if it contains deleted volumes whose space is being reclaimed. Forcibly remove an array from array_list via an update operation even if the array is not reachable. There should no volumes currently in the pool for the forced update operation to succeed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicates whether the usage of pool is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>uncompressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of volumes in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>uncompressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of snapshots in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>all_flash</maml:name> <maml:description> <maml:para>Indicate whether the pool is an all_flash pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_capable</maml:name> <maml:description> <maml:para>Indicates whether the pool is capable of hosting deduped volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_all_volumes_capable</maml:name> <maml:description> <maml:para>Indicates whether the pool can enable dedupe by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_all_volumes</maml:name> <maml:description> <maml:para>Indicates if dedupe is enabled by default for new volumes on this pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_default</maml:name> <maml:description> <maml:para>Indicates if this is the default pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSPool</command:name> <maml:description> <maml:para>Read a set of pools or a single pool.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSPool</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Read a set of pools or a single pool.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of pool used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this pool was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this pool was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>capacity</maml:name> <maml:description> <maml:para>Total storage space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage</maml:name> <maml:description> <maml:para>Used space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings</maml:name> <maml:description> <maml:para>Overall space usage savings in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_data_reduction</maml:name> <maml:description> <maml:para>Space usage savings in the pool that does not include thin-provisioning savings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_compression</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to compression.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_dedupe</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to deduplication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_clone</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to cloning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_vol_thin_provisioning</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to thin provisioning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>reserve</maml:name> <maml:description> <maml:para>Reserved space of the pool in bytes. Sum of volume reserve in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>unused_reserve</maml:name> <maml:description> <maml:para>Unused reserve space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>free_space</maml:name> <maml:description> <maml:para>Free space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache_capacity</maml:name> <maml:description> <maml:para>Total usable cache capacity of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pinnable_cache_capacity</maml:name> <maml:description> <maml:para>Total pinnable cache capacity of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pinned_cache_capacity</maml:name> <maml:description> <maml:para>Total pinned cache capacity of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_capacity_bytes</maml:name> <maml:description> <maml:para>The dedupe capacity of a hybrid pool. Does not apply to all-flash pools.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_usage_bytes</maml:name> <maml:description> <maml:para>The dedupe usage of a hybrid pool. Does not apply to all-flash pools.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_ratio</maml:name> <maml:description> <maml:para>Overall space usage savings in the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>data_reduction_ratio</maml:name> <maml:description> <maml:para>Space usage savings in the pool expressed as ratio that does not include thin-provisioning savings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compression_ratio</maml:name> <maml:description> <maml:para>Compression savings for the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_ratio</maml:name> <maml:description> <maml:para>Dedupe savings for the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>clone_ratio</maml:name> <maml:description> <maml:para>Clone savings for the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_thin_provisioning_ratio</maml:name> <maml:description> <maml:para>Thin provisioning savings for volumes in the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snapcoll_count</maml:name> <maml:description> <maml:para>Snapshot collection count.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_count</maml:name> <maml:description> <maml:para>Snapshot count.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_count</maml:name> <maml:description> <maml:para>Number of arrays in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_count</maml:name> <maml:description> <maml:para>Number of volumes assigned to the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_list</maml:name> <maml:description> <maml:para>List of arrays in the pool with detailed information. When create/update array list, only arrays' ID is required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>unassigned_array_list</maml:name> <maml:description> <maml:para>List of arrays being unassigned from the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_list</maml:name> <maml:description> <maml:para>The list of volumes in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pinned_vol_list</maml:name> <maml:description> <maml:para>The list of pinned volumes in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folder_list</maml:name> <maml:description> <maml:para>The list of fully qualified names of folders in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified pool even if it contains deleted volumes whose space is being reclaimed. Forcibly remove an array from array_list via an update operation even if the array is not reachable. There should no volumes currently in the pool for the forced update operation to succeed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicates whether the usage of pool is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>uncompressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of volumes in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>uncompressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of snapshots in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>all_flash</maml:name> <maml:description> <maml:para>Indicate whether the pool is an all_flash pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_capable</maml:name> <maml:description> <maml:para>Indicates whether the pool is capable of hosting deduped volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_all_volumes_capable</maml:name> <maml:description> <maml:para>Indicates whether the pool can enable dedupe by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_all_volumes</maml:name> <maml:description> <maml:para>Indicates if dedupe is enabled by default for new volumes on this pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_default</maml:name> <maml:description> <maml:para>Indicates if this is the default pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of pool used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this pool was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this pool was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>capacity</maml:name> <maml:description> <maml:para>Total storage space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage</maml:name> <maml:description> <maml:para>Used space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings</maml:name> <maml:description> <maml:para>Overall space usage savings in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_data_reduction</maml:name> <maml:description> <maml:para>Space usage savings in the pool that does not include thin-provisioning savings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_compression</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to compression.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_dedupe</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to deduplication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_clone</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to cloning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_vol_thin_provisioning</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to thin provisioning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>reserve</maml:name> <maml:description> <maml:para>Reserved space of the pool in bytes. Sum of volume reserve in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>unused_reserve</maml:name> <maml:description> <maml:para>Unused reserve space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>free_space</maml:name> <maml:description> <maml:para>Free space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache_capacity</maml:name> <maml:description> <maml:para>Total usable cache capacity of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pinnable_cache_capacity</maml:name> <maml:description> <maml:para>Total pinnable cache capacity of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pinned_cache_capacity</maml:name> <maml:description> <maml:para>Total pinned cache capacity of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_capacity_bytes</maml:name> <maml:description> <maml:para>The dedupe capacity of a hybrid pool. Does not apply to all-flash pools.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_usage_bytes</maml:name> <maml:description> <maml:para>The dedupe usage of a hybrid pool. Does not apply to all-flash pools.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_ratio</maml:name> <maml:description> <maml:para>Overall space usage savings in the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>data_reduction_ratio</maml:name> <maml:description> <maml:para>Space usage savings in the pool expressed as ratio that does not include thin-provisioning savings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compression_ratio</maml:name> <maml:description> <maml:para>Compression savings for the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_ratio</maml:name> <maml:description> <maml:para>Dedupe savings for the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>clone_ratio</maml:name> <maml:description> <maml:para>Clone savings for the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_thin_provisioning_ratio</maml:name> <maml:description> <maml:para>Thin provisioning savings for volumes in the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snapcoll_count</maml:name> <maml:description> <maml:para>Snapshot collection count.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_count</maml:name> <maml:description> <maml:para>Snapshot count.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>array_count</maml:name> <maml:description> <maml:para>Number of arrays in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_count</maml:name> <maml:description> <maml:para>Number of volumes assigned to the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>array_list</maml:name> <maml:description> <maml:para>List of arrays in the pool with detailed information. When create/update array list, only arrays' ID is required.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>unassigned_array_list</maml:name> <maml:description> <maml:para>List of arrays being unassigned from the pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_list</maml:name> <maml:description> <maml:para>The list of volumes in the pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pinned_vol_list</maml:name> <maml:description> <maml:para>The list of pinned volumes in the pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>folder_list</maml:name> <maml:description> <maml:para>The list of fully qualified names of folders in the pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified pool even if it contains deleted volumes whose space is being reclaimed. Forcibly remove an array from array_list via an update operation even if the array is not reachable. There should no volumes currently in the pool for the forced update operation to succeed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicates whether the usage of pool is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>uncompressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of volumes in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>uncompressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of snapshots in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>all_flash</maml:name> <maml:description> <maml:para>Indicate whether the pool is an all_flash pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_capable</maml:name> <maml:description> <maml:para>Indicates whether the pool is capable of hosting deduped volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_all_volumes_capable</maml:name> <maml:description> <maml:para>Indicates whether the pool can enable dedupe by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_all_volumes</maml:name> <maml:description> <maml:para>Indicates if dedupe is enabled by default for new volumes on this pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_default</maml:name> <maml:description> <maml:para>Indicates if this is the default pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSPool name id capacity free_space cache_capacity snap_count vol_count description ---- -- -------- ---------- -------------- ---------- --------- ----------- default 0a1bde905fd66eed40000000000000000000000001 22875399783 19387926256 13432258560 2 2 Default pool MyPool1 0a1bde905fd66eed40000000000000000000000003 22875399783 22875399783 13432258560 0 0 My New Description no.529 </dev:code> <dev:remarks> <maml:para>This command will retrieve the array pool(s). </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSPool</command:name> <maml:description> <maml:para>Modify pool attributes.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSPool</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Modify pool attributes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of pool used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this pool was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this pool was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>capacity</maml:name> <maml:description> <maml:para>Total storage space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage</maml:name> <maml:description> <maml:para>Used space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings</maml:name> <maml:description> <maml:para>Overall space usage savings in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_data_reduction</maml:name> <maml:description> <maml:para>Space usage savings in the pool that does not include thin-provisioning savings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_compression</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to compression.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_dedupe</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to deduplication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_clone</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to cloning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_vol_thin_provisioning</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to thin provisioning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>reserve</maml:name> <maml:description> <maml:para>Reserved space of the pool in bytes. Sum of volume reserve in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>unused_reserve</maml:name> <maml:description> <maml:para>Unused reserve space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>free_space</maml:name> <maml:description> <maml:para>Free space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache_capacity</maml:name> <maml:description> <maml:para>Total usable cache capacity of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pinnable_cache_capacity</maml:name> <maml:description> <maml:para>Total pinnable cache capacity of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pinned_cache_capacity</maml:name> <maml:description> <maml:para>Total pinned cache capacity of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_capacity_bytes</maml:name> <maml:description> <maml:para>The dedupe capacity of a hybrid pool. Does not apply to all-flash pools.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_usage_bytes</maml:name> <maml:description> <maml:para>The dedupe usage of a hybrid pool. Does not apply to all-flash pools.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_ratio</maml:name> <maml:description> <maml:para>Overall space usage savings in the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>data_reduction_ratio</maml:name> <maml:description> <maml:para>Space usage savings in the pool expressed as ratio that does not include thin-provisioning savings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compression_ratio</maml:name> <maml:description> <maml:para>Compression savings for the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_ratio</maml:name> <maml:description> <maml:para>Dedupe savings for the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>clone_ratio</maml:name> <maml:description> <maml:para>Clone savings for the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_thin_provisioning_ratio</maml:name> <maml:description> <maml:para>Thin provisioning savings for volumes in the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snapcoll_count</maml:name> <maml:description> <maml:para>Snapshot collection count.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_count</maml:name> <maml:description> <maml:para>Snapshot count.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_count</maml:name> <maml:description> <maml:para>Number of arrays in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_count</maml:name> <maml:description> <maml:para>Number of volumes assigned to the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_list</maml:name> <maml:description> <maml:para>List of arrays in the pool with detailed information. When create/update array list, only arrays' ID is required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>unassigned_array_list</maml:name> <maml:description> <maml:para>List of arrays being unassigned from the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_list</maml:name> <maml:description> <maml:para>The list of volumes in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pinned_vol_list</maml:name> <maml:description> <maml:para>The list of pinned volumes in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folder_list</maml:name> <maml:description> <maml:para>The list of fully qualified names of folders in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified pool even if it contains deleted volumes whose space is being reclaimed. Forcibly remove an array from array_list via an update operation even if the array is not reachable. There should no volumes currently in the pool for the forced update operation to succeed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicates whether the usage of pool is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>uncompressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of volumes in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>uncompressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of snapshots in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>all_flash</maml:name> <maml:description> <maml:para>Indicate whether the pool is an all_flash pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_capable</maml:name> <maml:description> <maml:para>Indicates whether the pool is capable of hosting deduped volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_all_volumes_capable</maml:name> <maml:description> <maml:para>Indicates whether the pool can enable dedupe by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_all_volumes</maml:name> <maml:description> <maml:para>Indicates if dedupe is enabled by default for new volumes on this pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_default</maml:name> <maml:description> <maml:para>Indicates if this is the default pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of pool used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this pool was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this pool was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>capacity</maml:name> <maml:description> <maml:para>Total storage space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage</maml:name> <maml:description> <maml:para>Used space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings</maml:name> <maml:description> <maml:para>Overall space usage savings in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_data_reduction</maml:name> <maml:description> <maml:para>Space usage savings in the pool that does not include thin-provisioning savings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_compression</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to compression.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_dedupe</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to deduplication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_clone</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to cloning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_vol_thin_provisioning</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to thin provisioning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>reserve</maml:name> <maml:description> <maml:para>Reserved space of the pool in bytes. Sum of volume reserve in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>unused_reserve</maml:name> <maml:description> <maml:para>Unused reserve space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>free_space</maml:name> <maml:description> <maml:para>Free space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache_capacity</maml:name> <maml:description> <maml:para>Total usable cache capacity of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pinnable_cache_capacity</maml:name> <maml:description> <maml:para>Total pinnable cache capacity of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pinned_cache_capacity</maml:name> <maml:description> <maml:para>Total pinned cache capacity of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_capacity_bytes</maml:name> <maml:description> <maml:para>The dedupe capacity of a hybrid pool. Does not apply to all-flash pools.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_usage_bytes</maml:name> <maml:description> <maml:para>The dedupe usage of a hybrid pool. Does not apply to all-flash pools.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_ratio</maml:name> <maml:description> <maml:para>Overall space usage savings in the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>data_reduction_ratio</maml:name> <maml:description> <maml:para>Space usage savings in the pool expressed as ratio that does not include thin-provisioning savings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compression_ratio</maml:name> <maml:description> <maml:para>Compression savings for the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_ratio</maml:name> <maml:description> <maml:para>Dedupe savings for the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>clone_ratio</maml:name> <maml:description> <maml:para>Clone savings for the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_thin_provisioning_ratio</maml:name> <maml:description> <maml:para>Thin provisioning savings for volumes in the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snapcoll_count</maml:name> <maml:description> <maml:para>Snapshot collection count.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_count</maml:name> <maml:description> <maml:para>Snapshot count.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>array_count</maml:name> <maml:description> <maml:para>Number of arrays in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_count</maml:name> <maml:description> <maml:para>Number of volumes assigned to the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>array_list</maml:name> <maml:description> <maml:para>List of arrays in the pool with detailed information. When create/update array list, only arrays' ID is required.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>unassigned_array_list</maml:name> <maml:description> <maml:para>List of arrays being unassigned from the pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_list</maml:name> <maml:description> <maml:para>The list of volumes in the pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pinned_vol_list</maml:name> <maml:description> <maml:para>The list of pinned volumes in the pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>folder_list</maml:name> <maml:description> <maml:para>The list of fully qualified names of folders in the pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified pool even if it contains deleted volumes whose space is being reclaimed. Forcibly remove an array from array_list via an update operation even if the array is not reachable. There should no volumes currently in the pool for the forced update operation to succeed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicates whether the usage of pool is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>uncompressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of volumes in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>uncompressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of snapshots in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>all_flash</maml:name> <maml:description> <maml:para>Indicate whether the pool is an all_flash pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_capable</maml:name> <maml:description> <maml:para>Indicates whether the pool is capable of hosting deduped volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_all_volumes_capable</maml:name> <maml:description> <maml:para>Indicates whether the pool can enable dedupe by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_all_volumes</maml:name> <maml:description> <maml:para>Indicates if dedupe is enabled by default for new volumes on this pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_default</maml:name> <maml:description> <maml:para>Indicates if this is the default pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Set-NSPool -id 0a1bde905fd66eed40000000000000000000000003 -description My New Description no.499 name id capacity free_space cache_capacity snap_count vol_count description ---- -- -------- ---------- -------------- ---------- --------- ----------- MyPool1 0a1bde905fd66eed40000000000000000000000003 22875399783 22875399783 13432258560 0 0 My New Description no.499 </dev:code> <dev:remarks> <maml:para>This command will modify the description for the pool specified by id. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSPool</command:name> <maml:description> <maml:para>Deletes a pool with the given ID.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSPool</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Deletes a pool with the given ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of pool used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this pool was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this pool was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>capacity</maml:name> <maml:description> <maml:para>Total storage space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage</maml:name> <maml:description> <maml:para>Used space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings</maml:name> <maml:description> <maml:para>Overall space usage savings in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_data_reduction</maml:name> <maml:description> <maml:para>Space usage savings in the pool that does not include thin-provisioning savings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_compression</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to compression.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_dedupe</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to deduplication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_clone</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to cloning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_vol_thin_provisioning</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to thin provisioning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>reserve</maml:name> <maml:description> <maml:para>Reserved space of the pool in bytes. Sum of volume reserve in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>unused_reserve</maml:name> <maml:description> <maml:para>Unused reserve space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>free_space</maml:name> <maml:description> <maml:para>Free space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache_capacity</maml:name> <maml:description> <maml:para>Total usable cache capacity of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pinnable_cache_capacity</maml:name> <maml:description> <maml:para>Total pinnable cache capacity of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pinned_cache_capacity</maml:name> <maml:description> <maml:para>Total pinned cache capacity of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_capacity_bytes</maml:name> <maml:description> <maml:para>The dedupe capacity of a hybrid pool. Does not apply to all-flash pools.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_usage_bytes</maml:name> <maml:description> <maml:para>The dedupe usage of a hybrid pool. Does not apply to all-flash pools.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_ratio</maml:name> <maml:description> <maml:para>Overall space usage savings in the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>data_reduction_ratio</maml:name> <maml:description> <maml:para>Space usage savings in the pool expressed as ratio that does not include thin-provisioning savings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compression_ratio</maml:name> <maml:description> <maml:para>Compression savings for the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_ratio</maml:name> <maml:description> <maml:para>Dedupe savings for the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>clone_ratio</maml:name> <maml:description> <maml:para>Clone savings for the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_thin_provisioning_ratio</maml:name> <maml:description> <maml:para>Thin provisioning savings for volumes in the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snapcoll_count</maml:name> <maml:description> <maml:para>Snapshot collection count.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_count</maml:name> <maml:description> <maml:para>Snapshot count.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_count</maml:name> <maml:description> <maml:para>Number of arrays in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_count</maml:name> <maml:description> <maml:para>Number of volumes assigned to the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_list</maml:name> <maml:description> <maml:para>List of arrays in the pool with detailed information. When create/update array list, only arrays' ID is required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>unassigned_array_list</maml:name> <maml:description> <maml:para>List of arrays being unassigned from the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_list</maml:name> <maml:description> <maml:para>The list of volumes in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pinned_vol_list</maml:name> <maml:description> <maml:para>The list of pinned volumes in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folder_list</maml:name> <maml:description> <maml:para>The list of fully qualified names of folders in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified pool even if it contains deleted volumes whose space is being reclaimed. Forcibly remove an array from array_list via an update operation even if the array is not reachable. There should no volumes currently in the pool for the forced update operation to succeed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicates whether the usage of pool is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>uncompressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of volumes in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>uncompressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of snapshots in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>all_flash</maml:name> <maml:description> <maml:para>Indicate whether the pool is an all_flash pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_capable</maml:name> <maml:description> <maml:para>Indicates whether the pool is capable of hosting deduped volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_all_volumes_capable</maml:name> <maml:description> <maml:para>Indicates whether the pool can enable dedupe by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_all_volumes</maml:name> <maml:description> <maml:para>Indicates if dedupe is enabled by default for new volumes on this pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_default</maml:name> <maml:description> <maml:para>Indicates if this is the default pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of pool used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this pool was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this pool was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>capacity</maml:name> <maml:description> <maml:para>Total storage space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage</maml:name> <maml:description> <maml:para>Used space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings</maml:name> <maml:description> <maml:para>Overall space usage savings in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_data_reduction</maml:name> <maml:description> <maml:para>Space usage savings in the pool that does not include thin-provisioning savings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_compression</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to compression.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_dedupe</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to deduplication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_clone</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to cloning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_vol_thin_provisioning</maml:name> <maml:description> <maml:para>Space usage savings in the pool due to thin provisioning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>reserve</maml:name> <maml:description> <maml:para>Reserved space of the pool in bytes. Sum of volume reserve in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>unused_reserve</maml:name> <maml:description> <maml:para>Unused reserve space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>free_space</maml:name> <maml:description> <maml:para>Free space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache_capacity</maml:name> <maml:description> <maml:para>Total usable cache capacity of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pinnable_cache_capacity</maml:name> <maml:description> <maml:para>Total pinnable cache capacity of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pinned_cache_capacity</maml:name> <maml:description> <maml:para>Total pinned cache capacity of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_capacity_bytes</maml:name> <maml:description> <maml:para>The dedupe capacity of a hybrid pool. Does not apply to all-flash pools.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_usage_bytes</maml:name> <maml:description> <maml:para>The dedupe usage of a hybrid pool. Does not apply to all-flash pools.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_ratio</maml:name> <maml:description> <maml:para>Overall space usage savings in the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>data_reduction_ratio</maml:name> <maml:description> <maml:para>Space usage savings in the pool expressed as ratio that does not include thin-provisioning savings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compression_ratio</maml:name> <maml:description> <maml:para>Compression savings for the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_ratio</maml:name> <maml:description> <maml:para>Dedupe savings for the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>clone_ratio</maml:name> <maml:description> <maml:para>Clone savings for the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_thin_provisioning_ratio</maml:name> <maml:description> <maml:para>Thin provisioning savings for volumes in the pool expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snapcoll_count</maml:name> <maml:description> <maml:para>Snapshot collection count.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_count</maml:name> <maml:description> <maml:para>Snapshot count.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>array_count</maml:name> <maml:description> <maml:para>Number of arrays in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_count</maml:name> <maml:description> <maml:para>Number of volumes assigned to the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>array_list</maml:name> <maml:description> <maml:para>List of arrays in the pool with detailed information. When create/update array list, only arrays' ID is required.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>unassigned_array_list</maml:name> <maml:description> <maml:para>List of arrays being unassigned from the pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_list</maml:name> <maml:description> <maml:para>The list of volumes in the pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pinned_vol_list</maml:name> <maml:description> <maml:para>The list of pinned volumes in the pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>folder_list</maml:name> <maml:description> <maml:para>The list of fully qualified names of folders in the pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified pool even if it contains deleted volumes whose space is being reclaimed. Forcibly remove an array from array_list via an update operation even if the array is not reachable. There should no volumes currently in the pool for the forced update operation to succeed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicates whether the usage of pool is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>uncompressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of volumes in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>uncompressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of snapshots in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>all_flash</maml:name> <maml:description> <maml:para>Indicate whether the pool is an all_flash pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_capable</maml:name> <maml:description> <maml:para>Indicates whether the pool is capable of hosting deduped volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_all_volumes_capable</maml:name> <maml:description> <maml:para>Indicates whether the pool can enable dedupe by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_all_volumes</maml:name> <maml:description> <maml:para>Indicates if dedupe is enabled by default for new volumes on this pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_default</maml:name> <maml:description> <maml:para>Indicates if this is the default pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Merge-NSPool</command:name> <maml:description> <maml:para>Merge the specified pool into the target pool. All volumes on the specified pool are moved to the target pool and the specified pool is then deleted. All the arrays in the pool are assigned to the target pool.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Merge</command:verb> <command:noun>-NSPool</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Merge the specified pool into the target pool. All volumes on the specified pool are moved to the target pool and the specified pool is then deleted. All the arrays in the pool are assigned to the target pool.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Merge-NSPool</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the specified pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Merge-NSPool</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>target_pool_id</maml:name> <maml:description> <maml:para>ID of the target pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Merge-NSPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly merge the specified pool into target pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the specified pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>target_pool_id</maml:name> <maml:description> <maml:para>ID of the target pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly merge the specified pool into target pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-NSPoolDeDupe</command:name> <maml:description> <maml:para>Set dedupe enabled/disabled for all applicable volumes inside a pool.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invok</command:verb> <command:noun>-NSPoolDeDupe</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Set dedupe enabled/disabled for all applicable volumes inside a pool.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-NSPoolDeDupe</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_enabled</maml:name> <maml:description> <maml:para>Enable/disable dedupe.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-NSPoolDeDupe</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Pool containing the volumes to enable/disable dedupe on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_enabled</maml:name> <maml:description> <maml:para>Enable/disable dedupe.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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>id</maml:name> <maml:description> <maml:para>Pool containing the volumes to enable/disable dedupe on.</maml:para> </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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSProtectionTemplate</command:name> <maml:description> <maml:para>Create a protection template with given attributes.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSProtectionTemplate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Create a protection template with given attributes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for protection template.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionTemplate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>User provided identifier.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of protection template.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of protection template used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of protection template.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_priority</maml:name> <maml:description> <maml:para>Replication priority for the protection template with the following choices: {normal | high}.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_sync</maml:name> <maml:description> <maml:para>Application synchronization ({none|vss|vmware|generic}).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_server</maml:name> <maml:description> <maml:para>Application server hostname.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_id</maml:name> <maml:description> <maml:para>Application ID running on the server. Application ID can only be specified if application synchronization is VSS.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_cluster_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment then this is the cluster name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_service_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment then this is the instance name of the service running within the cluster environment.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vcenter_hostname</maml:name> <maml:description> <maml:para>VMware vCenter hostname. Custom port number can be specified with vCenter hostname using :.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vcenter_username</maml:name> <maml:description> <maml:para>VMware vCenter username.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vcenter_password</maml:name> <maml:description> <maml:para>VMware vCenter password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_hostname</maml:name> <maml:description> <maml:para>Generic Backup agent hostname. Custom port number can be specified with agent hostname using \\":\\".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_username</maml:name> <maml:description> <maml:para>Generic Backup agent username.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_password</maml:name> <maml:description> <maml:para>Generic Backup agent password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this protection template was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this protection template was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>schedule_list</maml:name> <maml:description> <maml:para>List of schedules for this protection policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for protection template.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>User provided identifier.</maml:para> </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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of protection template.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of protection template used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of protection template.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>repl_priority</maml:name> <maml:description> <maml:para>Replication priority for the protection template with the following choices: {normal | high}.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_sync</maml:name> <maml:description> <maml:para>Application synchronization ({none|vss|vmware|generic}).</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_server</maml:name> <maml:description> <maml:para>Application server hostname.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_id</maml:name> <maml:description> <maml:para>Application ID running on the server. Application ID can only be specified if application synchronization is VSS.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_cluster_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment then this is the cluster name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_service_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment then this is the instance name of the service running within the cluster environment.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vcenter_hostname</maml:name> <maml:description> <maml:para>VMware vCenter hostname. Custom port number can be specified with vCenter hostname using :.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vcenter_username</maml:name> <maml:description> <maml:para>VMware vCenter username.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vcenter_password</maml:name> <maml:description> <maml:para>VMware vCenter password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_hostname</maml:name> <maml:description> <maml:para>Generic Backup agent hostname. Custom port number can be specified with agent hostname using \\":\\".</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_username</maml:name> <maml:description> <maml:para>Generic Backup agent username.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_password</maml:name> <maml:description> <maml:para>Generic Backup agent password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this protection template was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this protection template was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>schedule_list</maml:name> <maml:description> <maml:para>List of schedules for this protection policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> New-NSProtectionTemplate -name test2 agent_hostname : agent_password : agent_username : app_cluster_name : app_id : app_server : app_service_name : app_sync : none creation_time : 1533274196 description : full_name : test2 id : 1228eada7f8dd99d3b00000000000000000000009c last_modified : 1533274196 name : test2 repl_priority : normal schedule_list : search_name : test2 vcenter_hostname : vcenter_username : </dev:code> <dev:remarks> <maml:para>This command creates a new Protection Template. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSProtectionTemplate</command:name> <maml:description> <maml:para>Read a set of protection templates or a single template.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSProtectionTemplate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Read a set of protection templates or a single template.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for protection template.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>User provided identifier.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of protection template.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of protection template used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of protection template.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_priority</maml:name> <maml:description> <maml:para>Replication priority for the protection template with the following choices: {normal | high}.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_sync</maml:name> <maml:description> <maml:para>Application synchronization ({none|vss|vmware|generic}).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_server</maml:name> <maml:description> <maml:para>Application server hostname.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_id</maml:name> <maml:description> <maml:para>Application ID running on the server. Application ID can only be specified if application synchronization is VSS.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_cluster_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment then this is the cluster name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_service_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment then this is the instance name of the service running within the cluster environment.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vcenter_hostname</maml:name> <maml:description> <maml:para>VMware vCenter hostname. Custom port number can be specified with vCenter hostname using :.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vcenter_username</maml:name> <maml:description> <maml:para>VMware vCenter username.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vcenter_password</maml:name> <maml:description> <maml:para>VMware vCenter password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_hostname</maml:name> <maml:description> <maml:para>Generic Backup agent hostname. Custom port number can be specified with agent hostname using \\":\\".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_username</maml:name> <maml:description> <maml:para>Generic Backup agent username.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_password</maml:name> <maml:description> <maml:para>Generic Backup agent password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this protection template was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this protection template was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>schedule_list</maml:name> <maml:description> <maml:para>List of schedules for this protection policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for protection template.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>User provided identifier.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of protection template.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of protection template used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of protection template.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>repl_priority</maml:name> <maml:description> <maml:para>Replication priority for the protection template with the following choices: {normal | high}.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_sync</maml:name> <maml:description> <maml:para>Application synchronization ({none|vss|vmware|generic}).</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_server</maml:name> <maml:description> <maml:para>Application server hostname.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_id</maml:name> <maml:description> <maml:para>Application ID running on the server. Application ID can only be specified if application synchronization is VSS.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_cluster_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment then this is the cluster name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_service_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment then this is the instance name of the service running within the cluster environment.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vcenter_hostname</maml:name> <maml:description> <maml:para>VMware vCenter hostname. Custom port number can be specified with vCenter hostname using :.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vcenter_username</maml:name> <maml:description> <maml:para>VMware vCenter username.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vcenter_password</maml:name> <maml:description> <maml:para>VMware vCenter password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_hostname</maml:name> <maml:description> <maml:para>Generic Backup agent hostname. Custom port number can be specified with agent hostname using \\":\\".</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_username</maml:name> <maml:description> <maml:para>Generic Backup agent username.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_password</maml:name> <maml:description> <maml:para>Generic Backup agent password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this protection template was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this protection template was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>schedule_list</maml:name> <maml:description> <maml:para>List of schedules for this protection policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSProtectionTemplate agent_hostname : agent_password : agent_username : app_cluster_name : app_id : app_server : app_service_name : app_sync : none creation_time : 0 description : Provides daily snapshots retained for 30 days full_name : Retain-30Daily id : 1228eada7f8dd99d3b000000000000000000000001 last_modified : 0 name : Retain-30Daily repl_priority : normal schedule_list : {@{at_time=0; days=all; disable_appsync=False; downstream_partner=; downstream_partner_id=; downstream_partner_name=; id=0c28eada7f8dd99d3b000000000000000000000001; name=daily; num_retain=30; num_retain_replica=1; period=1; period_unit=days; repl_alert_thres=86400; replicate_every=0; schedule_id=0c28eada7f8dd99d3b000000000000000000000001; schedule_name=daily; schedule_type=regular; skip_db_consistency_check=False; snap_verify=False; until_time=86399}} search_name : Retain-30Daily vcenter_hostname : vcenter_username : agent_hostname : agent_password : agent_username : app_cluster_name : app_id : app_server : app_service_name : app_sync : none creation_time : 0 description : Provides daily snapshots retained for 90 days full_name : Retain-90Daily id : 1228eada7f8dd99d3b000000000000000000000002 last_modified : 0 name : Retain-90Daily repl_priority : normal schedule_list : {@{at_time=0; days=all; disable_appsync=False; downstream_partner=; downstream_partner_id=; downstream_partner_name=; id=0c28eada7f8dd99d3b000000000000000000000002; name=daily; num_retain=90; num_retain_replica=1; period=1; period_unit=days; repl_alert_thres=86400; replicate_every=0; schedule_id=0c28eada7f8dd99d3b000000000000000000000002; schedule_name=daily; schedule_type=regular; skip_db_consistency_check=False; snap_verify=False; until_time=86399}} search_name : Retain-90Daily vcenter_hostname : vcenter_username : </dev:code> <dev:remarks> <maml:para>This command will retrieve the Protection Template from the array. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 2 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSProtectionTemplate -name Retain-90Daily agent_hostname : agent_password : agent_username : app_cluster_name : app_id : app_server : app_service_name : app_sync : none creation_time : 0 description : Provides daily snapshots retained for 90 days full_name : Retain-90Daily id : 1228eada7f8dd99d3b000000000000000000000002 last_modified : 0 name : Retain-90Daily repl_priority : normal schedule_list : {@{at_time=0; days=all; disable_appsync=False; downstream_partner=; downstream_partner_id=; downstream_partner_name=; id=0c28eada7f8dd99d3b000000000000000000000002; name=daily; num_retain=90; num_retain_replica=1; period=1; period_unit=days; repl_alert_thres=86400; replicate_every=0; schedule_id=0c28eada7f8dd99d3b000000000000000000000002; schedule_name=daily; schedule_type=regular; skip_db_consistency_check=False; snap_verify=False; until_time=86399}} search_name : Retain-90Daily vcenter_hostname : vcenter_username : </dev:code> <dev:remarks> <maml:para>This command will retrieve a specific Protection Template from the array by name. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSProtectionTemplate</command:name> <maml:description> <maml:para>Modify protection templates.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSProtectionTemplate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Modify protection templates.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSProtectionTemplate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for protection template.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>User provided identifier.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of protection template.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of protection template used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of protection template.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_priority</maml:name> <maml:description> <maml:para>Replication priority for the protection template with the following choices: {normal | high}.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_sync</maml:name> <maml:description> <maml:para>Application synchronization ({none|vss|vmware|generic}).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_server</maml:name> <maml:description> <maml:para>Application server hostname.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_id</maml:name> <maml:description> <maml:para>Application ID running on the server. Application ID can only be specified if application synchronization is VSS.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_cluster_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment then this is the cluster name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_service_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment then this is the instance name of the service running within the cluster environment.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vcenter_hostname</maml:name> <maml:description> <maml:para>VMware vCenter hostname. Custom port number can be specified with vCenter hostname using :.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vcenter_username</maml:name> <maml:description> <maml:para>VMware vCenter username.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vcenter_password</maml:name> <maml:description> <maml:para>VMware vCenter password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_hostname</maml:name> <maml:description> <maml:para>Generic Backup agent hostname. Custom port number can be specified with agent hostname using \\":\\".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_username</maml:name> <maml:description> <maml:para>Generic Backup agent username.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_password</maml:name> <maml:description> <maml:para>Generic Backup agent password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this protection template was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this protection template was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>schedule_list</maml:name> <maml:description> <maml:para>List of schedules for this protection policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for protection template.</maml:para> </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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>User provided identifier.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of protection template.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of protection template used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of protection template.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>repl_priority</maml:name> <maml:description> <maml:para>Replication priority for the protection template with the following choices: {normal | high}.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_sync</maml:name> <maml:description> <maml:para>Application synchronization ({none|vss|vmware|generic}).</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_server</maml:name> <maml:description> <maml:para>Application server hostname.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_id</maml:name> <maml:description> <maml:para>Application ID running on the server. Application ID can only be specified if application synchronization is VSS.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_cluster_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment then this is the cluster name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_service_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment then this is the instance name of the service running within the cluster environment.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vcenter_hostname</maml:name> <maml:description> <maml:para>VMware vCenter hostname. Custom port number can be specified with vCenter hostname using :.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vcenter_username</maml:name> <maml:description> <maml:para>VMware vCenter username.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vcenter_password</maml:name> <maml:description> <maml:para>VMware vCenter password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_hostname</maml:name> <maml:description> <maml:para>Generic Backup agent hostname. Custom port number can be specified with agent hostname using \\":\\".</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_username</maml:name> <maml:description> <maml:para>Generic Backup agent username.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_password</maml:name> <maml:description> <maml:para>Generic Backup agent password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this protection template was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this protection template was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>schedule_list</maml:name> <maml:description> <maml:para>List of schedules for this protection policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Set-NSProtectionTemplate -id 1228eada7f8dd99d3b00000000000000000000009c -description "My Test Template" agent_hostname : agent_password : agent_username : app_cluster_name : app_id : app_server : app_service_name : app_sync : none creation_time : 1533274196 description : My Test Template full_name : test2 id : 1228eada7f8dd99d3b00000000000000000000009c last_modified : 1533274196 name : test2 repl_priority : normal schedule_list : search_name : test2 vcenter_hostname : vcenter_username : </dev:code> <dev:remarks> <maml:para>This command updates the given property of a given Protection Template. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSProtectionTemplate</command:name> <maml:description> <maml:para>Delete protection templates.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSProtectionTemplate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Delete protection templates.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for protection template.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>User provided identifier.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of protection template.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of protection template used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of protection template.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_priority</maml:name> <maml:description> <maml:para>Replication priority for the protection template with the following choices: {normal | high}.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_sync</maml:name> <maml:description> <maml:para>Application synchronization ({none|vss|vmware|generic}).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_server</maml:name> <maml:description> <maml:para>Application server hostname.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_id</maml:name> <maml:description> <maml:para>Application ID running on the server. Application ID can only be specified if application synchronization is VSS.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_cluster_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment then this is the cluster name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_service_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment then this is the instance name of the service running within the cluster environment.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vcenter_hostname</maml:name> <maml:description> <maml:para>VMware vCenter hostname. Custom port number can be specified with vCenter hostname using :.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vcenter_username</maml:name> <maml:description> <maml:para>VMware vCenter username.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vcenter_password</maml:name> <maml:description> <maml:para>VMware vCenter password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_hostname</maml:name> <maml:description> <maml:para>Generic Backup agent hostname. Custom port number can be specified with agent hostname using \\":\\".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_username</maml:name> <maml:description> <maml:para>Generic Backup agent username.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_password</maml:name> <maml:description> <maml:para>Generic Backup agent password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this protection template was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this protection template was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionTemplate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>schedule_list</maml:name> <maml:description> <maml:para>List of schedules for this protection policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for protection template.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>User provided identifier.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of protection template.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of protection template used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of protection template.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>repl_priority</maml:name> <maml:description> <maml:para>Replication priority for the protection template with the following choices: {normal | high}.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_sync</maml:name> <maml:description> <maml:para>Application synchronization ({none|vss|vmware|generic}).</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_server</maml:name> <maml:description> <maml:para>Application server hostname.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_id</maml:name> <maml:description> <maml:para>Application ID running on the server. Application ID can only be specified if application synchronization is VSS.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_cluster_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment then this is the cluster name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_service_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment then this is the instance name of the service running within the cluster environment.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vcenter_hostname</maml:name> <maml:description> <maml:para>VMware vCenter hostname. Custom port number can be specified with vCenter hostname using :.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vcenter_username</maml:name> <maml:description> <maml:para>VMware vCenter username.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vcenter_password</maml:name> <maml:description> <maml:para>VMware vCenter password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_hostname</maml:name> <maml:description> <maml:para>Generic Backup agent hostname. Custom port number can be specified with agent hostname using \\":\\".</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_username</maml:name> <maml:description> <maml:para>Generic Backup agent username.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_password</maml:name> <maml:description> <maml:para>Generic Backup agent password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this protection template was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this protection template was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>schedule_list</maml:name> <maml:description> <maml:para>List of schedules for this protection policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Remove-NSProtectionTemplate -id 1228eada7f8dd99d3b00000000000000000000009c </dev:code> <dev:remarks> <maml:para>This command will remove a Protection Template specified by its ID. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSVolume</command:name> <maml:description> <maml:para>Create operation is used to create or clone a volume. Creating volumes requires name and size attributes. Cloning volumes requires clone, name and base_snap_id attributes where clone is set to true. Newly created volume will not have any access control records, they can be added to the volume by create operation on access_control_records object set. Cloned volume inherits access control records from the parent volume.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSVolume</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Create operation is used to create or clone a volume. Creating volumes requires name and size attributes. Cloning volumes requires clone, name and base_snap_id attributes where clone is set to true. Newly created volume will not have any access control records, they can be added to the volume by create operation on access_control_records object set. Cloned volume inherits access control records from the parent volume.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of volume used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>size</maml:name> <maml:description> <maml:para>Volume size in mebibytes. Size is required for creating a volume but not for cloning an existing volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>perfpolicy_name</maml:name> <maml:description> <maml:para>Name of performance policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>perfpolicy_id</maml:name> <maml:description> <maml:para>Identifier of the performance policy. After creating a volume, performance policy for the volume can only be changed to another performance policy with same block size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>reserve</maml:name> <maml:description> <maml:para>Amount of space to reserve for this volume as a percentage of volume size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>warn_level</maml:name> <maml:description> <maml:para>This attribute is deprecated. Alert threshold for the volume's mapped usage, expressed as a percentage of the volume's size. When the volume's mapped usage exceeds warn_level, the array issues an alert. If this option is not specified, array default volume warn level setting is used to decide the warning level for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit</maml:name> <maml:description> <maml:para>Limit on the volume's mapped usage, expressed as a percentage of the volume's size. When the volume's mapped usage exceeds limit, the volume will be offlined or made non-writable. If this option is not specified, array default volume limit setting is used to decide the limit for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_reserve</maml:name> <maml:description> <maml:para>Amount of space to reserve for snapshots of this volume as a percentage of volume size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_warn_level</maml:name> <maml:description> <maml:para>Threshold for available space as a percentage of volume size below which an alert is raised.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_limit</maml:name> <maml:description> <maml:para>This attribute is deprecated. The array does not limit a volume's snapshot space usage. The attribute is ignored on input and returns max int64 on output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_limit_percent</maml:name> <maml:description> <maml:para>This attribute is deprecated. The array does not limit a volume's snapshot space usage. The attribute is ignored on input and returns -1 on output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Number of live, non-hidden snapshots for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>projected_num_snaps</maml:name> <maml:description> <maml:para>Deprecated. Projected number of snapshots (including scheduled and manual) for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>online</maml:name> <maml:description> <maml:para>Online state of volume, available for host initiators to establish connections.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>owned_by_group</maml:name> <maml:description> <maml:para>Name of group that currently owns the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>owned_by_group_id</maml:name> <maml:description> <maml:para>ID of group that currently owns the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>multi_initiator</maml:name> <maml:description> <maml:para>For iSCSI Volume Target, this flag indicates whether the volume and its snapshots can be accessed from multiple initiators at the same time. The default is false. For iSCSI Group Target or FC access protocol, the attribute cannot be modified and always reads as false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_target_scope</maml:name> <maml:description> <maml:para>This indicates whether volume is exported under iSCSI Group Target or iSCSI Volume Target. This attribute is only meaningful to iSCSI system. On FC system, all volumes are exported under the FC Group Target. In create operation, the volume's target type will be set by this attribute. If not specified, it will be set as the group-setting. In clone operation, the clone's target type will inherit from the parent' setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool where the volume resides. Volume data will be distributed across arrays over which specified pool is defined. If pool option is not specified, volume is assigned to the default pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>Identifier associated with the pool in the storage pool table.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>read_only</maml:name> <maml:description> <maml:para>Volume is read-only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>serial_number</maml:name> <maml:description> <maml:para>Identifier associated with the volume for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>secondary_serial_number</maml:name> <maml:description> <maml:para>Secondary identifier associated with the volume for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>target_name</maml:name> <maml:description> <maml:para>The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>block_size</maml:name> <maml:description> <maml:para>Size in bytes of blocks in the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>offline_reason</maml:name> <maml:description> <maml:para>Volume offline reason.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>clone</maml:name> <maml:description> <maml:para>Whether this volume is a clone. Use this attribute in combination with name and base_snap_id to create a clone by setting clone = true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>parent_vol_name</maml:name> <maml:description> <maml:para>Name of parent volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>parent_vol_id</maml:name> <maml:description> <maml:para>Parent volume ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>base_snap_name</maml:name> <maml:description> <maml:para>Name of base snapshot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>base_snap_id</maml:name> <maml:description> <maml:para>Base snapshot ID. This attribute is required together with name and clone when cloning a volume with the create operation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replication_role</maml:name> <maml:description> <maml:para>Replication role that this volume performs.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volcoll_name</maml:name> <maml:description> <maml:para>Name of volume collection of which this volume is a member.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volcoll_id</maml:name> <maml:description> <maml:para>ID of volume collection of which this volume is a member. Use this attribute in update operation to associate or dissociate volumes with or from volume collections. When associating, set this attribute to the ID of the volume collection. When dissociating, set this attribute to empty string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly offline, reduce size or change read-only status a volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this volume was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this volume was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>protection_type</maml:name> <maml:description> <maml:para>Specifies if volume is protected with schedules. If protected, indicate whether replication is setup.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_snap</maml:name> <maml:description> <maml:para>Last snapshot for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_replicated_snap</maml:name> <maml:description> <maml:para>Last replicated snapshot for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dest_pool_name</maml:name> <maml:description> <maml:para>Name of the destination pool where the volume is moving to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dest_pool_id</maml:name> <maml:description> <maml:para>ID of the destination pool where the volume is moving to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>move_start_time</maml:name> <maml:description> <maml:para>The Start time when this volume was moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>move_aborting</maml:name> <maml:description> <maml:para>This indicates whether the move of the volume is aborting or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>move_bytes_migrated</maml:name> <maml:description> <maml:para>The bytes of volume which have been moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>move_bytes_remaining</maml:name> <maml:description> <maml:para>The bytes of volume which have not been moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>move_est_compl_time</maml:name> <maml:description> <maml:para>The estimated time of completion of a move.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>This indicates whether usage information of volume and snapshots are valid or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>space_usage_level</maml:name> <maml:description> <maml:para>Indicates space usage level based on warning level.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>total_usage_bytes</maml:name> <maml:description> <maml:para>Sum of volume mapped usage and uncompressed backup data(including pending deletes) in bytes of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_usage_compressed_bytes</maml:name> <maml:description> <maml:para>Compressed data in bytes for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>Uncompressed data in bytes for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_usage_mapped_bytes</maml:name> <maml:description> <maml:para>Mapped data in bytes for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_usage_compressed_bytes</maml:name> <maml:description> <maml:para>Sum of compressed backup data in bytes stored in snapshots of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>Sum of uncompressed unique backup data in bytes stored in snapshots of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_usage_populated_bytes</maml:name> <maml:description> <maml:para>Sum of backup data in bytes stored in snapshots of this volume without accounting for the sharing of data between snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache_pinned</maml:name> <maml:description> <maml:para>If set to true, all the contents of this volume are kept in flash cache. This provides for consistent performance guarantees for all types of workloads. The amount of flash needed to pin the volume is equal to the limit for the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pinned_cache_size</maml:name> <maml:description> <maml:para>The amount of flash pinned on the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache_needed_for_pin</maml:name> <maml:description> <maml:para>The amount of flash needed to pin the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>upstream_cache_pinned</maml:name> <maml:description> <maml:para>This indicates whether the upstream volume is cache pinned or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache_policy</maml:name> <maml:description> <maml:para>Cache policy applied to the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>thinly_provisioned</maml:name> <maml:description> <maml:para>Set volume's provisioning level to thin. Also advertises volume as thinly provisioned to initiators supporting thin provisioning. For such volumes, soft limit notification is set to initiators when the volume space usage crosses its volume_warn_level. Default is yes. The volume's space is provisioned immediately, but for advertising status, this change takes effect only for new connections to the volume. Initiators must disconnect and reconnect for the new setting to be take effect at the initiator level consistently.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_state</maml:name> <maml:description> <maml:para>Status of the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>online_snaps</maml:name> <maml:description> <maml:para>The list of online snapshots of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_connections</maml:name> <maml:description> <maml:para>Number of connections of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_iscsi_connections</maml:name> <maml:description> <maml:para>Number of iscsi connections of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_fc_connections</maml:name> <maml:description> <maml:para>Number of Fibre Channel connections of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_control_records</maml:name> <maml:description> <maml:para>List of access control records that apply to this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>inherit_acl</maml:name> <maml:description> <maml:para>In a volume clone operation, if both the parent and the clone have no external management agent (their agent_type property is "none"), then inherit_acl controls whether the clone will inherit a copy of the parent's access control list. If either the parent or the clone have an external management agent, then the clone will not inherit the parent's access control list.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>encryption_cipher</maml:name> <maml:description> <maml:para>The encryption cipher of the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folder_id</maml:name> <maml:description> <maml:para>ID of the folder holding this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folder_name</maml:name> <maml:description> <maml:para>Name of the folder holding this volume. It can be empty.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment an volume's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_sessions</maml:name> <maml:description> <maml:para>List of iSCSI sessions connected to this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fc_sessions</maml:name> <maml:description> <maml:para>List of Fibre Channel sessions connected to this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>caching_enabled</maml:name> <maml:description> <maml:para>Indicate caching the volume is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>previously_deduped</maml:name> <maml:description> <maml:para>Indicate whether dedupe has ever been enabled on this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_enabled</maml:name> <maml:description> <maml:para>Indicate whether dedupe is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vpd_t10</maml:name> <maml:description> <maml:para>The volume's T10 Vendor ID-based identifier.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vpd_ieee0</maml:name> <maml:description> <maml:para>The first 64 bits of the volume's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vpd_ieee1</maml:name> <maml:description> <maml:para>The last 64 bits of the volume's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_category</maml:name> <maml:description> <maml:para>Application category that the volume belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_iops</maml:name> <maml:description> <maml:para>IOPS limit for this volume. If limit_iops is not specified when a volume is created, or if limit_iops is set to -1, then the volume has no IOPS limit. If limit_iops is not specified while creating a clone, IOPS limit of parent volume will be used as limit. IOPS limit should be in range [256, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops <= ((limit_mbps MB/s * 2^20 B/MB) / block_size B).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_mbps</maml:name> <maml:description> <maml:para>Throughput limit for this volume in MB/s. If limit_mbps is not specified when a volume is created, or if limit_mbps is set to -1, then the volume has no MBPS limit. MBPS limit should be in range [1, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops <= ((limit_mbps MB/s * 2^20 B/MB) / block_size B).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>needs_content_repl</maml:name> <maml:description> <maml:para>Indicates whether the volume needs content based replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>content_repl_errors_found</maml:name> <maml:description> <maml:para>Indicates whether the last content based replication had errors.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_content_snap_br_cg_uid</maml:name> <maml:description> <maml:para>The branch cg uid of the content based snapshot that was last replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_content_snap_br_gid</maml:name> <maml:description> <maml:para>The branch gid of the content based snapshot that was last replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_content_snap_id</maml:name> <maml:description> <maml:para>The ID of the content based snapshot that was last replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cksum_last_verified</maml:name> <maml:description> <maml:para>Last checksum verification time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pre_filter</maml:name> <maml:description> <maml:para>Pre-filtering criteria.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>avg_stats_last_5mins</maml:name> <maml:description> <maml:para>Average statistics in last 5 minutes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>srep_last_sync</maml:name> <maml:description> <maml:para>Time when synchronously replicated volume was last synchronized.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>srep_resync_percent</maml:name> <maml:description> <maml:para>Percentage of resync progress for synchronously replicated volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the volume.</maml:para> </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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of volume used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>size</maml:name> <maml:description> <maml:para>Volume size in mebibytes. Size is required for creating a volume but not for cloning an existing volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>perfpolicy_name</maml:name> <maml:description> <maml:para>Name of performance policy.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>perfpolicy_id</maml:name> <maml:description> <maml:para>Identifier of the performance policy. After creating a volume, performance policy for the volume can only be changed to another performance policy with same block size.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>reserve</maml:name> <maml:description> <maml:para>Amount of space to reserve for this volume as a percentage of volume size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>warn_level</maml:name> <maml:description> <maml:para>This attribute is deprecated. Alert threshold for the volume's mapped usage, expressed as a percentage of the volume's size. When the volume's mapped usage exceeds warn_level, the array issues an alert. If this option is not specified, array default volume warn level setting is used to decide the warning level for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>limit</maml:name> <maml:description> <maml:para>Limit on the volume's mapped usage, expressed as a percentage of the volume's size. When the volume's mapped usage exceeds limit, the volume will be offlined or made non-writable. If this option is not specified, array default volume limit setting is used to decide the limit for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_reserve</maml:name> <maml:description> <maml:para>Amount of space to reserve for snapshots of this volume as a percentage of volume size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_warn_level</maml:name> <maml:description> <maml:para>Threshold for available space as a percentage of volume size below which an alert is raised.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_limit</maml:name> <maml:description> <maml:para>This attribute is deprecated. The array does not limit a volume's snapshot space usage. The attribute is ignored on input and returns max int64 on output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_limit_percent</maml:name> <maml:description> <maml:para>This attribute is deprecated. The array does not limit a volume's snapshot space usage. The attribute is ignored on input and returns -1 on output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Number of live, non-hidden snapshots for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>projected_num_snaps</maml:name> <maml:description> <maml:para>Deprecated. Projected number of snapshots (including scheduled and manual) for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>online</maml:name> <maml:description> <maml:para>Online state of volume, available for host initiators to establish connections.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>owned_by_group</maml:name> <maml:description> <maml:para>Name of group that currently owns the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>owned_by_group_id</maml:name> <maml:description> <maml:para>ID of group that currently owns the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>multi_initiator</maml:name> <maml:description> <maml:para>For iSCSI Volume Target, this flag indicates whether the volume and its snapshots can be accessed from multiple initiators at the same time. The default is false. For iSCSI Group Target or FC access protocol, the attribute cannot be modified and always reads as false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>iscsi_target_scope</maml:name> <maml:description> <maml:para>This indicates whether volume is exported under iSCSI Group Target or iSCSI Volume Target. This attribute is only meaningful to iSCSI system. On FC system, all volumes are exported under the FC Group Target. In create operation, the volume's target type will be set by this attribute. If not specified, it will be set as the group-setting. In clone operation, the clone's target type will inherit from the parent' setting.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool where the volume resides. Volume data will be distributed across arrays over which specified pool is defined. If pool option is not specified, volume is assigned to the default pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>Identifier associated with the pool in the storage pool table.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>read_only</maml:name> <maml:description> <maml:para>Volume is read-only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>serial_number</maml:name> <maml:description> <maml:para>Identifier associated with the volume for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>secondary_serial_number</maml:name> <maml:description> <maml:para>Secondary identifier associated with the volume for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>target_name</maml:name> <maml:description> <maml:para>The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>block_size</maml:name> <maml:description> <maml:para>Size in bytes of blocks in the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>offline_reason</maml:name> <maml:description> <maml:para>Volume offline reason.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>clone</maml:name> <maml:description> <maml:para>Whether this volume is a clone. Use this attribute in combination with name and base_snap_id to create a clone by setting clone = true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>parent_vol_name</maml:name> <maml:description> <maml:para>Name of parent volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>parent_vol_id</maml:name> <maml:description> <maml:para>Parent volume ID.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>base_snap_name</maml:name> <maml:description> <maml:para>Name of base snapshot.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>base_snap_id</maml:name> <maml:description> <maml:para>Base snapshot ID. This attribute is required together with name and clone when cloning a volume with the create operation.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>replication_role</maml:name> <maml:description> <maml:para>Replication role that this volume performs.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volcoll_name</maml:name> <maml:description> <maml:para>Name of volume collection of which this volume is a member.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volcoll_id</maml:name> <maml:description> <maml:para>ID of volume collection of which this volume is a member. Use this attribute in update operation to associate or dissociate volumes with or from volume collections. When associating, set this attribute to the ID of the volume collection. When dissociating, set this attribute to empty string.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly offline, reduce size or change read-only status a volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this volume was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this volume was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>protection_type</maml:name> <maml:description> <maml:para>Specifies if volume is protected with schedules. If protected, indicate whether replication is setup.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>last_snap</maml:name> <maml:description> <maml:para>Last snapshot for this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_replicated_snap</maml:name> <maml:description> <maml:para>Last replicated snapshot for this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dest_pool_name</maml:name> <maml:description> <maml:para>Name of the destination pool where the volume is moving to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>dest_pool_id</maml:name> <maml:description> <maml:para>ID of the destination pool where the volume is moving to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>move_start_time</maml:name> <maml:description> <maml:para>The Start time when this volume was moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>move_aborting</maml:name> <maml:description> <maml:para>This indicates whether the move of the volume is aborting or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>move_bytes_migrated</maml:name> <maml:description> <maml:para>The bytes of volume which have been moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>move_bytes_remaining</maml:name> <maml:description> <maml:para>The bytes of volume which have not been moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>move_est_compl_time</maml:name> <maml:description> <maml:para>The estimated time of completion of a move.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>This indicates whether usage information of volume and snapshots are valid or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>space_usage_level</maml:name> <maml:description> <maml:para>Indicates space usage level based on warning level.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>total_usage_bytes</maml:name> <maml:description> <maml:para>Sum of volume mapped usage and uncompressed backup data(including pending deletes) in bytes of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_usage_compressed_bytes</maml:name> <maml:description> <maml:para>Compressed data in bytes for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>Uncompressed data in bytes for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_usage_mapped_bytes</maml:name> <maml:description> <maml:para>Mapped data in bytes for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_usage_compressed_bytes</maml:name> <maml:description> <maml:para>Sum of compressed backup data in bytes stored in snapshots of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>Sum of uncompressed unique backup data in bytes stored in snapshots of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_usage_populated_bytes</maml:name> <maml:description> <maml:para>Sum of backup data in bytes stored in snapshots of this volume without accounting for the sharing of data between snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache_pinned</maml:name> <maml:description> <maml:para>If set to true, all the contents of this volume are kept in flash cache. This provides for consistent performance guarantees for all types of workloads. The amount of flash needed to pin the volume is equal to the limit for the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pinned_cache_size</maml:name> <maml:description> <maml:para>The amount of flash pinned on the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache_needed_for_pin</maml:name> <maml:description> <maml:para>The amount of flash needed to pin the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>upstream_cache_pinned</maml:name> <maml:description> <maml:para>This indicates whether the upstream volume is cache pinned or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache_policy</maml:name> <maml:description> <maml:para>Cache policy applied to the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>thinly_provisioned</maml:name> <maml:description> <maml:para>Set volume's provisioning level to thin. Also advertises volume as thinly provisioned to initiators supporting thin provisioning. For such volumes, soft limit notification is set to initiators when the volume space usage crosses its volume_warn_level. Default is yes. The volume's space is provisioned immediately, but for advertising status, this change takes effect only for new connections to the volume. Initiators must disconnect and reconnect for the new setting to be take effect at the initiator level consistently.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_state</maml:name> <maml:description> <maml:para>Status of the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>online_snaps</maml:name> <maml:description> <maml:para>The list of online snapshots of this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_connections</maml:name> <maml:description> <maml:para>Number of connections of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_iscsi_connections</maml:name> <maml:description> <maml:para>Number of iscsi connections of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_fc_connections</maml:name> <maml:description> <maml:para>Number of Fibre Channel connections of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>access_control_records</maml:name> <maml:description> <maml:para>List of access control records that apply to this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>inherit_acl</maml:name> <maml:description> <maml:para>In a volume clone operation, if both the parent and the clone have no external management agent (their agent_type property is "none"), then inherit_acl controls whether the clone will inherit a copy of the parent's access control list. If either the parent or the clone have an external management agent, then the clone will not inherit the parent's access control list.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>encryption_cipher</maml:name> <maml:description> <maml:para>The encryption cipher of the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>folder_id</maml:name> <maml:description> <maml:para>ID of the folder holding this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>folder_name</maml:name> <maml:description> <maml:para>Name of the folder holding this volume. It can be empty.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment an volume's attributes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>iscsi_sessions</maml:name> <maml:description> <maml:para>List of iSCSI sessions connected to this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>fc_sessions</maml:name> <maml:description> <maml:para>List of Fibre Channel sessions connected to this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>caching_enabled</maml:name> <maml:description> <maml:para>Indicate caching the volume is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>previously_deduped</maml:name> <maml:description> <maml:para>Indicate whether dedupe has ever been enabled on this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_enabled</maml:name> <maml:description> <maml:para>Indicate whether dedupe is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vpd_t10</maml:name> <maml:description> <maml:para>The volume's T10 Vendor ID-based identifier.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vpd_ieee0</maml:name> <maml:description> <maml:para>The first 64 bits of the volume's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vpd_ieee1</maml:name> <maml:description> <maml:para>The last 64 bits of the volume's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_category</maml:name> <maml:description> <maml:para>Application category that the volume belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>limit_iops</maml:name> <maml:description> <maml:para>IOPS limit for this volume. If limit_iops is not specified when a volume is created, or if limit_iops is set to -1, then the volume has no IOPS limit. If limit_iops is not specified while creating a clone, IOPS limit of parent volume will be used as limit. IOPS limit should be in range [256, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops <= ((limit_mbps MB/s * 2^20 B/MB) / block_size B).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>limit_mbps</maml:name> <maml:description> <maml:para>Throughput limit for this volume in MB/s. If limit_mbps is not specified when a volume is created, or if limit_mbps is set to -1, then the volume has no MBPS limit. MBPS limit should be in range [1, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops <= ((limit_mbps MB/s * 2^20 B/MB) / block_size B).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>needs_content_repl</maml:name> <maml:description> <maml:para>Indicates whether the volume needs content based replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>content_repl_errors_found</maml:name> <maml:description> <maml:para>Indicates whether the last content based replication had errors.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_content_snap_br_cg_uid</maml:name> <maml:description> <maml:para>The branch cg uid of the content based snapshot that was last replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_content_snap_br_gid</maml:name> <maml:description> <maml:para>The branch gid of the content based snapshot that was last replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_content_snap_id</maml:name> <maml:description> <maml:para>The ID of the content based snapshot that was last replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cksum_last_verified</maml:name> <maml:description> <maml:para>Last checksum verification time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pre_filter</maml:name> <maml:description> <maml:para>Pre-filtering criteria.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>avg_stats_last_5mins</maml:name> <maml:description> <maml:para>Average statistics in last 5 minutes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>srep_last_sync</maml:name> <maml:description> <maml:para>Time when synchronously replicated volume was last synchronized.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>srep_resync_percent</maml:name> <maml:description> <maml:para>Percentage of resync progress for synchronously replicated volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> PS:> New-NSVolume -name test4 Name id Size vol_state perfpolicy_name thinly_provisioned block_size description ---- -- ---- --------- --------------- ------------------ ---------- ----------- test4 0628eada7f8dd99d3b0000000000000000000000d2 10240 online default True 4096 </dev:code> <dev:remarks> <maml:para>This command will create a new volume using the minimal number of parameters. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSVolume</command:name> <maml:description> <maml:para>Retrieve information on a set of volumes or a single volume.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSVolume</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Retrieve information on a set of volumes or a single volume.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of volume used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>size</maml:name> <maml:description> <maml:para>Volume size in mebibytes. Size is required for creating a volume but not for cloning an existing volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>perfpolicy_name</maml:name> <maml:description> <maml:para>Name of performance policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>perfpolicy_id</maml:name> <maml:description> <maml:para>Identifier of the performance policy. After creating a volume, performance policy for the volume can only be changed to another performance policy with same block size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>reserve</maml:name> <maml:description> <maml:para>Amount of space to reserve for this volume as a percentage of volume size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>warn_level</maml:name> <maml:description> <maml:para>This attribute is deprecated. Alert threshold for the volume's mapped usage, expressed as a percentage of the volume's size. When the volume's mapped usage exceeds warn_level, the array issues an alert. If this option is not specified, array default volume warn level setting is used to decide the warning level for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit</maml:name> <maml:description> <maml:para>Limit on the volume's mapped usage, expressed as a percentage of the volume's size. When the volume's mapped usage exceeds limit, the volume will be offlined or made non-writable. If this option is not specified, array default volume limit setting is used to decide the limit for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_reserve</maml:name> <maml:description> <maml:para>Amount of space to reserve for snapshots of this volume as a percentage of volume size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_warn_level</maml:name> <maml:description> <maml:para>Threshold for available space as a percentage of volume size below which an alert is raised.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_limit</maml:name> <maml:description> <maml:para>This attribute is deprecated. The array does not limit a volume's snapshot space usage. The attribute is ignored on input and returns max int64 on output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_limit_percent</maml:name> <maml:description> <maml:para>This attribute is deprecated. The array does not limit a volume's snapshot space usage. The attribute is ignored on input and returns -1 on output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Number of live, non-hidden snapshots for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>projected_num_snaps</maml:name> <maml:description> <maml:para>Deprecated. Projected number of snapshots (including scheduled and manual) for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>online</maml:name> <maml:description> <maml:para>Online state of volume, available for host initiators to establish connections.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>owned_by_group</maml:name> <maml:description> <maml:para>Name of group that currently owns the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>owned_by_group_id</maml:name> <maml:description> <maml:para>ID of group that currently owns the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>multi_initiator</maml:name> <maml:description> <maml:para>For iSCSI Volume Target, this flag indicates whether the volume and its snapshots can be accessed from multiple initiators at the same time. The default is false. For iSCSI Group Target or FC access protocol, the attribute cannot be modified and always reads as false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_target_scope</maml:name> <maml:description> <maml:para>This indicates whether volume is exported under iSCSI Group Target or iSCSI Volume Target. This attribute is only meaningful to iSCSI system. On FC system, all volumes are exported under the FC Group Target. In create operation, the volume's target type will be set by this attribute. If not specified, it will be set as the group-setting. In clone operation, the clone's target type will inherit from the parent' setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool where the volume resides. Volume data will be distributed across arrays over which specified pool is defined. If pool option is not specified, volume is assigned to the default pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>Identifier associated with the pool in the storage pool table.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>read_only</maml:name> <maml:description> <maml:para>Volume is read-only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>serial_number</maml:name> <maml:description> <maml:para>Identifier associated with the volume for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>secondary_serial_number</maml:name> <maml:description> <maml:para>Secondary identifier associated with the volume for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>target_name</maml:name> <maml:description> <maml:para>The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>block_size</maml:name> <maml:description> <maml:para>Size in bytes of blocks in the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>offline_reason</maml:name> <maml:description> <maml:para>Volume offline reason.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>clone</maml:name> <maml:description> <maml:para>Whether this volume is a clone. Use this attribute in combination with name and base_snap_id to create a clone by setting clone = true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>parent_vol_name</maml:name> <maml:description> <maml:para>Name of parent volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>parent_vol_id</maml:name> <maml:description> <maml:para>Parent volume ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>base_snap_name</maml:name> <maml:description> <maml:para>Name of base snapshot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>base_snap_id</maml:name> <maml:description> <maml:para>Base snapshot ID. This attribute is required together with name and clone when cloning a volume with the create operation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replication_role</maml:name> <maml:description> <maml:para>Replication role that this volume performs.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volcoll_name</maml:name> <maml:description> <maml:para>Name of volume collection of which this volume is a member.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volcoll_id</maml:name> <maml:description> <maml:para>ID of volume collection of which this volume is a member. Use this attribute in update operation to associate or dissociate volumes with or from volume collections. When associating, set this attribute to the ID of the volume collection. When dissociating, set this attribute to empty string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly offline, reduce size or change read-only status a volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this volume was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this volume was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>protection_type</maml:name> <maml:description> <maml:para>Specifies if volume is protected with schedules. If protected, indicate whether replication is setup.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_snap</maml:name> <maml:description> <maml:para>Last snapshot for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_replicated_snap</maml:name> <maml:description> <maml:para>Last replicated snapshot for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dest_pool_name</maml:name> <maml:description> <maml:para>Name of the destination pool where the volume is moving to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dest_pool_id</maml:name> <maml:description> <maml:para>ID of the destination pool where the volume is moving to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>move_start_time</maml:name> <maml:description> <maml:para>The Start time when this volume was moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>move_aborting</maml:name> <maml:description> <maml:para>This indicates whether the move of the volume is aborting or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>move_bytes_migrated</maml:name> <maml:description> <maml:para>The bytes of volume which have been moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>move_bytes_remaining</maml:name> <maml:description> <maml:para>The bytes of volume which have not been moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>move_est_compl_time</maml:name> <maml:description> <maml:para>The estimated time of completion of a move.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>This indicates whether usage information of volume and snapshots are valid or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>space_usage_level</maml:name> <maml:description> <maml:para>Indicates space usage level based on warning level.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>total_usage_bytes</maml:name> <maml:description> <maml:para>Sum of volume mapped usage and uncompressed backup data(including pending deletes) in bytes of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_usage_compressed_bytes</maml:name> <maml:description> <maml:para>Compressed data in bytes for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>Uncompressed data in bytes for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_usage_mapped_bytes</maml:name> <maml:description> <maml:para>Mapped data in bytes for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_usage_compressed_bytes</maml:name> <maml:description> <maml:para>Sum of compressed backup data in bytes stored in snapshots of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>Sum of uncompressed unique backup data in bytes stored in snapshots of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_usage_populated_bytes</maml:name> <maml:description> <maml:para>Sum of backup data in bytes stored in snapshots of this volume without accounting for the sharing of data between snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache_pinned</maml:name> <maml:description> <maml:para>If set to true, all the contents of this volume are kept in flash cache. This provides for consistent performance guarantees for all types of workloads. The amount of flash needed to pin the volume is equal to the limit for the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pinned_cache_size</maml:name> <maml:description> <maml:para>The amount of flash pinned on the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache_needed_for_pin</maml:name> <maml:description> <maml:para>The amount of flash needed to pin the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>upstream_cache_pinned</maml:name> <maml:description> <maml:para>This indicates whether the upstream volume is cache pinned or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache_policy</maml:name> <maml:description> <maml:para>Cache policy applied to the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>thinly_provisioned</maml:name> <maml:description> <maml:para>Set volume's provisioning level to thin. Also advertises volume as thinly provisioned to initiators supporting thin provisioning. For such volumes, soft limit notification is set to initiators when the volume space usage crosses its volume_warn_level. Default is yes. The volume's space is provisioned immediately, but for advertising status, this change takes effect only for new connections to the volume. Initiators must disconnect and reconnect for the new setting to be take effect at the initiator level consistently.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_state</maml:name> <maml:description> <maml:para>Status of the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>online_snaps</maml:name> <maml:description> <maml:para>The list of online snapshots of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_connections</maml:name> <maml:description> <maml:para>Number of connections of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_iscsi_connections</maml:name> <maml:description> <maml:para>Number of iscsi connections of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_fc_connections</maml:name> <maml:description> <maml:para>Number of Fibre Channel connections of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_control_records</maml:name> <maml:description> <maml:para>List of access control records that apply to this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>inherit_acl</maml:name> <maml:description> <maml:para>In a volume clone operation, if both the parent and the clone have no external management agent (their agent_type property is "none"), then inherit_acl controls whether the clone will inherit a copy of the parent's access control list. If either the parent or the clone have an external management agent, then the clone will not inherit the parent's access control list.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>encryption_cipher</maml:name> <maml:description> <maml:para>The encryption cipher of the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folder_id</maml:name> <maml:description> <maml:para>ID of the folder holding this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folder_name</maml:name> <maml:description> <maml:para>Name of the folder holding this volume. It can be empty.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment an volume's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_sessions</maml:name> <maml:description> <maml:para>List of iSCSI sessions connected to this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fc_sessions</maml:name> <maml:description> <maml:para>List of Fibre Channel sessions connected to this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>caching_enabled</maml:name> <maml:description> <maml:para>Indicate caching the volume is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>previously_deduped</maml:name> <maml:description> <maml:para>Indicate whether dedupe has ever been enabled on this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_enabled</maml:name> <maml:description> <maml:para>Indicate whether dedupe is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vpd_t10</maml:name> <maml:description> <maml:para>The volume's T10 Vendor ID-based identifier.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vpd_ieee0</maml:name> <maml:description> <maml:para>The first 64 bits of the volume's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vpd_ieee1</maml:name> <maml:description> <maml:para>The last 64 bits of the volume's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_category</maml:name> <maml:description> <maml:para>Application category that the volume belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_iops</maml:name> <maml:description> <maml:para>IOPS limit for this volume. If limit_iops is not specified when a volume is created, or if limit_iops is set to -1, then the volume has no IOPS limit. If limit_iops is not specified while creating a clone, IOPS limit of parent volume will be used as limit. IOPS limit should be in range [256, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops <= ((limit_mbps MB/s * 2^20 B/MB) / block_size B).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_mbps</maml:name> <maml:description> <maml:para>Throughput limit for this volume in MB/s. If limit_mbps is not specified when a volume is created, or if limit_mbps is set to -1, then the volume has no MBPS limit. MBPS limit should be in range [1, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops <= ((limit_mbps MB/s * 2^20 B/MB) / block_size B).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>needs_content_repl</maml:name> <maml:description> <maml:para>Indicates whether the volume needs content based replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>content_repl_errors_found</maml:name> <maml:description> <maml:para>Indicates whether the last content based replication had errors.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_content_snap_br_cg_uid</maml:name> <maml:description> <maml:para>The branch cg uid of the content based snapshot that was last replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_content_snap_br_gid</maml:name> <maml:description> <maml:para>The branch gid of the content based snapshot that was last replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_content_snap_id</maml:name> <maml:description> <maml:para>The ID of the content based snapshot that was last replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cksum_last_verified</maml:name> <maml:description> <maml:para>Last checksum verification time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pre_filter</maml:name> <maml:description> <maml:para>Pre-filtering criteria.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>avg_stats_last_5mins</maml:name> <maml:description> <maml:para>Average statistics in last 5 minutes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>srep_last_sync</maml:name> <maml:description> <maml:para>Time when synchronously replicated volume was last synchronized.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>srep_resync_percent</maml:name> <maml:description> <maml:para>Percentage of resync progress for synchronously replicated volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of volume used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>size</maml:name> <maml:description> <maml:para>Volume size in mebibytes. Size is required for creating a volume but not for cloning an existing volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>perfpolicy_name</maml:name> <maml:description> <maml:para>Name of performance policy.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>perfpolicy_id</maml:name> <maml:description> <maml:para>Identifier of the performance policy. After creating a volume, performance policy for the volume can only be changed to another performance policy with same block size.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>reserve</maml:name> <maml:description> <maml:para>Amount of space to reserve for this volume as a percentage of volume size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>warn_level</maml:name> <maml:description> <maml:para>This attribute is deprecated. Alert threshold for the volume's mapped usage, expressed as a percentage of the volume's size. When the volume's mapped usage exceeds warn_level, the array issues an alert. If this option is not specified, array default volume warn level setting is used to decide the warning level for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>limit</maml:name> <maml:description> <maml:para>Limit on the volume's mapped usage, expressed as a percentage of the volume's size. When the volume's mapped usage exceeds limit, the volume will be offlined or made non-writable. If this option is not specified, array default volume limit setting is used to decide the limit for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_reserve</maml:name> <maml:description> <maml:para>Amount of space to reserve for snapshots of this volume as a percentage of volume size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_warn_level</maml:name> <maml:description> <maml:para>Threshold for available space as a percentage of volume size below which an alert is raised.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_limit</maml:name> <maml:description> <maml:para>This attribute is deprecated. The array does not limit a volume's snapshot space usage. The attribute is ignored on input and returns max int64 on output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_limit_percent</maml:name> <maml:description> <maml:para>This attribute is deprecated. The array does not limit a volume's snapshot space usage. The attribute is ignored on input and returns -1 on output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Number of live, non-hidden snapshots for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>projected_num_snaps</maml:name> <maml:description> <maml:para>Deprecated. Projected number of snapshots (including scheduled and manual) for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>online</maml:name> <maml:description> <maml:para>Online state of volume, available for host initiators to establish connections.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>owned_by_group</maml:name> <maml:description> <maml:para>Name of group that currently owns the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>owned_by_group_id</maml:name> <maml:description> <maml:para>ID of group that currently owns the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>multi_initiator</maml:name> <maml:description> <maml:para>For iSCSI Volume Target, this flag indicates whether the volume and its snapshots can be accessed from multiple initiators at the same time. The default is false. For iSCSI Group Target or FC access protocol, the attribute cannot be modified and always reads as false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>iscsi_target_scope</maml:name> <maml:description> <maml:para>This indicates whether volume is exported under iSCSI Group Target or iSCSI Volume Target. This attribute is only meaningful to iSCSI system. On FC system, all volumes are exported under the FC Group Target. In create operation, the volume's target type will be set by this attribute. If not specified, it will be set as the group-setting. In clone operation, the clone's target type will inherit from the parent' setting.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool where the volume resides. Volume data will be distributed across arrays over which specified pool is defined. If pool option is not specified, volume is assigned to the default pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>Identifier associated with the pool in the storage pool table.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>read_only</maml:name> <maml:description> <maml:para>Volume is read-only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>serial_number</maml:name> <maml:description> <maml:para>Identifier associated with the volume for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>secondary_serial_number</maml:name> <maml:description> <maml:para>Secondary identifier associated with the volume for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>target_name</maml:name> <maml:description> <maml:para>The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>block_size</maml:name> <maml:description> <maml:para>Size in bytes of blocks in the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>offline_reason</maml:name> <maml:description> <maml:para>Volume offline reason.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>clone</maml:name> <maml:description> <maml:para>Whether this volume is a clone. Use this attribute in combination with name and base_snap_id to create a clone by setting clone = true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>parent_vol_name</maml:name> <maml:description> <maml:para>Name of parent volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>parent_vol_id</maml:name> <maml:description> <maml:para>Parent volume ID.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>base_snap_name</maml:name> <maml:description> <maml:para>Name of base snapshot.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>base_snap_id</maml:name> <maml:description> <maml:para>Base snapshot ID. This attribute is required together with name and clone when cloning a volume with the create operation.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>replication_role</maml:name> <maml:description> <maml:para>Replication role that this volume performs.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volcoll_name</maml:name> <maml:description> <maml:para>Name of volume collection of which this volume is a member.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volcoll_id</maml:name> <maml:description> <maml:para>ID of volume collection of which this volume is a member. Use this attribute in update operation to associate or dissociate volumes with or from volume collections. When associating, set this attribute to the ID of the volume collection. When dissociating, set this attribute to empty string.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly offline, reduce size or change read-only status a volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this volume was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this volume was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>protection_type</maml:name> <maml:description> <maml:para>Specifies if volume is protected with schedules. If protected, indicate whether replication is setup.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>last_snap</maml:name> <maml:description> <maml:para>Last snapshot for this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_replicated_snap</maml:name> <maml:description> <maml:para>Last replicated snapshot for this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dest_pool_name</maml:name> <maml:description> <maml:para>Name of the destination pool where the volume is moving to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>dest_pool_id</maml:name> <maml:description> <maml:para>ID of the destination pool where the volume is moving to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>move_start_time</maml:name> <maml:description> <maml:para>The Start time when this volume was moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>move_aborting</maml:name> <maml:description> <maml:para>This indicates whether the move of the volume is aborting or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>move_bytes_migrated</maml:name> <maml:description> <maml:para>The bytes of volume which have been moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>move_bytes_remaining</maml:name> <maml:description> <maml:para>The bytes of volume which have not been moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>move_est_compl_time</maml:name> <maml:description> <maml:para>The estimated time of completion of a move.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>This indicates whether usage information of volume and snapshots are valid or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>space_usage_level</maml:name> <maml:description> <maml:para>Indicates space usage level based on warning level.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>total_usage_bytes</maml:name> <maml:description> <maml:para>Sum of volume mapped usage and uncompressed backup data(including pending deletes) in bytes of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_usage_compressed_bytes</maml:name> <maml:description> <maml:para>Compressed data in bytes for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>Uncompressed data in bytes for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_usage_mapped_bytes</maml:name> <maml:description> <maml:para>Mapped data in bytes for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_usage_compressed_bytes</maml:name> <maml:description> <maml:para>Sum of compressed backup data in bytes stored in snapshots of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>Sum of uncompressed unique backup data in bytes stored in snapshots of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_usage_populated_bytes</maml:name> <maml:description> <maml:para>Sum of backup data in bytes stored in snapshots of this volume without accounting for the sharing of data between snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache_pinned</maml:name> <maml:description> <maml:para>If set to true, all the contents of this volume are kept in flash cache. This provides for consistent performance guarantees for all types of workloads. The amount of flash needed to pin the volume is equal to the limit for the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pinned_cache_size</maml:name> <maml:description> <maml:para>The amount of flash pinned on the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache_needed_for_pin</maml:name> <maml:description> <maml:para>The amount of flash needed to pin the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>upstream_cache_pinned</maml:name> <maml:description> <maml:para>This indicates whether the upstream volume is cache pinned or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache_policy</maml:name> <maml:description> <maml:para>Cache policy applied to the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>thinly_provisioned</maml:name> <maml:description> <maml:para>Set volume's provisioning level to thin. Also advertises volume as thinly provisioned to initiators supporting thin provisioning. For such volumes, soft limit notification is set to initiators when the volume space usage crosses its volume_warn_level. Default is yes. The volume's space is provisioned immediately, but for advertising status, this change takes effect only for new connections to the volume. Initiators must disconnect and reconnect for the new setting to be take effect at the initiator level consistently.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_state</maml:name> <maml:description> <maml:para>Status of the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>online_snaps</maml:name> <maml:description> <maml:para>The list of online snapshots of this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_connections</maml:name> <maml:description> <maml:para>Number of connections of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_iscsi_connections</maml:name> <maml:description> <maml:para>Number of iscsi connections of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_fc_connections</maml:name> <maml:description> <maml:para>Number of Fibre Channel connections of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>access_control_records</maml:name> <maml:description> <maml:para>List of access control records that apply to this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>inherit_acl</maml:name> <maml:description> <maml:para>In a volume clone operation, if both the parent and the clone have no external management agent (their agent_type property is "none"), then inherit_acl controls whether the clone will inherit a copy of the parent's access control list. If either the parent or the clone have an external management agent, then the clone will not inherit the parent's access control list.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>encryption_cipher</maml:name> <maml:description> <maml:para>The encryption cipher of the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>folder_id</maml:name> <maml:description> <maml:para>ID of the folder holding this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>folder_name</maml:name> <maml:description> <maml:para>Name of the folder holding this volume. It can be empty.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment an volume's attributes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>iscsi_sessions</maml:name> <maml:description> <maml:para>List of iSCSI sessions connected to this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>fc_sessions</maml:name> <maml:description> <maml:para>List of Fibre Channel sessions connected to this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>caching_enabled</maml:name> <maml:description> <maml:para>Indicate caching the volume is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>previously_deduped</maml:name> <maml:description> <maml:para>Indicate whether dedupe has ever been enabled on this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_enabled</maml:name> <maml:description> <maml:para>Indicate whether dedupe is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vpd_t10</maml:name> <maml:description> <maml:para>The volume's T10 Vendor ID-based identifier.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vpd_ieee0</maml:name> <maml:description> <maml:para>The first 64 bits of the volume's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vpd_ieee1</maml:name> <maml:description> <maml:para>The last 64 bits of the volume's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_category</maml:name> <maml:description> <maml:para>Application category that the volume belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>limit_iops</maml:name> <maml:description> <maml:para>IOPS limit for this volume. If limit_iops is not specified when a volume is created, or if limit_iops is set to -1, then the volume has no IOPS limit. If limit_iops is not specified while creating a clone, IOPS limit of parent volume will be used as limit. IOPS limit should be in range [256, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops <= ((limit_mbps MB/s * 2^20 B/MB) / block_size B).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>limit_mbps</maml:name> <maml:description> <maml:para>Throughput limit for this volume in MB/s. If limit_mbps is not specified when a volume is created, or if limit_mbps is set to -1, then the volume has no MBPS limit. MBPS limit should be in range [1, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops <= ((limit_mbps MB/s * 2^20 B/MB) / block_size B).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>needs_content_repl</maml:name> <maml:description> <maml:para>Indicates whether the volume needs content based replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>content_repl_errors_found</maml:name> <maml:description> <maml:para>Indicates whether the last content based replication had errors.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_content_snap_br_cg_uid</maml:name> <maml:description> <maml:para>The branch cg uid of the content based snapshot that was last replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_content_snap_br_gid</maml:name> <maml:description> <maml:para>The branch gid of the content based snapshot that was last replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_content_snap_id</maml:name> <maml:description> <maml:para>The ID of the content based snapshot that was last replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cksum_last_verified</maml:name> <maml:description> <maml:para>Last checksum verification time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pre_filter</maml:name> <maml:description> <maml:para>Pre-filtering criteria.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>avg_stats_last_5mins</maml:name> <maml:description> <maml:para>Average statistics in last 5 minutes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>srep_last_sync</maml:name> <maml:description> <maml:para>Time when synchronously replicated volume was last synchronized.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>srep_resync_percent</maml:name> <maml:description> <maml:para>Percentage of resync progress for synchronously replicated volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSVolume Name id Size vol_state perfpolicy_name thinly_provisioned block_size description ---- -- ---- --------- --------------- ------------------ ---------- ----------- CHAPI-Testvol1 0628eada7f8dd99d3b000000000000000000000001 5120 online default True 4096 CHAPI-Testvol2 0628eada7f8dd99d3b000000000000000000000002 1024 online default True 4096 testvol1 0628eada7f8dd99d3b000000000000000000000003 1024 online default True 4096 testvol2 0628eada7f8dd99d3b000000000000000000000004 1024 online default True 4096 testvol3 0628eada7f8dd99d3b000000000000000000000005 1024 online default True 4096 </dev:code> <dev:remarks> <maml:para>This command will retrieve the volumes. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 2 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSVolume -name CHAPI-Testvol2 Name id Size vol_state perfpolicy_name thinly_provisioned block_size description ---- -- ---- --------- --------------- ------------------ ---------- ----------- CHAPI-Testvol2 0628eada7f8dd99d3b000000000000000000000002 1024 online default True 4096 </dev:code> <dev:remarks> <maml:para>This command will retrieve the volume specified by name. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSVolume</command:name> <maml:description> <maml:para>Modify volume attributes. Use 'force=true' with readonly=true to force the volume with active connections to become read-only.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSVolume</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Modify volume attributes. Use 'force=true' with readonly=true to force the volume with active connections to become read-only.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of volume used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>size</maml:name> <maml:description> <maml:para>Volume size in mebibytes. Size is required for creating a volume but not for cloning an existing volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>perfpolicy_name</maml:name> <maml:description> <maml:para>Name of performance policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>perfpolicy_id</maml:name> <maml:description> <maml:para>Identifier of the performance policy. After creating a volume, performance policy for the volume can only be changed to another performance policy with same block size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>reserve</maml:name> <maml:description> <maml:para>Amount of space to reserve for this volume as a percentage of volume size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>warn_level</maml:name> <maml:description> <maml:para>This attribute is deprecated. Alert threshold for the volume's mapped usage, expressed as a percentage of the volume's size. When the volume's mapped usage exceeds warn_level, the array issues an alert. If this option is not specified, array default volume warn level setting is used to decide the warning level for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit</maml:name> <maml:description> <maml:para>Limit on the volume's mapped usage, expressed as a percentage of the volume's size. When the volume's mapped usage exceeds limit, the volume will be offlined or made non-writable. If this option is not specified, array default volume limit setting is used to decide the limit for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_reserve</maml:name> <maml:description> <maml:para>Amount of space to reserve for snapshots of this volume as a percentage of volume size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_warn_level</maml:name> <maml:description> <maml:para>Threshold for available space as a percentage of volume size below which an alert is raised.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_limit</maml:name> <maml:description> <maml:para>This attribute is deprecated. The array does not limit a volume's snapshot space usage. The attribute is ignored on input and returns max int64 on output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_limit_percent</maml:name> <maml:description> <maml:para>This attribute is deprecated. The array does not limit a volume's snapshot space usage. The attribute is ignored on input and returns -1 on output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Number of live, non-hidden snapshots for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>projected_num_snaps</maml:name> <maml:description> <maml:para>Deprecated. Projected number of snapshots (including scheduled and manual) for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>online</maml:name> <maml:description> <maml:para>Online state of volume, available for host initiators to establish connections.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>owned_by_group</maml:name> <maml:description> <maml:para>Name of group that currently owns the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>owned_by_group_id</maml:name> <maml:description> <maml:para>ID of group that currently owns the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>multi_initiator</maml:name> <maml:description> <maml:para>For iSCSI Volume Target, this flag indicates whether the volume and its snapshots can be accessed from multiple initiators at the same time. The default is false. For iSCSI Group Target or FC access protocol, the attribute cannot be modified and always reads as false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_target_scope</maml:name> <maml:description> <maml:para>This indicates whether volume is exported under iSCSI Group Target or iSCSI Volume Target. This attribute is only meaningful to iSCSI system. On FC system, all volumes are exported under the FC Group Target. In create operation, the volume's target type will be set by this attribute. If not specified, it will be set as the group-setting. In clone operation, the clone's target type will inherit from the parent' setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool where the volume resides. Volume data will be distributed across arrays over which specified pool is defined. If pool option is not specified, volume is assigned to the default pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>Identifier associated with the pool in the storage pool table.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>read_only</maml:name> <maml:description> <maml:para>Volume is read-only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>serial_number</maml:name> <maml:description> <maml:para>Identifier associated with the volume for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>secondary_serial_number</maml:name> <maml:description> <maml:para>Secondary identifier associated with the volume for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>target_name</maml:name> <maml:description> <maml:para>The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>block_size</maml:name> <maml:description> <maml:para>Size in bytes of blocks in the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>offline_reason</maml:name> <maml:description> <maml:para>Volume offline reason.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>clone</maml:name> <maml:description> <maml:para>Whether this volume is a clone. Use this attribute in combination with name and base_snap_id to create a clone by setting clone = true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>parent_vol_name</maml:name> <maml:description> <maml:para>Name of parent volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>parent_vol_id</maml:name> <maml:description> <maml:para>Parent volume ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>base_snap_name</maml:name> <maml:description> <maml:para>Name of base snapshot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>base_snap_id</maml:name> <maml:description> <maml:para>Base snapshot ID. This attribute is required together with name and clone when cloning a volume with the create operation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replication_role</maml:name> <maml:description> <maml:para>Replication role that this volume performs.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volcoll_name</maml:name> <maml:description> <maml:para>Name of volume collection of which this volume is a member.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volcoll_id</maml:name> <maml:description> <maml:para>ID of volume collection of which this volume is a member. Use this attribute in update operation to associate or dissociate volumes with or from volume collections. When associating, set this attribute to the ID of the volume collection. When dissociating, set this attribute to empty string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly offline, reduce size or change read-only status a volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this volume was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this volume was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>protection_type</maml:name> <maml:description> <maml:para>Specifies if volume is protected with schedules. If protected, indicate whether replication is setup.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_snap</maml:name> <maml:description> <maml:para>Last snapshot for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_replicated_snap</maml:name> <maml:description> <maml:para>Last replicated snapshot for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dest_pool_name</maml:name> <maml:description> <maml:para>Name of the destination pool where the volume is moving to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dest_pool_id</maml:name> <maml:description> <maml:para>ID of the destination pool where the volume is moving to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>move_start_time</maml:name> <maml:description> <maml:para>The Start time when this volume was moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>move_aborting</maml:name> <maml:description> <maml:para>This indicates whether the move of the volume is aborting or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>move_bytes_migrated</maml:name> <maml:description> <maml:para>The bytes of volume which have been moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>move_bytes_remaining</maml:name> <maml:description> <maml:para>The bytes of volume which have not been moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>move_est_compl_time</maml:name> <maml:description> <maml:para>The estimated time of completion of a move.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>This indicates whether usage information of volume and snapshots are valid or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>space_usage_level</maml:name> <maml:description> <maml:para>Indicates space usage level based on warning level.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>total_usage_bytes</maml:name> <maml:description> <maml:para>Sum of volume mapped usage and uncompressed backup data(including pending deletes) in bytes of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_usage_compressed_bytes</maml:name> <maml:description> <maml:para>Compressed data in bytes for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>Uncompressed data in bytes for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_usage_mapped_bytes</maml:name> <maml:description> <maml:para>Mapped data in bytes for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_usage_compressed_bytes</maml:name> <maml:description> <maml:para>Sum of compressed backup data in bytes stored in snapshots of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>Sum of uncompressed unique backup data in bytes stored in snapshots of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_usage_populated_bytes</maml:name> <maml:description> <maml:para>Sum of backup data in bytes stored in snapshots of this volume without accounting for the sharing of data between snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache_pinned</maml:name> <maml:description> <maml:para>If set to true, all the contents of this volume are kept in flash cache. This provides for consistent performance guarantees for all types of workloads. The amount of flash needed to pin the volume is equal to the limit for the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pinned_cache_size</maml:name> <maml:description> <maml:para>The amount of flash pinned on the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache_needed_for_pin</maml:name> <maml:description> <maml:para>The amount of flash needed to pin the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>upstream_cache_pinned</maml:name> <maml:description> <maml:para>This indicates whether the upstream volume is cache pinned or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache_policy</maml:name> <maml:description> <maml:para>Cache policy applied to the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>thinly_provisioned</maml:name> <maml:description> <maml:para>Set volume's provisioning level to thin. Also advertises volume as thinly provisioned to initiators supporting thin provisioning. For such volumes, soft limit notification is set to initiators when the volume space usage crosses its volume_warn_level. Default is yes. The volume's space is provisioned immediately, but for advertising status, this change takes effect only for new connections to the volume. Initiators must disconnect and reconnect for the new setting to be take effect at the initiator level consistently.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_state</maml:name> <maml:description> <maml:para>Status of the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>online_snaps</maml:name> <maml:description> <maml:para>The list of online snapshots of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_connections</maml:name> <maml:description> <maml:para>Number of connections of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_iscsi_connections</maml:name> <maml:description> <maml:para>Number of iscsi connections of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_fc_connections</maml:name> <maml:description> <maml:para>Number of Fibre Channel connections of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_control_records</maml:name> <maml:description> <maml:para>List of access control records that apply to this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>inherit_acl</maml:name> <maml:description> <maml:para>In a volume clone operation, if both the parent and the clone have no external management agent (their agent_type property is "none"), then inherit_acl controls whether the clone will inherit a copy of the parent's access control list. If either the parent or the clone have an external management agent, then the clone will not inherit the parent's access control list.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>encryption_cipher</maml:name> <maml:description> <maml:para>The encryption cipher of the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folder_id</maml:name> <maml:description> <maml:para>ID of the folder holding this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folder_name</maml:name> <maml:description> <maml:para>Name of the folder holding this volume. It can be empty.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment an volume's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_sessions</maml:name> <maml:description> <maml:para>List of iSCSI sessions connected to this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fc_sessions</maml:name> <maml:description> <maml:para>List of Fibre Channel sessions connected to this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>caching_enabled</maml:name> <maml:description> <maml:para>Indicate caching the volume is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>previously_deduped</maml:name> <maml:description> <maml:para>Indicate whether dedupe has ever been enabled on this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_enabled</maml:name> <maml:description> <maml:para>Indicate whether dedupe is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vpd_t10</maml:name> <maml:description> <maml:para>The volume's T10 Vendor ID-based identifier.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vpd_ieee0</maml:name> <maml:description> <maml:para>The first 64 bits of the volume's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vpd_ieee1</maml:name> <maml:description> <maml:para>The last 64 bits of the volume's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_category</maml:name> <maml:description> <maml:para>Application category that the volume belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_iops</maml:name> <maml:description> <maml:para>IOPS limit for this volume. If limit_iops is not specified when a volume is created, or if limit_iops is set to -1, then the volume has no IOPS limit. If limit_iops is not specified while creating a clone, IOPS limit of parent volume will be used as limit. IOPS limit should be in range [256, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops <= ((limit_mbps MB/s * 2^20 B/MB) / block_size B).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_mbps</maml:name> <maml:description> <maml:para>Throughput limit for this volume in MB/s. If limit_mbps is not specified when a volume is created, or if limit_mbps is set to -1, then the volume has no MBPS limit. MBPS limit should be in range [1, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops <= ((limit_mbps MB/s * 2^20 B/MB) / block_size B).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>needs_content_repl</maml:name> <maml:description> <maml:para>Indicates whether the volume needs content based replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>content_repl_errors_found</maml:name> <maml:description> <maml:para>Indicates whether the last content based replication had errors.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_content_snap_br_cg_uid</maml:name> <maml:description> <maml:para>The branch cg uid of the content based snapshot that was last replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_content_snap_br_gid</maml:name> <maml:description> <maml:para>The branch gid of the content based snapshot that was last replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_content_snap_id</maml:name> <maml:description> <maml:para>The ID of the content based snapshot that was last replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cksum_last_verified</maml:name> <maml:description> <maml:para>Last checksum verification time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pre_filter</maml:name> <maml:description> <maml:para>Pre-filtering criteria.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>avg_stats_last_5mins</maml:name> <maml:description> <maml:para>Average statistics in last 5 minutes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>srep_last_sync</maml:name> <maml:description> <maml:para>Time when synchronously replicated volume was last synchronized.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>srep_resync_percent</maml:name> <maml:description> <maml:para>Percentage of resync progress for synchronously replicated volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the volume.</maml:para> </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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of volume used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>size</maml:name> <maml:description> <maml:para>Volume size in mebibytes. Size is required for creating a volume but not for cloning an existing volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>perfpolicy_name</maml:name> <maml:description> <maml:para>Name of performance policy.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>perfpolicy_id</maml:name> <maml:description> <maml:para>Identifier of the performance policy. After creating a volume, performance policy for the volume can only be changed to another performance policy with same block size.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>reserve</maml:name> <maml:description> <maml:para>Amount of space to reserve for this volume as a percentage of volume size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>warn_level</maml:name> <maml:description> <maml:para>This attribute is deprecated. Alert threshold for the volume's mapped usage, expressed as a percentage of the volume's size. When the volume's mapped usage exceeds warn_level, the array issues an alert. If this option is not specified, array default volume warn level setting is used to decide the warning level for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>limit</maml:name> <maml:description> <maml:para>Limit on the volume's mapped usage, expressed as a percentage of the volume's size. When the volume's mapped usage exceeds limit, the volume will be offlined or made non-writable. If this option is not specified, array default volume limit setting is used to decide the limit for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_reserve</maml:name> <maml:description> <maml:para>Amount of space to reserve for snapshots of this volume as a percentage of volume size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_warn_level</maml:name> <maml:description> <maml:para>Threshold for available space as a percentage of volume size below which an alert is raised.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_limit</maml:name> <maml:description> <maml:para>This attribute is deprecated. The array does not limit a volume's snapshot space usage. The attribute is ignored on input and returns max int64 on output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_limit_percent</maml:name> <maml:description> <maml:para>This attribute is deprecated. The array does not limit a volume's snapshot space usage. The attribute is ignored on input and returns -1 on output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Number of live, non-hidden snapshots for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>projected_num_snaps</maml:name> <maml:description> <maml:para>Deprecated. Projected number of snapshots (including scheduled and manual) for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>online</maml:name> <maml:description> <maml:para>Online state of volume, available for host initiators to establish connections.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>owned_by_group</maml:name> <maml:description> <maml:para>Name of group that currently owns the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>owned_by_group_id</maml:name> <maml:description> <maml:para>ID of group that currently owns the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>multi_initiator</maml:name> <maml:description> <maml:para>For iSCSI Volume Target, this flag indicates whether the volume and its snapshots can be accessed from multiple initiators at the same time. The default is false. For iSCSI Group Target or FC access protocol, the attribute cannot be modified and always reads as false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>iscsi_target_scope</maml:name> <maml:description> <maml:para>This indicates whether volume is exported under iSCSI Group Target or iSCSI Volume Target. This attribute is only meaningful to iSCSI system. On FC system, all volumes are exported under the FC Group Target. In create operation, the volume's target type will be set by this attribute. If not specified, it will be set as the group-setting. In clone operation, the clone's target type will inherit from the parent' setting.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool where the volume resides. Volume data will be distributed across arrays over which specified pool is defined. If pool option is not specified, volume is assigned to the default pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>Identifier associated with the pool in the storage pool table.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>read_only</maml:name> <maml:description> <maml:para>Volume is read-only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>serial_number</maml:name> <maml:description> <maml:para>Identifier associated with the volume for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>secondary_serial_number</maml:name> <maml:description> <maml:para>Secondary identifier associated with the volume for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>target_name</maml:name> <maml:description> <maml:para>The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>block_size</maml:name> <maml:description> <maml:para>Size in bytes of blocks in the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>offline_reason</maml:name> <maml:description> <maml:para>Volume offline reason.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>clone</maml:name> <maml:description> <maml:para>Whether this volume is a clone. Use this attribute in combination with name and base_snap_id to create a clone by setting clone = true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>parent_vol_name</maml:name> <maml:description> <maml:para>Name of parent volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>parent_vol_id</maml:name> <maml:description> <maml:para>Parent volume ID.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>base_snap_name</maml:name> <maml:description> <maml:para>Name of base snapshot.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>base_snap_id</maml:name> <maml:description> <maml:para>Base snapshot ID. This attribute is required together with name and clone when cloning a volume with the create operation.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>replication_role</maml:name> <maml:description> <maml:para>Replication role that this volume performs.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volcoll_name</maml:name> <maml:description> <maml:para>Name of volume collection of which this volume is a member.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volcoll_id</maml:name> <maml:description> <maml:para>ID of volume collection of which this volume is a member. Use this attribute in update operation to associate or dissociate volumes with or from volume collections. When associating, set this attribute to the ID of the volume collection. When dissociating, set this attribute to empty string.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly offline, reduce size or change read-only status a volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this volume was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this volume was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>protection_type</maml:name> <maml:description> <maml:para>Specifies if volume is protected with schedules. If protected, indicate whether replication is setup.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>last_snap</maml:name> <maml:description> <maml:para>Last snapshot for this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_replicated_snap</maml:name> <maml:description> <maml:para>Last replicated snapshot for this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dest_pool_name</maml:name> <maml:description> <maml:para>Name of the destination pool where the volume is moving to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>dest_pool_id</maml:name> <maml:description> <maml:para>ID of the destination pool where the volume is moving to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>move_start_time</maml:name> <maml:description> <maml:para>The Start time when this volume was moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>move_aborting</maml:name> <maml:description> <maml:para>This indicates whether the move of the volume is aborting or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>move_bytes_migrated</maml:name> <maml:description> <maml:para>The bytes of volume which have been moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>move_bytes_remaining</maml:name> <maml:description> <maml:para>The bytes of volume which have not been moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>move_est_compl_time</maml:name> <maml:description> <maml:para>The estimated time of completion of a move.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>This indicates whether usage information of volume and snapshots are valid or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>space_usage_level</maml:name> <maml:description> <maml:para>Indicates space usage level based on warning level.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>total_usage_bytes</maml:name> <maml:description> <maml:para>Sum of volume mapped usage and uncompressed backup data(including pending deletes) in bytes of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_usage_compressed_bytes</maml:name> <maml:description> <maml:para>Compressed data in bytes for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>Uncompressed data in bytes for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_usage_mapped_bytes</maml:name> <maml:description> <maml:para>Mapped data in bytes for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_usage_compressed_bytes</maml:name> <maml:description> <maml:para>Sum of compressed backup data in bytes stored in snapshots of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>Sum of uncompressed unique backup data in bytes stored in snapshots of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_usage_populated_bytes</maml:name> <maml:description> <maml:para>Sum of backup data in bytes stored in snapshots of this volume without accounting for the sharing of data between snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache_pinned</maml:name> <maml:description> <maml:para>If set to true, all the contents of this volume are kept in flash cache. This provides for consistent performance guarantees for all types of workloads. The amount of flash needed to pin the volume is equal to the limit for the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pinned_cache_size</maml:name> <maml:description> <maml:para>The amount of flash pinned on the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache_needed_for_pin</maml:name> <maml:description> <maml:para>The amount of flash needed to pin the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>upstream_cache_pinned</maml:name> <maml:description> <maml:para>This indicates whether the upstream volume is cache pinned or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache_policy</maml:name> <maml:description> <maml:para>Cache policy applied to the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>thinly_provisioned</maml:name> <maml:description> <maml:para>Set volume's provisioning level to thin. Also advertises volume as thinly provisioned to initiators supporting thin provisioning. For such volumes, soft limit notification is set to initiators when the volume space usage crosses its volume_warn_level. Default is yes. The volume's space is provisioned immediately, but for advertising status, this change takes effect only for new connections to the volume. Initiators must disconnect and reconnect for the new setting to be take effect at the initiator level consistently.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_state</maml:name> <maml:description> <maml:para>Status of the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>online_snaps</maml:name> <maml:description> <maml:para>The list of online snapshots of this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_connections</maml:name> <maml:description> <maml:para>Number of connections of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_iscsi_connections</maml:name> <maml:description> <maml:para>Number of iscsi connections of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_fc_connections</maml:name> <maml:description> <maml:para>Number of Fibre Channel connections of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>access_control_records</maml:name> <maml:description> <maml:para>List of access control records that apply to this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>inherit_acl</maml:name> <maml:description> <maml:para>In a volume clone operation, if both the parent and the clone have no external management agent (their agent_type property is "none"), then inherit_acl controls whether the clone will inherit a copy of the parent's access control list. If either the parent or the clone have an external management agent, then the clone will not inherit the parent's access control list.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>encryption_cipher</maml:name> <maml:description> <maml:para>The encryption cipher of the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>folder_id</maml:name> <maml:description> <maml:para>ID of the folder holding this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>folder_name</maml:name> <maml:description> <maml:para>Name of the folder holding this volume. It can be empty.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment an volume's attributes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>iscsi_sessions</maml:name> <maml:description> <maml:para>List of iSCSI sessions connected to this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>fc_sessions</maml:name> <maml:description> <maml:para>List of Fibre Channel sessions connected to this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>caching_enabled</maml:name> <maml:description> <maml:para>Indicate caching the volume is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>previously_deduped</maml:name> <maml:description> <maml:para>Indicate whether dedupe has ever been enabled on this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_enabled</maml:name> <maml:description> <maml:para>Indicate whether dedupe is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vpd_t10</maml:name> <maml:description> <maml:para>The volume's T10 Vendor ID-based identifier.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vpd_ieee0</maml:name> <maml:description> <maml:para>The first 64 bits of the volume's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vpd_ieee1</maml:name> <maml:description> <maml:para>The last 64 bits of the volume's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_category</maml:name> <maml:description> <maml:para>Application category that the volume belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>limit_iops</maml:name> <maml:description> <maml:para>IOPS limit for this volume. If limit_iops is not specified when a volume is created, or if limit_iops is set to -1, then the volume has no IOPS limit. If limit_iops is not specified while creating a clone, IOPS limit of parent volume will be used as limit. IOPS limit should be in range [256, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops <= ((limit_mbps MB/s * 2^20 B/MB) / block_size B).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>limit_mbps</maml:name> <maml:description> <maml:para>Throughput limit for this volume in MB/s. If limit_mbps is not specified when a volume is created, or if limit_mbps is set to -1, then the volume has no MBPS limit. MBPS limit should be in range [1, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops <= ((limit_mbps MB/s * 2^20 B/MB) / block_size B).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>needs_content_repl</maml:name> <maml:description> <maml:para>Indicates whether the volume needs content based replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>content_repl_errors_found</maml:name> <maml:description> <maml:para>Indicates whether the last content based replication had errors.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_content_snap_br_cg_uid</maml:name> <maml:description> <maml:para>The branch cg uid of the content based snapshot that was last replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_content_snap_br_gid</maml:name> <maml:description> <maml:para>The branch gid of the content based snapshot that was last replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_content_snap_id</maml:name> <maml:description> <maml:para>The ID of the content based snapshot that was last replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cksum_last_verified</maml:name> <maml:description> <maml:para>Last checksum verification time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pre_filter</maml:name> <maml:description> <maml:para>Pre-filtering criteria.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>avg_stats_last_5mins</maml:name> <maml:description> <maml:para>Average statistics in last 5 minutes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>srep_last_sync</maml:name> <maml:description> <maml:para>Time when synchronously replicated volume was last synchronized.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>srep_resync_percent</maml:name> <maml:description> <maml:para>Percentage of resync progress for synchronously replicated volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Set-NSVolume -id 0628eada7f8dd99d3b0000000000000000000000d2 -online $False Name id Size vol_state perfpolicy_name thinly_provisioned block_size description ---- -- ---- --------- --------------- ------------------ ---------- ----------- test4 0628eada7f8dd99d3b0000000000000000000000d2 10240 offline default True 4096 </dev:code> <dev:remarks> <maml:para>This command will set the value of offline for the volume specified by id. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSVolume</command:name> <maml:description> <maml:para>Delete a volume with the given identifier. The volume as well as all of its snapshots must be offline.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSVolume</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Delete a volume with the given identifier. The volume as well as all of its snapshots must be offline.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of volume used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>size</maml:name> <maml:description> <maml:para>Volume size in mebibytes. Size is required for creating a volume but not for cloning an existing volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>perfpolicy_name</maml:name> <maml:description> <maml:para>Name of performance policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>perfpolicy_id</maml:name> <maml:description> <maml:para>Identifier of the performance policy. After creating a volume, performance policy for the volume can only be changed to another performance policy with same block size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>reserve</maml:name> <maml:description> <maml:para>Amount of space to reserve for this volume as a percentage of volume size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>warn_level</maml:name> <maml:description> <maml:para>This attribute is deprecated. Alert threshold for the volume's mapped usage, expressed as a percentage of the volume's size. When the volume's mapped usage exceeds warn_level, the array issues an alert. If this option is not specified, array default volume warn level setting is used to decide the warning level for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit</maml:name> <maml:description> <maml:para>Limit on the volume's mapped usage, expressed as a percentage of the volume's size. When the volume's mapped usage exceeds limit, the volume will be offlined or made non-writable. If this option is not specified, array default volume limit setting is used to decide the limit for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_reserve</maml:name> <maml:description> <maml:para>Amount of space to reserve for snapshots of this volume as a percentage of volume size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_warn_level</maml:name> <maml:description> <maml:para>Threshold for available space as a percentage of volume size below which an alert is raised.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_limit</maml:name> <maml:description> <maml:para>This attribute is deprecated. The array does not limit a volume's snapshot space usage. The attribute is ignored on input and returns max int64 on output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_limit_percent</maml:name> <maml:description> <maml:para>This attribute is deprecated. The array does not limit a volume's snapshot space usage. The attribute is ignored on input and returns -1 on output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Number of live, non-hidden snapshots for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>projected_num_snaps</maml:name> <maml:description> <maml:para>Deprecated. Projected number of snapshots (including scheduled and manual) for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>online</maml:name> <maml:description> <maml:para>Online state of volume, available for host initiators to establish connections.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>owned_by_group</maml:name> <maml:description> <maml:para>Name of group that currently owns the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>owned_by_group_id</maml:name> <maml:description> <maml:para>ID of group that currently owns the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>multi_initiator</maml:name> <maml:description> <maml:para>For iSCSI Volume Target, this flag indicates whether the volume and its snapshots can be accessed from multiple initiators at the same time. The default is false. For iSCSI Group Target or FC access protocol, the attribute cannot be modified and always reads as false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_target_scope</maml:name> <maml:description> <maml:para>This indicates whether volume is exported under iSCSI Group Target or iSCSI Volume Target. This attribute is only meaningful to iSCSI system. On FC system, all volumes are exported under the FC Group Target. In create operation, the volume's target type will be set by this attribute. If not specified, it will be set as the group-setting. In clone operation, the clone's target type will inherit from the parent' setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool where the volume resides. Volume data will be distributed across arrays over which specified pool is defined. If pool option is not specified, volume is assigned to the default pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>Identifier associated with the pool in the storage pool table.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>read_only</maml:name> <maml:description> <maml:para>Volume is read-only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>serial_number</maml:name> <maml:description> <maml:para>Identifier associated with the volume for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>secondary_serial_number</maml:name> <maml:description> <maml:para>Secondary identifier associated with the volume for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>target_name</maml:name> <maml:description> <maml:para>The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>block_size</maml:name> <maml:description> <maml:para>Size in bytes of blocks in the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>offline_reason</maml:name> <maml:description> <maml:para>Volume offline reason.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>clone</maml:name> <maml:description> <maml:para>Whether this volume is a clone. Use this attribute in combination with name and base_snap_id to create a clone by setting clone = true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>parent_vol_name</maml:name> <maml:description> <maml:para>Name of parent volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>parent_vol_id</maml:name> <maml:description> <maml:para>Parent volume ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>base_snap_name</maml:name> <maml:description> <maml:para>Name of base snapshot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>base_snap_id</maml:name> <maml:description> <maml:para>Base snapshot ID. This attribute is required together with name and clone when cloning a volume with the create operation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replication_role</maml:name> <maml:description> <maml:para>Replication role that this volume performs.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volcoll_name</maml:name> <maml:description> <maml:para>Name of volume collection of which this volume is a member.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volcoll_id</maml:name> <maml:description> <maml:para>ID of volume collection of which this volume is a member. Use this attribute in update operation to associate or dissociate volumes with or from volume collections. When associating, set this attribute to the ID of the volume collection. When dissociating, set this attribute to empty string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly offline, reduce size or change read-only status a volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this volume was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this volume was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>protection_type</maml:name> <maml:description> <maml:para>Specifies if volume is protected with schedules. If protected, indicate whether replication is setup.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_snap</maml:name> <maml:description> <maml:para>Last snapshot for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_replicated_snap</maml:name> <maml:description> <maml:para>Last replicated snapshot for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dest_pool_name</maml:name> <maml:description> <maml:para>Name of the destination pool where the volume is moving to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dest_pool_id</maml:name> <maml:description> <maml:para>ID of the destination pool where the volume is moving to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>move_start_time</maml:name> <maml:description> <maml:para>The Start time when this volume was moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>move_aborting</maml:name> <maml:description> <maml:para>This indicates whether the move of the volume is aborting or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>move_bytes_migrated</maml:name> <maml:description> <maml:para>The bytes of volume which have been moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>move_bytes_remaining</maml:name> <maml:description> <maml:para>The bytes of volume which have not been moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>move_est_compl_time</maml:name> <maml:description> <maml:para>The estimated time of completion of a move.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>This indicates whether usage information of volume and snapshots are valid or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>space_usage_level</maml:name> <maml:description> <maml:para>Indicates space usage level based on warning level.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>total_usage_bytes</maml:name> <maml:description> <maml:para>Sum of volume mapped usage and uncompressed backup data(including pending deletes) in bytes of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_usage_compressed_bytes</maml:name> <maml:description> <maml:para>Compressed data in bytes for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>Uncompressed data in bytes for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_usage_mapped_bytes</maml:name> <maml:description> <maml:para>Mapped data in bytes for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_usage_compressed_bytes</maml:name> <maml:description> <maml:para>Sum of compressed backup data in bytes stored in snapshots of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>Sum of uncompressed unique backup data in bytes stored in snapshots of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_usage_populated_bytes</maml:name> <maml:description> <maml:para>Sum of backup data in bytes stored in snapshots of this volume without accounting for the sharing of data between snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache_pinned</maml:name> <maml:description> <maml:para>If set to true, all the contents of this volume are kept in flash cache. This provides for consistent performance guarantees for all types of workloads. The amount of flash needed to pin the volume is equal to the limit for the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pinned_cache_size</maml:name> <maml:description> <maml:para>The amount of flash pinned on the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache_needed_for_pin</maml:name> <maml:description> <maml:para>The amount of flash needed to pin the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>upstream_cache_pinned</maml:name> <maml:description> <maml:para>This indicates whether the upstream volume is cache pinned or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache_policy</maml:name> <maml:description> <maml:para>Cache policy applied to the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>thinly_provisioned</maml:name> <maml:description> <maml:para>Set volume's provisioning level to thin. Also advertises volume as thinly provisioned to initiators supporting thin provisioning. For such volumes, soft limit notification is set to initiators when the volume space usage crosses its volume_warn_level. Default is yes. The volume's space is provisioned immediately, but for advertising status, this change takes effect only for new connections to the volume. Initiators must disconnect and reconnect for the new setting to be take effect at the initiator level consistently.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_state</maml:name> <maml:description> <maml:para>Status of the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>online_snaps</maml:name> <maml:description> <maml:para>The list of online snapshots of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_connections</maml:name> <maml:description> <maml:para>Number of connections of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_iscsi_connections</maml:name> <maml:description> <maml:para>Number of iscsi connections of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_fc_connections</maml:name> <maml:description> <maml:para>Number of Fibre Channel connections of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_control_records</maml:name> <maml:description> <maml:para>List of access control records that apply to this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>inherit_acl</maml:name> <maml:description> <maml:para>In a volume clone operation, if both the parent and the clone have no external management agent (their agent_type property is "none"), then inherit_acl controls whether the clone will inherit a copy of the parent's access control list. If either the parent or the clone have an external management agent, then the clone will not inherit the parent's access control list.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>encryption_cipher</maml:name> <maml:description> <maml:para>The encryption cipher of the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folder_id</maml:name> <maml:description> <maml:para>ID of the folder holding this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folder_name</maml:name> <maml:description> <maml:para>Name of the folder holding this volume. It can be empty.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment an volume's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_sessions</maml:name> <maml:description> <maml:para>List of iSCSI sessions connected to this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fc_sessions</maml:name> <maml:description> <maml:para>List of Fibre Channel sessions connected to this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>caching_enabled</maml:name> <maml:description> <maml:para>Indicate caching the volume is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>previously_deduped</maml:name> <maml:description> <maml:para>Indicate whether dedupe has ever been enabled on this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_enabled</maml:name> <maml:description> <maml:para>Indicate whether dedupe is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vpd_t10</maml:name> <maml:description> <maml:para>The volume's T10 Vendor ID-based identifier.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vpd_ieee0</maml:name> <maml:description> <maml:para>The first 64 bits of the volume's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vpd_ieee1</maml:name> <maml:description> <maml:para>The last 64 bits of the volume's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_category</maml:name> <maml:description> <maml:para>Application category that the volume belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_iops</maml:name> <maml:description> <maml:para>IOPS limit for this volume. If limit_iops is not specified when a volume is created, or if limit_iops is set to -1, then the volume has no IOPS limit. If limit_iops is not specified while creating a clone, IOPS limit of parent volume will be used as limit. IOPS limit should be in range [256, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops <= ((limit_mbps MB/s * 2^20 B/MB) / block_size B).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_mbps</maml:name> <maml:description> <maml:para>Throughput limit for this volume in MB/s. If limit_mbps is not specified when a volume is created, or if limit_mbps is set to -1, then the volume has no MBPS limit. MBPS limit should be in range [1, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops <= ((limit_mbps MB/s * 2^20 B/MB) / block_size B).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>needs_content_repl</maml:name> <maml:description> <maml:para>Indicates whether the volume needs content based replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>content_repl_errors_found</maml:name> <maml:description> <maml:para>Indicates whether the last content based replication had errors.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_content_snap_br_cg_uid</maml:name> <maml:description> <maml:para>The branch cg uid of the content based snapshot that was last replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_content_snap_br_gid</maml:name> <maml:description> <maml:para>The branch gid of the content based snapshot that was last replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_content_snap_id</maml:name> <maml:description> <maml:para>The ID of the content based snapshot that was last replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cksum_last_verified</maml:name> <maml:description> <maml:para>Last checksum verification time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pre_filter</maml:name> <maml:description> <maml:para>Pre-filtering criteria.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>avg_stats_last_5mins</maml:name> <maml:description> <maml:para>Average statistics in last 5 minutes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>srep_last_sync</maml:name> <maml:description> <maml:para>Time when synchronously replicated volume was last synchronized.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>srep_resync_percent</maml:name> <maml:description> <maml:para>Percentage of resync progress for synchronously replicated volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of volume used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>size</maml:name> <maml:description> <maml:para>Volume size in mebibytes. Size is required for creating a volume but not for cloning an existing volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>perfpolicy_name</maml:name> <maml:description> <maml:para>Name of performance policy.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>perfpolicy_id</maml:name> <maml:description> <maml:para>Identifier of the performance policy. After creating a volume, performance policy for the volume can only be changed to another performance policy with same block size.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>reserve</maml:name> <maml:description> <maml:para>Amount of space to reserve for this volume as a percentage of volume size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>warn_level</maml:name> <maml:description> <maml:para>This attribute is deprecated. Alert threshold for the volume's mapped usage, expressed as a percentage of the volume's size. When the volume's mapped usage exceeds warn_level, the array issues an alert. If this option is not specified, array default volume warn level setting is used to decide the warning level for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>limit</maml:name> <maml:description> <maml:para>Limit on the volume's mapped usage, expressed as a percentage of the volume's size. When the volume's mapped usage exceeds limit, the volume will be offlined or made non-writable. If this option is not specified, array default volume limit setting is used to decide the limit for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_reserve</maml:name> <maml:description> <maml:para>Amount of space to reserve for snapshots of this volume as a percentage of volume size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_warn_level</maml:name> <maml:description> <maml:para>Threshold for available space as a percentage of volume size below which an alert is raised.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_limit</maml:name> <maml:description> <maml:para>This attribute is deprecated. The array does not limit a volume's snapshot space usage. The attribute is ignored on input and returns max int64 on output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_limit_percent</maml:name> <maml:description> <maml:para>This attribute is deprecated. The array does not limit a volume's snapshot space usage. The attribute is ignored on input and returns -1 on output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Number of live, non-hidden snapshots for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>projected_num_snaps</maml:name> <maml:description> <maml:para>Deprecated. Projected number of snapshots (including scheduled and manual) for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>online</maml:name> <maml:description> <maml:para>Online state of volume, available for host initiators to establish connections.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>owned_by_group</maml:name> <maml:description> <maml:para>Name of group that currently owns the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>owned_by_group_id</maml:name> <maml:description> <maml:para>ID of group that currently owns the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>multi_initiator</maml:name> <maml:description> <maml:para>For iSCSI Volume Target, this flag indicates whether the volume and its snapshots can be accessed from multiple initiators at the same time. The default is false. For iSCSI Group Target or FC access protocol, the attribute cannot be modified and always reads as false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>iscsi_target_scope</maml:name> <maml:description> <maml:para>This indicates whether volume is exported under iSCSI Group Target or iSCSI Volume Target. This attribute is only meaningful to iSCSI system. On FC system, all volumes are exported under the FC Group Target. In create operation, the volume's target type will be set by this attribute. If not specified, it will be set as the group-setting. In clone operation, the clone's target type will inherit from the parent' setting.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool where the volume resides. Volume data will be distributed across arrays over which specified pool is defined. If pool option is not specified, volume is assigned to the default pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>Identifier associated with the pool in the storage pool table.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>read_only</maml:name> <maml:description> <maml:para>Volume is read-only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>serial_number</maml:name> <maml:description> <maml:para>Identifier associated with the volume for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>secondary_serial_number</maml:name> <maml:description> <maml:para>Secondary identifier associated with the volume for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>target_name</maml:name> <maml:description> <maml:para>The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>block_size</maml:name> <maml:description> <maml:para>Size in bytes of blocks in the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>offline_reason</maml:name> <maml:description> <maml:para>Volume offline reason.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>clone</maml:name> <maml:description> <maml:para>Whether this volume is a clone. Use this attribute in combination with name and base_snap_id to create a clone by setting clone = true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>parent_vol_name</maml:name> <maml:description> <maml:para>Name of parent volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>parent_vol_id</maml:name> <maml:description> <maml:para>Parent volume ID.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>base_snap_name</maml:name> <maml:description> <maml:para>Name of base snapshot.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>base_snap_id</maml:name> <maml:description> <maml:para>Base snapshot ID. This attribute is required together with name and clone when cloning a volume with the create operation.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>replication_role</maml:name> <maml:description> <maml:para>Replication role that this volume performs.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volcoll_name</maml:name> <maml:description> <maml:para>Name of volume collection of which this volume is a member.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volcoll_id</maml:name> <maml:description> <maml:para>ID of volume collection of which this volume is a member. Use this attribute in update operation to associate or dissociate volumes with or from volume collections. When associating, set this attribute to the ID of the volume collection. When dissociating, set this attribute to empty string.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly offline, reduce size or change read-only status a volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this volume was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this volume was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>protection_type</maml:name> <maml:description> <maml:para>Specifies if volume is protected with schedules. If protected, indicate whether replication is setup.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>last_snap</maml:name> <maml:description> <maml:para>Last snapshot for this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_replicated_snap</maml:name> <maml:description> <maml:para>Last replicated snapshot for this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dest_pool_name</maml:name> <maml:description> <maml:para>Name of the destination pool where the volume is moving to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>dest_pool_id</maml:name> <maml:description> <maml:para>ID of the destination pool where the volume is moving to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>move_start_time</maml:name> <maml:description> <maml:para>The Start time when this volume was moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>move_aborting</maml:name> <maml:description> <maml:para>This indicates whether the move of the volume is aborting or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>move_bytes_migrated</maml:name> <maml:description> <maml:para>The bytes of volume which have been moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>move_bytes_remaining</maml:name> <maml:description> <maml:para>The bytes of volume which have not been moved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>move_est_compl_time</maml:name> <maml:description> <maml:para>The estimated time of completion of a move.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>This indicates whether usage information of volume and snapshots are valid or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>space_usage_level</maml:name> <maml:description> <maml:para>Indicates space usage level based on warning level.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>total_usage_bytes</maml:name> <maml:description> <maml:para>Sum of volume mapped usage and uncompressed backup data(including pending deletes) in bytes of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_usage_compressed_bytes</maml:name> <maml:description> <maml:para>Compressed data in bytes for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>Uncompressed data in bytes for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_usage_mapped_bytes</maml:name> <maml:description> <maml:para>Mapped data in bytes for this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_usage_compressed_bytes</maml:name> <maml:description> <maml:para>Sum of compressed backup data in bytes stored in snapshots of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>Sum of uncompressed unique backup data in bytes stored in snapshots of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_usage_populated_bytes</maml:name> <maml:description> <maml:para>Sum of backup data in bytes stored in snapshots of this volume without accounting for the sharing of data between snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache_pinned</maml:name> <maml:description> <maml:para>If set to true, all the contents of this volume are kept in flash cache. This provides for consistent performance guarantees for all types of workloads. The amount of flash needed to pin the volume is equal to the limit for the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pinned_cache_size</maml:name> <maml:description> <maml:para>The amount of flash pinned on the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache_needed_for_pin</maml:name> <maml:description> <maml:para>The amount of flash needed to pin the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>upstream_cache_pinned</maml:name> <maml:description> <maml:para>This indicates whether the upstream volume is cache pinned or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache_policy</maml:name> <maml:description> <maml:para>Cache policy applied to the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>thinly_provisioned</maml:name> <maml:description> <maml:para>Set volume's provisioning level to thin. Also advertises volume as thinly provisioned to initiators supporting thin provisioning. For such volumes, soft limit notification is set to initiators when the volume space usage crosses its volume_warn_level. Default is yes. The volume's space is provisioned immediately, but for advertising status, this change takes effect only for new connections to the volume. Initiators must disconnect and reconnect for the new setting to be take effect at the initiator level consistently.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_state</maml:name> <maml:description> <maml:para>Status of the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>online_snaps</maml:name> <maml:description> <maml:para>The list of online snapshots of this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_connections</maml:name> <maml:description> <maml:para>Number of connections of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_iscsi_connections</maml:name> <maml:description> <maml:para>Number of iscsi connections of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_fc_connections</maml:name> <maml:description> <maml:para>Number of Fibre Channel connections of this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>access_control_records</maml:name> <maml:description> <maml:para>List of access control records that apply to this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>inherit_acl</maml:name> <maml:description> <maml:para>In a volume clone operation, if both the parent and the clone have no external management agent (their agent_type property is "none"), then inherit_acl controls whether the clone will inherit a copy of the parent's access control list. If either the parent or the clone have an external management agent, then the clone will not inherit the parent's access control list.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>encryption_cipher</maml:name> <maml:description> <maml:para>The encryption cipher of the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>folder_id</maml:name> <maml:description> <maml:para>ID of the folder holding this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>folder_name</maml:name> <maml:description> <maml:para>Name of the folder holding this volume. It can be empty.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment an volume's attributes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>iscsi_sessions</maml:name> <maml:description> <maml:para>List of iSCSI sessions connected to this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>fc_sessions</maml:name> <maml:description> <maml:para>List of Fibre Channel sessions connected to this volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>caching_enabled</maml:name> <maml:description> <maml:para>Indicate caching the volume is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>previously_deduped</maml:name> <maml:description> <maml:para>Indicate whether dedupe has ever been enabled on this volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_enabled</maml:name> <maml:description> <maml:para>Indicate whether dedupe is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vpd_t10</maml:name> <maml:description> <maml:para>The volume's T10 Vendor ID-based identifier.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vpd_ieee0</maml:name> <maml:description> <maml:para>The first 64 bits of the volume's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vpd_ieee1</maml:name> <maml:description> <maml:para>The last 64 bits of the volume's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_category</maml:name> <maml:description> <maml:para>Application category that the volume belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>limit_iops</maml:name> <maml:description> <maml:para>IOPS limit for this volume. If limit_iops is not specified when a volume is created, or if limit_iops is set to -1, then the volume has no IOPS limit. If limit_iops is not specified while creating a clone, IOPS limit of parent volume will be used as limit. IOPS limit should be in range [256, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops <= ((limit_mbps MB/s * 2^20 B/MB) / block_size B).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>limit_mbps</maml:name> <maml:description> <maml:para>Throughput limit for this volume in MB/s. If limit_mbps is not specified when a volume is created, or if limit_mbps is set to -1, then the volume has no MBPS limit. MBPS limit should be in range [1, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops <= ((limit_mbps MB/s * 2^20 B/MB) / block_size B).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>needs_content_repl</maml:name> <maml:description> <maml:para>Indicates whether the volume needs content based replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>content_repl_errors_found</maml:name> <maml:description> <maml:para>Indicates whether the last content based replication had errors.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_content_snap_br_cg_uid</maml:name> <maml:description> <maml:para>The branch cg uid of the content based snapshot that was last replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_content_snap_br_gid</maml:name> <maml:description> <maml:para>The branch gid of the content based snapshot that was last replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_content_snap_id</maml:name> <maml:description> <maml:para>The ID of the content based snapshot that was last replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cksum_last_verified</maml:name> <maml:description> <maml:para>Last checksum verification time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pre_filter</maml:name> <maml:description> <maml:para>Pre-filtering criteria.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>avg_stats_last_5mins</maml:name> <maml:description> <maml:para>Average statistics in last 5 minutes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>srep_last_sync</maml:name> <maml:description> <maml:para>Time when synchronously replicated volume was last synchronized.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>srep_resync_percent</maml:name> <maml:description> <maml:para>Percentage of resync progress for synchronously replicated volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Remove-NSVolume -id 0628eada7f8dd99d3b0000000000000000000000d2 </dev:code> <dev:remarks> <maml:para>This command will remove the volume specified by id. Note that the volume must be offline for this to succeed. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Restore-NSVolume</command:name> <maml:description> <maml:para>Restore volume data from a previous snapshot.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Resto</command:verb> <command:noun>-NSVolume</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Restore volume data from a previous snapshot.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Restore-NSVolume</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the restored volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Restore-NSVolume</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>base_snap_id</maml:name> <maml:description> <maml:para>ID of the snapshot to which this the volume is restored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the restored volume.</maml:para> </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="true (ByValue)" position="named"> <maml:name>base_snap_id</maml:name> <maml:description> <maml:para>ID of the snapshot to which this the volume is restored.</maml:para> </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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Move-NSVolume</command:name> <maml:description> <maml:para>Move a volume and its related volumes to another pool. To change a single volume's folder assignment (while remaining in the same pool), use a volume update operation to change the folder_id attribute.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Move-</command:verb> <command:noun>-NSVolume</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Move a volume and its related volumes to another pool. To change a single volume's folder assignment (while remaining in the same pool), use a volume update operation to change the folder_id attribute.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Move-NSVolume</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the volume to move.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Move-NSVolume</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dest_pool_id</maml:name> <maml:description> <maml:para>ID of the destination pool or folder. Specify a pool ID when the volumes should not be in a folder; otherwise, specify a folder ID and the pool will be derived from the folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Move-NSVolume</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force_vvol</maml:name> <maml:description> <maml:para>Forcibly move a Virtual Volume. Moving Virtual Volume is disruptive to the vCenter, hence it should only be done by the VASA Provider (VP). This flag should only be set by the VP when it calls this API.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the volume to move.</maml:para> </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="true (ByValue)" position="named"> <maml:name>dest_pool_id</maml:name> <maml:description> <maml:para>ID of the destination pool or folder. Specify a pool ID when the volumes should not be in a folder; otherwise, specify a folder ID and the pool will be derived from the folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>force_vvol</maml:name> <maml:description> <maml:para>Forcibly move a Virtual Volume. Moving Virtual Volume is disruptive to the vCenter, hence it should only be done by the VASA Provider (VP). This flag should only be set by the VP when it calls this API.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Move-NSVolumeBulk</command:name> <maml:description> <maml:para>Move volumes and their related volumes to another pool. To change a single volume's folder assignment (while remaining in the same pool), use a volume update operation to change the folder_id attribute.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Move-</command:verb> <command:noun>-NSVolumeBulk</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Move volumes and their related volumes to another pool. To change a single volume's folder assignment (while remaining in the same pool), use a volume update operation to change the folder_id attribute.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Move-NSVolumeBulk</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_ids</maml:name> <maml:description> <maml:para>IDs of the volumes to move.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Move-NSVolumeBulk</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dest_pool_id</maml:name> <maml:description> <maml:para>ID of the destination pool or folder. Specify a pool ID when the volumes should not be in a folder; otherwise, specify a folder ID and the pool will be derived from the folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Move-NSVolumeBulk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force_vvol</maml:name> <maml:description> <maml:para>Forcibly move a Virtual Volume. Moving Virtual Volume is disruptive to the vCenter, hence it should only be done by the VASA Provider (VP). This flag should only be set by the VP when it calls this API.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_ids</maml:name> <maml:description> <maml:para>IDs of the volumes to move.</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="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dest_pool_id</maml:name> <maml:description> <maml:para>ID of the destination pool or folder. Specify a pool ID when the volumes should not be in a folder; otherwise, specify a folder ID and the pool will be derived from the folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>force_vvol</maml:name> <maml:description> <maml:para>Forcibly move a Virtual Volume. Moving Virtual Volume is disruptive to the vCenter, hence it should only be done by the VASA Provider (VP). This flag should only be set by the VP when it calls this API.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Stop-NSVolumeMove</command:name> <maml:description> <maml:para>Abort the in-progress move of the specified volume to another pool.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Stop-</command:verb> <command:noun>-NSVolumeMove</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Abort the in-progress move of the specified volume to another pool.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-NSVolumeMove</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the volume to stop moving to a different pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the volume to stop moving to a different pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSVolumeBulkDeDupe</command:name> <maml:description> <maml:para>Enable or disable dedupe on a list of volumes. If the volumes are not dedupe capable, the operation will fail for the specified volume.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set-N</command:verb> <command:noun>-NSVolumeBulkDeDupe</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Enable or disable dedupe on a list of volumes. If the volumes are not dedupe capable, the operation will fail for the specified volume.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSVolumeBulkDeDupe</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_ids</maml:name> <maml:description> <maml:para>IDs of the volumes to enable/disable dedupe.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeBulkDeDupe</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_enabled</maml:name> <maml:description> <maml:para>Dedupe property to be applied to the list of volumes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_ids</maml:name> <maml:description> <maml:para>IDs of the volumes to enable/disable dedupe.</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="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_enabled</maml:name> <maml:description> <maml:para>Dedupe property to be applied to the list of volumes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSVolumeBulkOnline</command:name> <maml:description> <maml:para>Bring a list of volumes online or offline.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set-N</command:verb> <command:noun>-NSVolumeBulkOnline</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Bring a list of volumes online or offline.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSVolumeBulkOnline</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_ids</maml:name> <maml:description> <maml:para>IDs of the volumes to set online or offline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeBulkOnline</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>online</maml:name> <maml:description> <maml:para>Desired state of the volumes. "true" for online, "false" for offline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_ids</maml:name> <maml:description> <maml:para>IDs of the volumes to set online or offline.</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="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>online</maml:name> <maml:description> <maml:para>Desired state of the volumes. "true" for online, "false" for offline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSSpaceDomain</command:name> <maml:description> <maml:para>List a set of space domains.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSSpaceDomain</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List a set of space domains.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the space domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>Identifier associated with the pool in the storage pool table.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool containing the space domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_category_id</maml:name> <maml:description> <maml:para>Identifier of the application category associated with the space domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_category_name</maml:name> <maml:description> <maml:para>Name of the application category associated with the space domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>perf_policy_names</maml:name> <maml:description> <maml:para>Name of the performance policies associated with the space domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sample_rate</maml:name> <maml:description> <maml:para>Sample rate value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Number of volumes belonging to the space domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>deduped_volume_count</maml:name> <maml:description> <maml:para>Number of deduplicated volumes belonging to the space domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volumes</maml:name> <maml:description> <maml:para>Volumes belonging to the space domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>block_size</maml:name> <maml:description> <maml:para>Block size in bytes of volumes belonging to the space domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>deduped</maml:name> <maml:description> <maml:para>Volumes in space domain are deduplicated by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>encrypted</maml:name> <maml:description> <maml:para>Volumes in space domain are encrypted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage</maml:name> <maml:description> <maml:para>Physical space usage of volumes in the space domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_logical_usage</maml:name> <maml:description> <maml:para>Logical usage of volumes in the space domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_logical_usage</maml:name> <maml:description> <maml:para>Logical usage of snapshots in the space domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_mapped_usage</maml:name> <maml:description> <maml:para>Mapped usage of volumes in the space domain, useful for computing clone savings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>logical_dedupe_usage</maml:name> <maml:description> <maml:para>Logical space usage of volumes when deduped.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>physical_dedupe_usage</maml:name> <maml:description> <maml:para>Physical space usage of volumes including snapshots when deduped.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_compression</maml:name> <maml:description> <maml:para>Space usage savings in the space domain due to compression.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_dedupe</maml:name> <maml:description> <maml:para>Space usage savings in the space domain due to deduplication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_clone</maml:name> <maml:description> <maml:para>Space usage savings in the space domain due to cloning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compressed_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of volumes and snapshots in the space domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>uncompressed_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of volumes and snapshots in the space domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compression_ratio</maml:name> <maml:description> <maml:para>Compression savings for the space domain expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_ratio</maml:name> <maml:description> <maml:para>Deduplication savings for the space domain expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSpaceDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>clone_ratio</maml:name> <maml:description> <maml:para>Clone savings for the space domain expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the space domain.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>Identifier associated with the pool in the storage pool table.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool containing the space domain.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_category_id</maml:name> <maml:description> <maml:para>Identifier of the application category associated with the space domain.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_category_name</maml:name> <maml:description> <maml:para>Name of the application category associated with the space domain.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>perf_policy_names</maml:name> <maml:description> <maml:para>Name of the performance policies associated with the space domain.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>sample_rate</maml:name> <maml:description> <maml:para>Sample rate value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Number of volumes belonging to the space domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>deduped_volume_count</maml:name> <maml:description> <maml:para>Number of deduplicated volumes belonging to the space domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volumes</maml:name> <maml:description> <maml:para>Volumes belonging to the space domain.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>block_size</maml:name> <maml:description> <maml:para>Block size in bytes of volumes belonging to the space domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>deduped</maml:name> <maml:description> <maml:para>Volumes in space domain are deduplicated by default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>encrypted</maml:name> <maml:description> <maml:para>Volumes in space domain are encrypted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage</maml:name> <maml:description> <maml:para>Physical space usage of volumes in the space domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_logical_usage</maml:name> <maml:description> <maml:para>Logical usage of volumes in the space domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_logical_usage</maml:name> <maml:description> <maml:para>Logical usage of snapshots in the space domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_mapped_usage</maml:name> <maml:description> <maml:para>Mapped usage of volumes in the space domain, useful for computing clone savings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>logical_dedupe_usage</maml:name> <maml:description> <maml:para>Logical space usage of volumes when deduped.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>physical_dedupe_usage</maml:name> <maml:description> <maml:para>Physical space usage of volumes including snapshots when deduped.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_compression</maml:name> <maml:description> <maml:para>Space usage savings in the space domain due to compression.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_dedupe</maml:name> <maml:description> <maml:para>Space usage savings in the space domain due to deduplication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_clone</maml:name> <maml:description> <maml:para>Space usage savings in the space domain due to cloning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compressed_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of volumes and snapshots in the space domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>uncompressed_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of volumes and snapshots in the space domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compression_ratio</maml:name> <maml:description> <maml:para>Compression savings for the space domain expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_ratio</maml:name> <maml:description> <maml:para>Deduplication savings for the space domain expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>clone_ratio</maml:name> <maml:description> <maml:para>Clone savings for the space domain expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSGroup</command:name> <maml:description> <maml:para>List group configurations. Attribute filtering is not supported in this object set.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List group configurations. Attribute filtering is not supported in this object set.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>smtp_server</maml:name> <maml:description> <maml:para>Hostname or IP Address of SMTP Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>smtp_port</maml:name> <maml:description> <maml:para>Port number of SMTP Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>smtp_auth_enabled</maml:name> <maml:description> <maml:para>Whether SMTP Server requires authentication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>smtp_auth_username</maml:name> <maml:description> <maml:para>Username to authenticate with SMTP Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>smtp_auth_password</maml:name> <maml:description> <maml:para>Password to authenticate with SMTP Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>smtp_encrypt_type</maml:name> <maml:description> <maml:para>Level of encryption for SMTP. Requires use of SMTP Authentication if encryption is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>autosupport_enabled</maml:name> <maml:description> <maml:para>Whether to send autosupport.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>allow_analytics_gui</maml:name> <maml:description> <maml:para>Specify whether to allow HPE Nimble Storage to use Google Analytics in the GUI. HPE Nimble Storage uses Google Analytics to gather data related to GUI usage. The data gathered is used to evaluate and improve the product.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>allow_support_tunnel</maml:name> <maml:description> <maml:para>Whether to allow support tunnel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>proxy_server</maml:name> <maml:description> <maml:para>Hostname or IP Address of HTTP Proxy Server. Setting this attribute to an empty string will unset all proxy settings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>proxy_port</maml:name> <maml:description> <maml:para>Proxy Port of HTTP Proxy Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>proxy_username</maml:name> <maml:description> <maml:para>Username to authenticate with HTTP Proxy Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>proxy_password</maml:name> <maml:description> <maml:para>Password to authenticate with HTTP Proxy Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>alert_to_email_addrs</maml:name> <maml:description> <maml:para>Comma-separated list of email addresss to receive emails.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>send_alert_to_support</maml:name> <maml:description> <maml:para>Whether to send alert to Support.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>alert_from_email_addr</maml:name> <maml:description> <maml:para>From email address to use while sending emails.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>alert_min_level</maml:name> <maml:description> <maml:para>Minimum level of alert to be notified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>isns_enabled</maml:name> <maml:description> <maml:para>Whether iSNS is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>isns_server</maml:name> <maml:description> <maml:para>Hostname or IP Address of iSNS Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>isns_port</maml:name> <maml:description> <maml:para>Port number for iSNS Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snmp_trap_enabled</maml:name> <maml:description> <maml:para>Whether to enable SNMP traps.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snmp_trap_host</maml:name> <maml:description> <maml:para>Hostname or IP Address to send SNMP traps.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snmp_trap_port</maml:name> <maml:description> <maml:para>Port number of SNMP trap host.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snmp_get_enabled</maml:name> <maml:description> <maml:para>Whether to accept SNMP get commands.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snmp_community</maml:name> <maml:description> <maml:para>Community string to be used with SNMP.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snmp_get_port</maml:name> <maml:description> <maml:para>Port number to which SNMP get requests should be sent.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snmp_sys_contact</maml:name> <maml:description> <maml:para>Name of the SNMP administrator.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snmp_sys_location</maml:name> <maml:description> <maml:para>Location of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>domain_name</maml:name> <maml:description> <maml:para>Domain name for this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dns_servers</maml:name> <maml:description> <maml:para>IP addresses for this group's dns servers.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ntp_server</maml:name> <maml:description> <maml:para>Either IP address or hostname of the NTP server for this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>timezone</maml:name> <maml:description> <maml:para>Timezone in which this group is located.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user_inactivity_timeout</maml:name> <maml:description> <maml:para>The amount of time in seconds that the user session is inactive before timing out.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>syslogd_enabled</maml:name> <maml:description> <maml:para>Is syslogd enabled on this system.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>syslogd_server</maml:name> <maml:description> <maml:para>Hostname of the syslogd server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>syslogd_port</maml:name> <maml:description> <maml:para>Port number for syslogd server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>syslogd_servers</maml:name> <maml:description> <maml:para>Hostname and/or port of the syslogd servers.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vvol_enabled</maml:name> <maml:description> <maml:para>Are vvols enabled on this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_enabled</maml:name> <maml:description> <maml:para>Whether iSCSI is enabled on this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fc_enabled</maml:name> <maml:description> <maml:para>Whether FC is enabled on this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>unique_name_enabled</maml:name> <maml:description> <maml:para>Are new volume and volume collection names transformed on this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_protocol_list</maml:name> <maml:description> <maml:para>Protocol used to access this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group_target_enabled</maml:name> <maml:description> <maml:para>Is group_target enabled on this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>default_iscsi_target_scope</maml:name> <maml:description> <maml:para>Newly created volumes are exported under iSCSI Group Target or iSCSI Volume Target.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tdz_enabled</maml:name> <maml:description> <maml:para>Is Target Driven Zoning (TDZ) enabled on this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tdz_prefix</maml:name> <maml:description> <maml:para>Target Driven Zoning (TDZ) prefix for peer zones created by TDZ.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group_target_name</maml:name> <maml:description> <maml:para>Iscsi target name for this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>default_volume_reserve</maml:name> <maml:description> <maml:para>Amount of space to reserve for a volume as a percentage of volume size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>default_volume_warn_level</maml:name> <maml:description> <maml:para>Default threshold for volume space usage as a percentage of volume size above which an alert is raised.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>default_volume_limit</maml:name> <maml:description> <maml:para>Default limit for a volume space usage as a percentage of volume size. Volume will be taken offline/made non-writable on exceeding its limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>default_snap_reserve</maml:name> <maml:description> <maml:para>Amount of space to reserve for snapshots of a volume as a percentage of volume size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>default_snap_warn_level</maml:name> <maml:description> <maml:para>Default threshold for snapshot space usage of a volume as a percentage of volume size above which an alert is raised.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>default_snap_limit</maml:name> <maml:description> <maml:para>This attribute is deprecated. The array does not limit a volume's snapshot space usage. The attribute is ignored on input and returns max int64 value on output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>default_snap_limit_percent</maml:name> <maml:description> <maml:para>This attribute is deprecated. The array does not limit a volume's snapshot space usage. The attribute is ignored on input and returns -1 on output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>alarms_enabled</maml:name> <maml:description> <maml:para>Whether alarm feature is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vss_validation_timeout</maml:name> <maml:description> <maml:para>The amount of time in seconds to validate Microsoft VSS application synchronization before timing out.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>auto_switchover_enabled</maml:name> <maml:description> <maml:para>Whether automatic switchover of Group management services feature is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>software_subscription_enabled</maml:name> <maml:description> <maml:para>Whether software subscription of Group management services feature is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>auto_switchover_messages</maml:name> <maml:description> <maml:para>List of validation messages for automatic switchover of Group Management. This will be empty when there are no conflicts found.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>merge_state</maml:name> <maml:description> <maml:para>State of group merge.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>merge_group_name</maml:name> <maml:description> <maml:para>Group that we're being merged with.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tlsv1_enabled</maml:name> <maml:description> <maml:para>Enable or disable TLSv1.0 and TLSv1.1.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cc_mode_enabled</maml:name> <maml:description> <maml:para>Enable or disable Common Criteria mode.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group_snapshot_ttl</maml:name> <maml:description> <maml:para>Snapshot Time-to-live(TTL) configured at group level for automatic deletion of unmanaged snapshots. Value 0 indicates unlimited TTL.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>autoclean_unmanaged_snapshots_ttl_unit</maml:name> <maml:description> <maml:para>Unit for unmanaged snapshot time to live.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>autoclean_unmanaged_snapshots_enabled</maml:name> <maml:description> <maml:para>Whether autoclean unmanaged snapshots feature is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>leader_array_name</maml:name> <maml:description> <maml:para>Name of the array where the group Management Service is running.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>leader_array_serial</maml:name> <maml:description> <maml:para>Serial number of the array where the group Management Service is running.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>management_service_backup_array_name</maml:name> <maml:description> <maml:para>Name of the array where backup the group Management Service is running.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>management_service_backup_status</maml:name> <maml:description> <maml:para>HA status of the group Management Service.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>failover_mode</maml:name> <maml:description> <maml:para>Failover mode of the group Management Service.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>witness_status</maml:name> <maml:description> <maml:para>Witness status from group Management Service array and group Management Service backup array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>member_list</maml:name> <maml:description> <maml:para>Members of this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of volumes in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of snapshots in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>uncompressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of volumes in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>uncompressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of snapshots in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usable_capacity_bytes</maml:name> <maml:description> <maml:para>Usable capacity bytes of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage</maml:name> <maml:description> <maml:para>Used space of the group in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>raw_capacity</maml:name> <maml:description> <maml:para>Total capacity of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usable_cache_capacity</maml:name> <maml:description> <maml:para>Usable cache capacity of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>raw_cache_capacity</maml:name> <maml:description> <maml:para>Total cache capacity of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_usage_populated</maml:name> <maml:description> <maml:para>Total snapshot usage as if each snapshot is deep copy of the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pending_deletes</maml:name> <maml:description> <maml:para>Usage for blocks that are not yet deleted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_connections</maml:name> <maml:description> <maml:para>Number of connections to the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_compression_ratio</maml:name> <maml:description> <maml:para>Compression ratio of volumes in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_compression_ratio</maml:name> <maml:description> <maml:para>Compression ratio of snapshots in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compression_ratio</maml:name> <maml:description> <maml:para>Compression savings for the group expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_ratio</maml:name> <maml:description> <maml:para>Dedupe savings for the group expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>clone_ratio</maml:name> <maml:description> <maml:para>Clone savings for the group expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_thin_provisioning_ratio</maml:name> <maml:description> <maml:para>Thin provisioning savings for volumes in the group expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_ratio</maml:name> <maml:description> <maml:para>Overall savings in the group expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>data_reduction_ratio</maml:name> <maml:description> <maml:para>Space savings in the group that does not include thin-provisioning savings expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_dedupe</maml:name> <maml:description> <maml:para>Space usage savings in the group due to deduplication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_compression</maml:name> <maml:description> <maml:para>Space usage savings in the group due to compression.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_clone</maml:name> <maml:description> <maml:para>Space usage savings in the group due to cloning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_vol_thin_provisioning</maml:name> <maml:description> <maml:para>Space usage savings in the group due to thin provisioning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_data_reduction</maml:name> <maml:description> <maml:para>Space usage savings in the group that does not include thin-provisioning savings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings</maml:name> <maml:description> <maml:para>Overall space usage savings in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>free_space</maml:name> <maml:description> <maml:para>Free space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>unused_reserve_bytes</maml:name> <maml:description> <maml:para>Reserved space that is not utilized.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicates whether the usage of group is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>space_info_valid</maml:name> <maml:description> <maml:para>Is space info for this group valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>version_current</maml:name> <maml:description> <maml:para>Version of software running on the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>version_target</maml:name> <maml:description> <maml:para>Desired software version for the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>version_rollback</maml:name> <maml:description> <maml:para>Rollback software version for the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>update_state</maml:name> <maml:description> <maml:para>Group update state.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>update_start_time</maml:name> <maml:description> <maml:para>Start time of last update.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>update_end_time</maml:name> <maml:description> <maml:para>End time of last update.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>update_array_names</maml:name> <maml:description> <maml:para>Arrays in the group undergoing update.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>update_progress_msg</maml:name> <maml:description> <maml:para>Group update detailed progress message.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>update_error_code</maml:name> <maml:description> <maml:para>If the software update has failed, this indicates the error code corresponding to the failure.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>update_downloading</maml:name> <maml:description> <maml:para>Is software update package currently downloading.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>update_download_error_code</maml:name> <maml:description> <maml:para>If the software download has failed, this indicates the error code corresponding to the failure.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>update_download_start_time</maml:name> <maml:description> <maml:para>Start time of last update.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>update_download_end_time</maml:name> <maml:description> <maml:para>End time of last update.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_automatic_connection_method</maml:name> <maml:description> <maml:para>Is iscsi reconnection automatic.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_connection_rebalancing</maml:name> <maml:description> <maml:para>Does iscsi automatically rebalance connections.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_throttled_bandwidth</maml:name> <maml:description> <maml:para>Current bandwidth throttle for replication, expressed either as megabits per second or as -1 to indicate that there is no throttle.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_throttled_bandwidth_kbps</maml:name> <maml:description> <maml:para>Current bandwidth throttle for replication, expressed either as kilobits per second or as -1 to indicate that there is no throttle.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_throttle_list</maml:name> <maml:description> <maml:para>All the replication bandwidth limits on the system.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_migration_status</maml:name> <maml:description> <maml:para>Status of data migration activity related to volumes being relocated to different pools.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_unassign_migration_status</maml:name> <maml:description> <maml:para>Data migration status for arrays being removed from their pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>data_rebalance_status</maml:name> <maml:description> <maml:para>Status of data rebalancing operations for pools in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>scsi_vendor_id</maml:name> <maml:description> <maml:para>SCSI vendor ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>encryption_config</maml:name> <maml:description> <maml:para>How encryption is configured for this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_login</maml:name> <maml:description> <maml:para>Time and user of last login to this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Number of snapshots in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_snapcolls</maml:name> <maml:description> <maml:para>Number of snapshot collections in this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>date</maml:name> <maml:description> <maml:para>Unix epoch time local to the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>login_banner_message</maml:name> <maml:description> <maml:para>The message for the login banner that is displayed during user login activity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>login_banner_after_auth</maml:name> <maml:description> <maml:para>Should the banner be displayed before the user credentials are prompted or after prompting the user credentials.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>login_banner_reset</maml:name> <maml:description> <maml:para>This will reset the banner to the version of the installed NOS. When login_banner_after_auth is specified, login_banner_reset can not be set to true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_retn_meter_high</maml:name> <maml:description> <maml:para>Threshold for considering a volume as high retention.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_retn_meter_very_high</maml:name> <maml:description> <maml:para>Threshold for considering a volume as very high retention.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier of the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>smtp_server</maml:name> <maml:description> <maml:para>Hostname or IP Address of SMTP Server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>smtp_port</maml:name> <maml:description> <maml:para>Port number of SMTP Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>smtp_auth_enabled</maml:name> <maml:description> <maml:para>Whether SMTP Server requires authentication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>smtp_auth_username</maml:name> <maml:description> <maml:para>Username to authenticate with SMTP Server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>smtp_auth_password</maml:name> <maml:description> <maml:para>Password to authenticate with SMTP Server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>smtp_encrypt_type</maml:name> <maml:description> <maml:para>Level of encryption for SMTP. Requires use of SMTP Authentication if encryption is enabled.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>autosupport_enabled</maml:name> <maml:description> <maml:para>Whether to send autosupport.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>allow_analytics_gui</maml:name> <maml:description> <maml:para>Specify whether to allow HPE Nimble Storage to use Google Analytics in the GUI. HPE Nimble Storage uses Google Analytics to gather data related to GUI usage. The data gathered is used to evaluate and improve the product.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>allow_support_tunnel</maml:name> <maml:description> <maml:para>Whether to allow support tunnel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>proxy_server</maml:name> <maml:description> <maml:para>Hostname or IP Address of HTTP Proxy Server. Setting this attribute to an empty string will unset all proxy settings.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>proxy_port</maml:name> <maml:description> <maml:para>Proxy Port of HTTP Proxy Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>proxy_username</maml:name> <maml:description> <maml:para>Username to authenticate with HTTP Proxy Server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>proxy_password</maml:name> <maml:description> <maml:para>Password to authenticate with HTTP Proxy Server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>alert_to_email_addrs</maml:name> <maml:description> <maml:para>Comma-separated list of email addresss to receive emails.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>send_alert_to_support</maml:name> <maml:description> <maml:para>Whether to send alert to Support.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>alert_from_email_addr</maml:name> <maml:description> <maml:para>From email address to use while sending emails.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>alert_min_level</maml:name> <maml:description> <maml:para>Minimum level of alert to be notified.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>isns_enabled</maml:name> <maml:description> <maml:para>Whether iSNS is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>isns_server</maml:name> <maml:description> <maml:para>Hostname or IP Address of iSNS Server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>isns_port</maml:name> <maml:description> <maml:para>Port number for iSNS Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snmp_trap_enabled</maml:name> <maml:description> <maml:para>Whether to enable SNMP traps.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snmp_trap_host</maml:name> <maml:description> <maml:para>Hostname or IP Address to send SNMP traps.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>snmp_trap_port</maml:name> <maml:description> <maml:para>Port number of SNMP trap host.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snmp_get_enabled</maml:name> <maml:description> <maml:para>Whether to accept SNMP get commands.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snmp_community</maml:name> <maml:description> <maml:para>Community string to be used with SNMP.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>snmp_get_port</maml:name> <maml:description> <maml:para>Port number to which SNMP get requests should be sent.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snmp_sys_contact</maml:name> <maml:description> <maml:para>Name of the SNMP administrator.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>snmp_sys_location</maml:name> <maml:description> <maml:para>Location of the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>domain_name</maml:name> <maml:description> <maml:para>Domain name for this group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>dns_servers</maml:name> <maml:description> <maml:para>IP addresses for this group's dns servers.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ntp_server</maml:name> <maml:description> <maml:para>Either IP address or hostname of the NTP server for this group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>timezone</maml:name> <maml:description> <maml:para>Timezone in which this group is located.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>user_inactivity_timeout</maml:name> <maml:description> <maml:para>The amount of time in seconds that the user session is inactive before timing out.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>syslogd_enabled</maml:name> <maml:description> <maml:para>Is syslogd enabled on this system.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>syslogd_server</maml:name> <maml:description> <maml:para>Hostname of the syslogd server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>syslogd_port</maml:name> <maml:description> <maml:para>Port number for syslogd server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>syslogd_servers</maml:name> <maml:description> <maml:para>Hostname and/or port of the syslogd servers.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vvol_enabled</maml:name> <maml:description> <maml:para>Are vvols enabled on this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>iscsi_enabled</maml:name> <maml:description> <maml:para>Whether iSCSI is enabled on this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>fc_enabled</maml:name> <maml:description> <maml:para>Whether FC is enabled on this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>unique_name_enabled</maml:name> <maml:description> <maml:para>Are new volume and volume collection names transformed on this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>access_protocol_list</maml:name> <maml:description> <maml:para>Protocol used to access this group.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>group_target_enabled</maml:name> <maml:description> <maml:para>Is group_target enabled on this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>default_iscsi_target_scope</maml:name> <maml:description> <maml:para>Newly created volumes are exported under iSCSI Group Target or iSCSI Volume Target.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>tdz_enabled</maml:name> <maml:description> <maml:para>Is Target Driven Zoning (TDZ) enabled on this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>tdz_prefix</maml:name> <maml:description> <maml:para>Target Driven Zoning (TDZ) prefix for peer zones created by TDZ.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>group_target_name</maml:name> <maml:description> <maml:para>Iscsi target name for this group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>default_volume_reserve</maml:name> <maml:description> <maml:para>Amount of space to reserve for a volume as a percentage of volume size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>default_volume_warn_level</maml:name> <maml:description> <maml:para>Default threshold for volume space usage as a percentage of volume size above which an alert is raised.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>default_volume_limit</maml:name> <maml:description> <maml:para>Default limit for a volume space usage as a percentage of volume size. Volume will be taken offline/made non-writable on exceeding its limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>default_snap_reserve</maml:name> <maml:description> <maml:para>Amount of space to reserve for snapshots of a volume as a percentage of volume size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>default_snap_warn_level</maml:name> <maml:description> <maml:para>Default threshold for snapshot space usage of a volume as a percentage of volume size above which an alert is raised.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>default_snap_limit</maml:name> <maml:description> <maml:para>This attribute is deprecated. The array does not limit a volume's snapshot space usage. The attribute is ignored on input and returns max int64 value on output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>default_snap_limit_percent</maml:name> <maml:description> <maml:para>This attribute is deprecated. The array does not limit a volume's snapshot space usage. The attribute is ignored on input and returns -1 on output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>alarms_enabled</maml:name> <maml:description> <maml:para>Whether alarm feature is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vss_validation_timeout</maml:name> <maml:description> <maml:para>The amount of time in seconds to validate Microsoft VSS application synchronization before timing out.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>auto_switchover_enabled</maml:name> <maml:description> <maml:para>Whether automatic switchover of Group management services feature is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>software_subscription_enabled</maml:name> <maml:description> <maml:para>Whether software subscription of Group management services feature is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>auto_switchover_messages</maml:name> <maml:description> <maml:para>List of validation messages for automatic switchover of Group Management. This will be empty when there are no conflicts found.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>merge_state</maml:name> <maml:description> <maml:para>State of group merge.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>merge_group_name</maml:name> <maml:description> <maml:para>Group that we're being merged with.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>tlsv1_enabled</maml:name> <maml:description> <maml:para>Enable or disable TLSv1.0 and TLSv1.1.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cc_mode_enabled</maml:name> <maml:description> <maml:para>Enable or disable Common Criteria mode.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>group_snapshot_ttl</maml:name> <maml:description> <maml:para>Snapshot Time-to-live(TTL) configured at group level for automatic deletion of unmanaged snapshots. Value 0 indicates unlimited TTL.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>autoclean_unmanaged_snapshots_ttl_unit</maml:name> <maml:description> <maml:para>Unit for unmanaged snapshot time to live.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>autoclean_unmanaged_snapshots_enabled</maml:name> <maml:description> <maml:para>Whether autoclean unmanaged snapshots feature is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>leader_array_name</maml:name> <maml:description> <maml:para>Name of the array where the group Management Service is running.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>leader_array_serial</maml:name> <maml:description> <maml:para>Serial number of the array where the group Management Service is running.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>management_service_backup_array_name</maml:name> <maml:description> <maml:para>Name of the array where backup the group Management Service is running.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>management_service_backup_status</maml:name> <maml:description> <maml:para>HA status of the group Management Service.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>failover_mode</maml:name> <maml:description> <maml:para>Failover mode of the group Management Service.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>witness_status</maml:name> <maml:description> <maml:para>Witness status from group Management Service array and group Management Service backup array.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>member_list</maml:name> <maml:description> <maml:para>Members of this group.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of volumes in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of snapshots in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>uncompressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of volumes in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>uncompressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of snapshots in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usable_capacity_bytes</maml:name> <maml:description> <maml:para>Usable capacity bytes of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage</maml:name> <maml:description> <maml:para>Used space of the group in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>raw_capacity</maml:name> <maml:description> <maml:para>Total capacity of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usable_cache_capacity</maml:name> <maml:description> <maml:para>Usable cache capacity of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>raw_cache_capacity</maml:name> <maml:description> <maml:para>Total cache capacity of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_usage_populated</maml:name> <maml:description> <maml:para>Total snapshot usage as if each snapshot is deep copy of the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pending_deletes</maml:name> <maml:description> <maml:para>Usage for blocks that are not yet deleted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_connections</maml:name> <maml:description> <maml:para>Number of connections to the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_compression_ratio</maml:name> <maml:description> <maml:para>Compression ratio of volumes in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_compression_ratio</maml:name> <maml:description> <maml:para>Compression ratio of snapshots in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compression_ratio</maml:name> <maml:description> <maml:para>Compression savings for the group expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_ratio</maml:name> <maml:description> <maml:para>Dedupe savings for the group expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>clone_ratio</maml:name> <maml:description> <maml:para>Clone savings for the group expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_thin_provisioning_ratio</maml:name> <maml:description> <maml:para>Thin provisioning savings for volumes in the group expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_ratio</maml:name> <maml:description> <maml:para>Overall savings in the group expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>data_reduction_ratio</maml:name> <maml:description> <maml:para>Space savings in the group that does not include thin-provisioning savings expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_dedupe</maml:name> <maml:description> <maml:para>Space usage savings in the group due to deduplication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_compression</maml:name> <maml:description> <maml:para>Space usage savings in the group due to compression.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_clone</maml:name> <maml:description> <maml:para>Space usage savings in the group due to cloning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_vol_thin_provisioning</maml:name> <maml:description> <maml:para>Space usage savings in the group due to thin provisioning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_data_reduction</maml:name> <maml:description> <maml:para>Space usage savings in the group that does not include thin-provisioning savings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings</maml:name> <maml:description> <maml:para>Overall space usage savings in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>free_space</maml:name> <maml:description> <maml:para>Free space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>unused_reserve_bytes</maml:name> <maml:description> <maml:para>Reserved space that is not utilized.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicates whether the usage of group is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>space_info_valid</maml:name> <maml:description> <maml:para>Is space info for this group valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>version_current</maml:name> <maml:description> <maml:para>Version of software running on the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>version_target</maml:name> <maml:description> <maml:para>Desired software version for the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>version_rollback</maml:name> <maml:description> <maml:para>Rollback software version for the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>update_state</maml:name> <maml:description> <maml:para>Group update state.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>update_start_time</maml:name> <maml:description> <maml:para>Start time of last update.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>update_end_time</maml:name> <maml:description> <maml:para>End time of last update.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>update_array_names</maml:name> <maml:description> <maml:para>Arrays in the group undergoing update.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>update_progress_msg</maml:name> <maml:description> <maml:para>Group update detailed progress message.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>update_error_code</maml:name> <maml:description> <maml:para>If the software update has failed, this indicates the error code corresponding to the failure.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>update_downloading</maml:name> <maml:description> <maml:para>Is software update package currently downloading.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>update_download_error_code</maml:name> <maml:description> <maml:para>If the software download has failed, this indicates the error code corresponding to the failure.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>update_download_start_time</maml:name> <maml:description> <maml:para>Start time of last update.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>update_download_end_time</maml:name> <maml:description> <maml:para>End time of last update.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>iscsi_automatic_connection_method</maml:name> <maml:description> <maml:para>Is iscsi reconnection automatic.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>iscsi_connection_rebalancing</maml:name> <maml:description> <maml:para>Does iscsi automatically rebalance connections.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_throttled_bandwidth</maml:name> <maml:description> <maml:para>Current bandwidth throttle for replication, expressed either as megabits per second or as -1 to indicate that there is no throttle.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_throttled_bandwidth_kbps</maml:name> <maml:description> <maml:para>Current bandwidth throttle for replication, expressed either as kilobits per second or as -1 to indicate that there is no throttle.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_throttle_list</maml:name> <maml:description> <maml:para>All the replication bandwidth limits on the system.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_migration_status</maml:name> <maml:description> <maml:para>Status of data migration activity related to volumes being relocated to different pools.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>array_unassign_migration_status</maml:name> <maml:description> <maml:para>Data migration status for arrays being removed from their pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>data_rebalance_status</maml:name> <maml:description> <maml:para>Status of data rebalancing operations for pools in the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>scsi_vendor_id</maml:name> <maml:description> <maml:para>SCSI vendor ID.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>encryption_config</maml:name> <maml:description> <maml:para>How encryption is configured for this group.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_login</maml:name> <maml:description> <maml:para>Time and user of last login to this group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Number of snapshots in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_snapcolls</maml:name> <maml:description> <maml:para>Number of snapshot collections in this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>date</maml:name> <maml:description> <maml:para>Unix epoch time local to the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>login_banner_message</maml:name> <maml:description> <maml:para>The message for the login banner that is displayed during user login activity.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>login_banner_after_auth</maml:name> <maml:description> <maml:para>Should the banner be displayed before the user credentials are prompted or after prompting the user credentials.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>login_banner_reset</maml:name> <maml:description> <maml:para>This will reset the banner to the version of the installed NOS. When login_banner_after_auth is specified, login_banner_reset can not be set to true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_retn_meter_high</maml:name> <maml:description> <maml:para>Threshold for considering a volume as high retention.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_retn_meter_very_high</maml:name> <maml:description> <maml:para>Threshold for considering a volume as very high retention.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSGroup name id fc_enabled iscsi_enabled usable_capacity_bytes savings_ratio snmp_sys_contact snmp_sys_location ---- -- ---------- ------------- --------------------- ------------- ---------------- ----------------- group-chapi-afa-a1 0028eada7f8dd99d3b000000000000000000000001 False True 23478977434 224.771 Bob The Admin Datacenter Row 3 Rack 4 RU 12 </dev:code> <dev:remarks> <maml:para>This command will retrieve the Group Information. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 2 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSGroup -name group-chapi-afa-a1 name id fc_enabled iscsi_enabled usable_capacity_bytes savings_ratio snmp_sys_contact snmp_sys_location ---- -- ---------- ------------- --------------------- ------------- ---------------- ----------------- group-chapi-afa-a1 0028eada7f8dd99d3b000000000000000000000001 False True 23478977434 224.771 Bob The Admin Datacenter Row 3 Rack 4 RU 12 </dev:code> <dev:remarks> <maml:para>This command will retrieve a Group based on a name. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSGroup</command:name> <maml:description> <maml:para>Modify attributes of the group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Modify attributes of the group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>smtp_server</maml:name> <maml:description> <maml:para>Hostname or IP Address of SMTP Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>smtp_port</maml:name> <maml:description> <maml:para>Port number of SMTP Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>smtp_auth_enabled</maml:name> <maml:description> <maml:para>Whether SMTP Server requires authentication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>smtp_auth_username</maml:name> <maml:description> <maml:para>Username to authenticate with SMTP Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>smtp_auth_password</maml:name> <maml:description> <maml:para>Password to authenticate with SMTP Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>smtp_encrypt_type</maml:name> <maml:description> <maml:para>Level of encryption for SMTP. Requires use of SMTP Authentication if encryption is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>autosupport_enabled</maml:name> <maml:description> <maml:para>Whether to send autosupport.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>allow_analytics_gui</maml:name> <maml:description> <maml:para>Specify whether to allow HPE Nimble Storage to use Google Analytics in the GUI. HPE Nimble Storage uses Google Analytics to gather data related to GUI usage. The data gathered is used to evaluate and improve the product.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>allow_support_tunnel</maml:name> <maml:description> <maml:para>Whether to allow support tunnel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>proxy_server</maml:name> <maml:description> <maml:para>Hostname or IP Address of HTTP Proxy Server. Setting this attribute to an empty string will unset all proxy settings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>proxy_port</maml:name> <maml:description> <maml:para>Proxy Port of HTTP Proxy Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>proxy_username</maml:name> <maml:description> <maml:para>Username to authenticate with HTTP Proxy Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>proxy_password</maml:name> <maml:description> <maml:para>Password to authenticate with HTTP Proxy Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>alert_to_email_addrs</maml:name> <maml:description> <maml:para>Comma-separated list of email addresss to receive emails.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>send_alert_to_support</maml:name> <maml:description> <maml:para>Whether to send alert to Support.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>alert_from_email_addr</maml:name> <maml:description> <maml:para>From email address to use while sending emails.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>alert_min_level</maml:name> <maml:description> <maml:para>Minimum level of alert to be notified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>isns_enabled</maml:name> <maml:description> <maml:para>Whether iSNS is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>isns_server</maml:name> <maml:description> <maml:para>Hostname or IP Address of iSNS Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>isns_port</maml:name> <maml:description> <maml:para>Port number for iSNS Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snmp_trap_enabled</maml:name> <maml:description> <maml:para>Whether to enable SNMP traps.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snmp_trap_host</maml:name> <maml:description> <maml:para>Hostname or IP Address to send SNMP traps.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snmp_trap_port</maml:name> <maml:description> <maml:para>Port number of SNMP trap host.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snmp_get_enabled</maml:name> <maml:description> <maml:para>Whether to accept SNMP get commands.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snmp_community</maml:name> <maml:description> <maml:para>Community string to be used with SNMP.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snmp_get_port</maml:name> <maml:description> <maml:para>Port number to which SNMP get requests should be sent.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snmp_sys_contact</maml:name> <maml:description> <maml:para>Name of the SNMP administrator.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snmp_sys_location</maml:name> <maml:description> <maml:para>Location of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>domain_name</maml:name> <maml:description> <maml:para>Domain name for this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dns_servers</maml:name> <maml:description> <maml:para>IP addresses for this group's dns servers.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ntp_server</maml:name> <maml:description> <maml:para>Either IP address or hostname of the NTP server for this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>timezone</maml:name> <maml:description> <maml:para>Timezone in which this group is located.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user_inactivity_timeout</maml:name> <maml:description> <maml:para>The amount of time in seconds that the user session is inactive before timing out.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>syslogd_enabled</maml:name> <maml:description> <maml:para>Is syslogd enabled on this system.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>syslogd_server</maml:name> <maml:description> <maml:para>Hostname of the syslogd server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>syslogd_port</maml:name> <maml:description> <maml:para>Port number for syslogd server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>syslogd_servers</maml:name> <maml:description> <maml:para>Hostname and/or port of the syslogd servers.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vvol_enabled</maml:name> <maml:description> <maml:para>Are vvols enabled on this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_enabled</maml:name> <maml:description> <maml:para>Whether iSCSI is enabled on this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fc_enabled</maml:name> <maml:description> <maml:para>Whether FC is enabled on this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>unique_name_enabled</maml:name> <maml:description> <maml:para>Are new volume and volume collection names transformed on this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_protocol_list</maml:name> <maml:description> <maml:para>Protocol used to access this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group_target_enabled</maml:name> <maml:description> <maml:para>Is group_target enabled on this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>default_iscsi_target_scope</maml:name> <maml:description> <maml:para>Newly created volumes are exported under iSCSI Group Target or iSCSI Volume Target.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tdz_enabled</maml:name> <maml:description> <maml:para>Is Target Driven Zoning (TDZ) enabled on this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tdz_prefix</maml:name> <maml:description> <maml:para>Target Driven Zoning (TDZ) prefix for peer zones created by TDZ.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group_target_name</maml:name> <maml:description> <maml:para>Iscsi target name for this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>default_volume_reserve</maml:name> <maml:description> <maml:para>Amount of space to reserve for a volume as a percentage of volume size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>default_volume_warn_level</maml:name> <maml:description> <maml:para>Default threshold for volume space usage as a percentage of volume size above which an alert is raised.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>default_volume_limit</maml:name> <maml:description> <maml:para>Default limit for a volume space usage as a percentage of volume size. Volume will be taken offline/made non-writable on exceeding its limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>default_snap_reserve</maml:name> <maml:description> <maml:para>Amount of space to reserve for snapshots of a volume as a percentage of volume size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>default_snap_warn_level</maml:name> <maml:description> <maml:para>Default threshold for snapshot space usage of a volume as a percentage of volume size above which an alert is raised.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>default_snap_limit</maml:name> <maml:description> <maml:para>This attribute is deprecated. The array does not limit a volume's snapshot space usage. The attribute is ignored on input and returns max int64 value on output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>default_snap_limit_percent</maml:name> <maml:description> <maml:para>This attribute is deprecated. The array does not limit a volume's snapshot space usage. The attribute is ignored on input and returns -1 on output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>alarms_enabled</maml:name> <maml:description> <maml:para>Whether alarm feature is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vss_validation_timeout</maml:name> <maml:description> <maml:para>The amount of time in seconds to validate Microsoft VSS application synchronization before timing out.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>auto_switchover_enabled</maml:name> <maml:description> <maml:para>Whether automatic switchover of Group management services feature is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>software_subscription_enabled</maml:name> <maml:description> <maml:para>Whether software subscription of Group management services feature is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>auto_switchover_messages</maml:name> <maml:description> <maml:para>List of validation messages for automatic switchover of Group Management. This will be empty when there are no conflicts found.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>merge_state</maml:name> <maml:description> <maml:para>State of group merge.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>merge_group_name</maml:name> <maml:description> <maml:para>Group that we're being merged with.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tlsv1_enabled</maml:name> <maml:description> <maml:para>Enable or disable TLSv1.0 and TLSv1.1.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cc_mode_enabled</maml:name> <maml:description> <maml:para>Enable or disable Common Criteria mode.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group_snapshot_ttl</maml:name> <maml:description> <maml:para>Snapshot Time-to-live(TTL) configured at group level for automatic deletion of unmanaged snapshots. Value 0 indicates unlimited TTL.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>autoclean_unmanaged_snapshots_ttl_unit</maml:name> <maml:description> <maml:para>Unit for unmanaged snapshot time to live.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>autoclean_unmanaged_snapshots_enabled</maml:name> <maml:description> <maml:para>Whether autoclean unmanaged snapshots feature is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>leader_array_name</maml:name> <maml:description> <maml:para>Name of the array where the group Management Service is running.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>leader_array_serial</maml:name> <maml:description> <maml:para>Serial number of the array where the group Management Service is running.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>management_service_backup_array_name</maml:name> <maml:description> <maml:para>Name of the array where backup the group Management Service is running.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>management_service_backup_status</maml:name> <maml:description> <maml:para>HA status of the group Management Service.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>failover_mode</maml:name> <maml:description> <maml:para>Failover mode of the group Management Service.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>witness_status</maml:name> <maml:description> <maml:para>Witness status from group Management Service array and group Management Service backup array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>member_list</maml:name> <maml:description> <maml:para>Members of this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of volumes in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of snapshots in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>uncompressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of volumes in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>uncompressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of snapshots in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usable_capacity_bytes</maml:name> <maml:description> <maml:para>Usable capacity bytes of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage</maml:name> <maml:description> <maml:para>Used space of the group in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>raw_capacity</maml:name> <maml:description> <maml:para>Total capacity of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usable_cache_capacity</maml:name> <maml:description> <maml:para>Usable cache capacity of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>raw_cache_capacity</maml:name> <maml:description> <maml:para>Total cache capacity of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_usage_populated</maml:name> <maml:description> <maml:para>Total snapshot usage as if each snapshot is deep copy of the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pending_deletes</maml:name> <maml:description> <maml:para>Usage for blocks that are not yet deleted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_connections</maml:name> <maml:description> <maml:para>Number of connections to the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_compression_ratio</maml:name> <maml:description> <maml:para>Compression ratio of volumes in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_compression_ratio</maml:name> <maml:description> <maml:para>Compression ratio of snapshots in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compression_ratio</maml:name> <maml:description> <maml:para>Compression savings for the group expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_ratio</maml:name> <maml:description> <maml:para>Dedupe savings for the group expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>clone_ratio</maml:name> <maml:description> <maml:para>Clone savings for the group expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_thin_provisioning_ratio</maml:name> <maml:description> <maml:para>Thin provisioning savings for volumes in the group expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_ratio</maml:name> <maml:description> <maml:para>Overall savings in the group expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>data_reduction_ratio</maml:name> <maml:description> <maml:para>Space savings in the group that does not include thin-provisioning savings expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_dedupe</maml:name> <maml:description> <maml:para>Space usage savings in the group due to deduplication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_compression</maml:name> <maml:description> <maml:para>Space usage savings in the group due to compression.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_clone</maml:name> <maml:description> <maml:para>Space usage savings in the group due to cloning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_vol_thin_provisioning</maml:name> <maml:description> <maml:para>Space usage savings in the group due to thin provisioning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings_data_reduction</maml:name> <maml:description> <maml:para>Space usage savings in the group that does not include thin-provisioning savings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>savings</maml:name> <maml:description> <maml:para>Overall space usage savings in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>free_space</maml:name> <maml:description> <maml:para>Free space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>unused_reserve_bytes</maml:name> <maml:description> <maml:para>Reserved space that is not utilized.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicates whether the usage of group is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>space_info_valid</maml:name> <maml:description> <maml:para>Is space info for this group valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>version_current</maml:name> <maml:description> <maml:para>Version of software running on the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>version_target</maml:name> <maml:description> <maml:para>Desired software version for the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>version_rollback</maml:name> <maml:description> <maml:para>Rollback software version for the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>update_state</maml:name> <maml:description> <maml:para>Group update state.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>update_start_time</maml:name> <maml:description> <maml:para>Start time of last update.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>update_end_time</maml:name> <maml:description> <maml:para>End time of last update.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>update_array_names</maml:name> <maml:description> <maml:para>Arrays in the group undergoing update.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>update_progress_msg</maml:name> <maml:description> <maml:para>Group update detailed progress message.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>update_error_code</maml:name> <maml:description> <maml:para>If the software update has failed, this indicates the error code corresponding to the failure.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>update_downloading</maml:name> <maml:description> <maml:para>Is software update package currently downloading.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>update_download_error_code</maml:name> <maml:description> <maml:para>If the software download has failed, this indicates the error code corresponding to the failure.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>update_download_start_time</maml:name> <maml:description> <maml:para>Start time of last update.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>update_download_end_time</maml:name> <maml:description> <maml:para>End time of last update.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_automatic_connection_method</maml:name> <maml:description> <maml:para>Is iscsi reconnection automatic.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_connection_rebalancing</maml:name> <maml:description> <maml:para>Does iscsi automatically rebalance connections.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_throttled_bandwidth</maml:name> <maml:description> <maml:para>Current bandwidth throttle for replication, expressed either as megabits per second or as -1 to indicate that there is no throttle.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_throttled_bandwidth_kbps</maml:name> <maml:description> <maml:para>Current bandwidth throttle for replication, expressed either as kilobits per second or as -1 to indicate that there is no throttle.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_throttle_list</maml:name> <maml:description> <maml:para>All the replication bandwidth limits on the system.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_migration_status</maml:name> <maml:description> <maml:para>Status of data migration activity related to volumes being relocated to different pools.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_unassign_migration_status</maml:name> <maml:description> <maml:para>Data migration status for arrays being removed from their pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>data_rebalance_status</maml:name> <maml:description> <maml:para>Status of data rebalancing operations for pools in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>scsi_vendor_id</maml:name> <maml:description> <maml:para>SCSI vendor ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>encryption_config</maml:name> <maml:description> <maml:para>How encryption is configured for this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_login</maml:name> <maml:description> <maml:para>Time and user of last login to this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Number of snapshots in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_snapcolls</maml:name> <maml:description> <maml:para>Number of snapshot collections in this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>date</maml:name> <maml:description> <maml:para>Unix epoch time local to the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>login_banner_message</maml:name> <maml:description> <maml:para>The message for the login banner that is displayed during user login activity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>login_banner_after_auth</maml:name> <maml:description> <maml:para>Should the banner be displayed before the user credentials are prompted or after prompting the user credentials.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>login_banner_reset</maml:name> <maml:description> <maml:para>This will reset the banner to the version of the installed NOS. When login_banner_after_auth is specified, login_banner_reset can not be set to true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_retn_meter_high</maml:name> <maml:description> <maml:para>Threshold for considering a volume as high retention.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_retn_meter_very_high</maml:name> <maml:description> <maml:para>Threshold for considering a volume as very high retention.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier of 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>smtp_server</maml:name> <maml:description> <maml:para>Hostname or IP Address of SMTP Server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>smtp_port</maml:name> <maml:description> <maml:para>Port number of SMTP Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>smtp_auth_enabled</maml:name> <maml:description> <maml:para>Whether SMTP Server requires authentication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>smtp_auth_username</maml:name> <maml:description> <maml:para>Username to authenticate with SMTP Server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>smtp_auth_password</maml:name> <maml:description> <maml:para>Password to authenticate with SMTP Server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>smtp_encrypt_type</maml:name> <maml:description> <maml:para>Level of encryption for SMTP. Requires use of SMTP Authentication if encryption is enabled.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>autosupport_enabled</maml:name> <maml:description> <maml:para>Whether to send autosupport.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>allow_analytics_gui</maml:name> <maml:description> <maml:para>Specify whether to allow HPE Nimble Storage to use Google Analytics in the GUI. HPE Nimble Storage uses Google Analytics to gather data related to GUI usage. The data gathered is used to evaluate and improve the product.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>allow_support_tunnel</maml:name> <maml:description> <maml:para>Whether to allow support tunnel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>proxy_server</maml:name> <maml:description> <maml:para>Hostname or IP Address of HTTP Proxy Server. Setting this attribute to an empty string will unset all proxy settings.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>proxy_port</maml:name> <maml:description> <maml:para>Proxy Port of HTTP Proxy Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>proxy_username</maml:name> <maml:description> <maml:para>Username to authenticate with HTTP Proxy Server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>proxy_password</maml:name> <maml:description> <maml:para>Password to authenticate with HTTP Proxy Server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>alert_to_email_addrs</maml:name> <maml:description> <maml:para>Comma-separated list of email addresss to receive emails.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>send_alert_to_support</maml:name> <maml:description> <maml:para>Whether to send alert to Support.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>alert_from_email_addr</maml:name> <maml:description> <maml:para>From email address to use while sending emails.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>alert_min_level</maml:name> <maml:description> <maml:para>Minimum level of alert to be notified.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>isns_enabled</maml:name> <maml:description> <maml:para>Whether iSNS is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>isns_server</maml:name> <maml:description> <maml:para>Hostname or IP Address of iSNS Server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>isns_port</maml:name> <maml:description> <maml:para>Port number for iSNS Server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snmp_trap_enabled</maml:name> <maml:description> <maml:para>Whether to enable SNMP traps.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snmp_trap_host</maml:name> <maml:description> <maml:para>Hostname or IP Address to send SNMP traps.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>snmp_trap_port</maml:name> <maml:description> <maml:para>Port number of SNMP trap host.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snmp_get_enabled</maml:name> <maml:description> <maml:para>Whether to accept SNMP get commands.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snmp_community</maml:name> <maml:description> <maml:para>Community string to be used with SNMP.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>snmp_get_port</maml:name> <maml:description> <maml:para>Port number to which SNMP get requests should be sent.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snmp_sys_contact</maml:name> <maml:description> <maml:para>Name of the SNMP administrator.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>snmp_sys_location</maml:name> <maml:description> <maml:para>Location of the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>domain_name</maml:name> <maml:description> <maml:para>Domain name for this group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>dns_servers</maml:name> <maml:description> <maml:para>IP addresses for this group's dns servers.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ntp_server</maml:name> <maml:description> <maml:para>Either IP address or hostname of the NTP server for this group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>timezone</maml:name> <maml:description> <maml:para>Timezone in which this group is located.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>user_inactivity_timeout</maml:name> <maml:description> <maml:para>The amount of time in seconds that the user session is inactive before timing out.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>syslogd_enabled</maml:name> <maml:description> <maml:para>Is syslogd enabled on this system.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>syslogd_server</maml:name> <maml:description> <maml:para>Hostname of the syslogd server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>syslogd_port</maml:name> <maml:description> <maml:para>Port number for syslogd server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>syslogd_servers</maml:name> <maml:description> <maml:para>Hostname and/or port of the syslogd servers.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vvol_enabled</maml:name> <maml:description> <maml:para>Are vvols enabled on this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>iscsi_enabled</maml:name> <maml:description> <maml:para>Whether iSCSI is enabled on this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>fc_enabled</maml:name> <maml:description> <maml:para>Whether FC is enabled on this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>unique_name_enabled</maml:name> <maml:description> <maml:para>Are new volume and volume collection names transformed on this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>access_protocol_list</maml:name> <maml:description> <maml:para>Protocol used to access this group.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>group_target_enabled</maml:name> <maml:description> <maml:para>Is group_target enabled on this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>default_iscsi_target_scope</maml:name> <maml:description> <maml:para>Newly created volumes are exported under iSCSI Group Target or iSCSI Volume Target.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>tdz_enabled</maml:name> <maml:description> <maml:para>Is Target Driven Zoning (TDZ) enabled on this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>tdz_prefix</maml:name> <maml:description> <maml:para>Target Driven Zoning (TDZ) prefix for peer zones created by TDZ.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>group_target_name</maml:name> <maml:description> <maml:para>Iscsi target name for this group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>default_volume_reserve</maml:name> <maml:description> <maml:para>Amount of space to reserve for a volume as a percentage of volume size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>default_volume_warn_level</maml:name> <maml:description> <maml:para>Default threshold for volume space usage as a percentage of volume size above which an alert is raised.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>default_volume_limit</maml:name> <maml:description> <maml:para>Default limit for a volume space usage as a percentage of volume size. Volume will be taken offline/made non-writable on exceeding its limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>default_snap_reserve</maml:name> <maml:description> <maml:para>Amount of space to reserve for snapshots of a volume as a percentage of volume size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>default_snap_warn_level</maml:name> <maml:description> <maml:para>Default threshold for snapshot space usage of a volume as a percentage of volume size above which an alert is raised.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>default_snap_limit</maml:name> <maml:description> <maml:para>This attribute is deprecated. The array does not limit a volume's snapshot space usage. The attribute is ignored on input and returns max int64 value on output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>default_snap_limit_percent</maml:name> <maml:description> <maml:para>This attribute is deprecated. The array does not limit a volume's snapshot space usage. The attribute is ignored on input and returns -1 on output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>alarms_enabled</maml:name> <maml:description> <maml:para>Whether alarm feature is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vss_validation_timeout</maml:name> <maml:description> <maml:para>The amount of time in seconds to validate Microsoft VSS application synchronization before timing out.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>auto_switchover_enabled</maml:name> <maml:description> <maml:para>Whether automatic switchover of Group management services feature is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>software_subscription_enabled</maml:name> <maml:description> <maml:para>Whether software subscription of Group management services feature is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>auto_switchover_messages</maml:name> <maml:description> <maml:para>List of validation messages for automatic switchover of Group Management. This will be empty when there are no conflicts found.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>merge_state</maml:name> <maml:description> <maml:para>State of group merge.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>merge_group_name</maml:name> <maml:description> <maml:para>Group that we're being merged with.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>tlsv1_enabled</maml:name> <maml:description> <maml:para>Enable or disable TLSv1.0 and TLSv1.1.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cc_mode_enabled</maml:name> <maml:description> <maml:para>Enable or disable Common Criteria mode.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>group_snapshot_ttl</maml:name> <maml:description> <maml:para>Snapshot Time-to-live(TTL) configured at group level for automatic deletion of unmanaged snapshots. Value 0 indicates unlimited TTL.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>autoclean_unmanaged_snapshots_ttl_unit</maml:name> <maml:description> <maml:para>Unit for unmanaged snapshot time to live.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>autoclean_unmanaged_snapshots_enabled</maml:name> <maml:description> <maml:para>Whether autoclean unmanaged snapshots feature is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>leader_array_name</maml:name> <maml:description> <maml:para>Name of the array where the group Management Service is running.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>leader_array_serial</maml:name> <maml:description> <maml:para>Serial number of the array where the group Management Service is running.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>management_service_backup_array_name</maml:name> <maml:description> <maml:para>Name of the array where backup the group Management Service is running.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>management_service_backup_status</maml:name> <maml:description> <maml:para>HA status of the group Management Service.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>failover_mode</maml:name> <maml:description> <maml:para>Failover mode of the group Management Service.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>witness_status</maml:name> <maml:description> <maml:para>Witness status from group Management Service array and group Management Service backup array.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>member_list</maml:name> <maml:description> <maml:para>Members of this group.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of volumes in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of snapshots in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>uncompressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of volumes in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>uncompressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of snapshots in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usable_capacity_bytes</maml:name> <maml:description> <maml:para>Usable capacity bytes of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage</maml:name> <maml:description> <maml:para>Used space of the group in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>raw_capacity</maml:name> <maml:description> <maml:para>Total capacity of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usable_cache_capacity</maml:name> <maml:description> <maml:para>Usable cache capacity of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>raw_cache_capacity</maml:name> <maml:description> <maml:para>Total cache capacity of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_usage_populated</maml:name> <maml:description> <maml:para>Total snapshot usage as if each snapshot is deep copy of the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pending_deletes</maml:name> <maml:description> <maml:para>Usage for blocks that are not yet deleted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_connections</maml:name> <maml:description> <maml:para>Number of connections to the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_compression_ratio</maml:name> <maml:description> <maml:para>Compression ratio of volumes in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_compression_ratio</maml:name> <maml:description> <maml:para>Compression ratio of snapshots in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compression_ratio</maml:name> <maml:description> <maml:para>Compression savings for the group expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_ratio</maml:name> <maml:description> <maml:para>Dedupe savings for the group expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>clone_ratio</maml:name> <maml:description> <maml:para>Clone savings for the group expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_thin_provisioning_ratio</maml:name> <maml:description> <maml:para>Thin provisioning savings for volumes in the group expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_ratio</maml:name> <maml:description> <maml:para>Overall savings in the group expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>data_reduction_ratio</maml:name> <maml:description> <maml:para>Space savings in the group that does not include thin-provisioning savings expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_dedupe</maml:name> <maml:description> <maml:para>Space usage savings in the group due to deduplication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_compression</maml:name> <maml:description> <maml:para>Space usage savings in the group due to compression.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_clone</maml:name> <maml:description> <maml:para>Space usage savings in the group due to cloning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_vol_thin_provisioning</maml:name> <maml:description> <maml:para>Space usage savings in the group due to thin provisioning of volumes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings_data_reduction</maml:name> <maml:description> <maml:para>Space usage savings in the group that does not include thin-provisioning savings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>savings</maml:name> <maml:description> <maml:para>Overall space usage savings in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>free_space</maml:name> <maml:description> <maml:para>Free space of the pool in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>unused_reserve_bytes</maml:name> <maml:description> <maml:para>Reserved space that is not utilized.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicates whether the usage of group is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>space_info_valid</maml:name> <maml:description> <maml:para>Is space info for this group valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>version_current</maml:name> <maml:description> <maml:para>Version of software running on the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>version_target</maml:name> <maml:description> <maml:para>Desired software version for the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>version_rollback</maml:name> <maml:description> <maml:para>Rollback software version for the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>update_state</maml:name> <maml:description> <maml:para>Group update state.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>update_start_time</maml:name> <maml:description> <maml:para>Start time of last update.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>update_end_time</maml:name> <maml:description> <maml:para>End time of last update.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>update_array_names</maml:name> <maml:description> <maml:para>Arrays in the group undergoing update.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>update_progress_msg</maml:name> <maml:description> <maml:para>Group update detailed progress message.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>update_error_code</maml:name> <maml:description> <maml:para>If the software update has failed, this indicates the error code corresponding to the failure.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>update_downloading</maml:name> <maml:description> <maml:para>Is software update package currently downloading.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>update_download_error_code</maml:name> <maml:description> <maml:para>If the software download has failed, this indicates the error code corresponding to the failure.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>update_download_start_time</maml:name> <maml:description> <maml:para>Start time of last update.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>update_download_end_time</maml:name> <maml:description> <maml:para>End time of last update.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>iscsi_automatic_connection_method</maml:name> <maml:description> <maml:para>Is iscsi reconnection automatic.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>iscsi_connection_rebalancing</maml:name> <maml:description> <maml:para>Does iscsi automatically rebalance connections.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_throttled_bandwidth</maml:name> <maml:description> <maml:para>Current bandwidth throttle for replication, expressed either as megabits per second or as -1 to indicate that there is no throttle.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_throttled_bandwidth_kbps</maml:name> <maml:description> <maml:para>Current bandwidth throttle for replication, expressed either as kilobits per second or as -1 to indicate that there is no throttle.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_throttle_list</maml:name> <maml:description> <maml:para>All the replication bandwidth limits on the system.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_migration_status</maml:name> <maml:description> <maml:para>Status of data migration activity related to volumes being relocated to different pools.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>array_unassign_migration_status</maml:name> <maml:description> <maml:para>Data migration status for arrays being removed from their pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>data_rebalance_status</maml:name> <maml:description> <maml:para>Status of data rebalancing operations for pools in the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>scsi_vendor_id</maml:name> <maml:description> <maml:para>SCSI vendor ID.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>encryption_config</maml:name> <maml:description> <maml:para>How encryption is configured for this group.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_login</maml:name> <maml:description> <maml:para>Time and user of last login to this group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Number of snapshots in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_snapcolls</maml:name> <maml:description> <maml:para>Number of snapshot collections in this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>date</maml:name> <maml:description> <maml:para>Unix epoch time local to the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>login_banner_message</maml:name> <maml:description> <maml:para>The message for the login banner that is displayed during user login activity.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>login_banner_after_auth</maml:name> <maml:description> <maml:para>Should the banner be displayed before the user credentials are prompted or after prompting the user credentials.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>login_banner_reset</maml:name> <maml:description> <maml:para>This will reset the banner to the version of the installed NOS. When login_banner_after_auth is specified, login_banner_reset can not be set to true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_retn_meter_high</maml:name> <maml:description> <maml:para>Threshold for considering a volume as high retention.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_retn_meter_very_high</maml:name> <maml:description> <maml:para>Threshold for considering a volume as very high retention.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> set-NSGroup -id 0028eada7f8dd99d3b000000000000000000000001 -snmp_sys_contact "bob the Admin" -snmp_sys_location "Datacenter Row 3 Rack 4 RU 12" name id fc_enabled iscsi_enabled usable_capacity_bytes savings_ratio snmp_sys_contact snmp_sys_location ---- -- ---------- ------------- --------------------- ------------- ---------------- ----------------- group-chapi-afa-a1 0028eada7f8dd99d3b000000000000000000000001 False True 23478977434 224.771 Bob The Admin Datacenter Row 3 Rack 4 RU 12 </dev:code> <dev:remarks> <maml:para>This command will update the group properties. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Reset-NSGroup</command:name> <maml:description> <maml:para>Reboot all arrays in the group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Reset</command:verb> <command:noun>-NSGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Reboot all arrays in the group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Reset-NSGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the group to reboot.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the group to reboot.</maml:para> </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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Stop-NSGroup</command:name> <maml:description> <maml:para>Halt all arrays in the group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Stop-</command:verb> <command:noun>-NSGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Halt all arrays in the group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-NSGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the group to halt.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Stop-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Halt remaining arrays when one or more is unreachable.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the group to halt.</maml:para> </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="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Halt remaining arrays when one or more is unreachable.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> stop-NSGroup -id 0028eada7f8dd99d3b000000000000000000000001 -force True </dev:code> <dev:remarks> <maml:para>This command will Stop the Group. The Force option must be used </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-NSGroupAlert</command:name> <maml:description> <maml:para>Generate a test alert.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test-</command:verb> <command:noun>-NSGroupAlert</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Generate a test alert.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-NSGroupAlert</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-NSGroupAlert</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>level</maml:name> <maml:description> <maml:para>Level of the test alert.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of 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="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>level</maml:name> <maml:description> <maml:para>Level of the test alert.</maml:para> </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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Test-NSGroupAlert -id 0028eada7f8dd99d3b000000000000000000000001 -level info messages -------- {@{code=SM_no_action; severity=info; text=Operation does not effect a change.}} </dev:code> <dev:remarks> <maml:para>This command will create an alert for the group. The level of the alert can be critical, warning, info or notice but is required. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-NSGroupSoftwareUpdate</command:name> <maml:description> <maml:para>Run software update precheck.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test-</command:verb> <command:noun>-NSGroupSoftwareUpdate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Run software update precheck.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-NSGroupSoftwareUpdate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-NSGroupSoftwareUpdate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>skip_precheck_mask</maml:name> <maml:description> <maml:para>Flag to allow skipping certain types of prechecks.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of 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="true (ByValue)" position="named"> <maml:name>skip_precheck_mask</maml:name> <maml:description> <maml:para>Flag to allow skipping certain types of prechecks.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-NSGroupSoftwareUpdate</command:name> <maml:description> <maml:para>Update the group software to the downloaded version.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Start</command:verb> <command:noun>-NSGroupSoftwareUpdate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Update the group software to the downloaded version.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-NSGroupSoftwareUpdate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-NSGroupSoftwareUpdate</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>skip_start_check_mask</maml:name> <maml:description> <maml:para>Flag to allow skipping certain types of checks.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of 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="true (ByValue)" position="named"> <maml:name>skip_start_check_mask</maml:name> <maml:description> <maml:para>Flag to allow skipping certain types of checks.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-NSGroupSoftwareDownload</command:name> <maml:description> <maml:para>Download software update package.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Start</command:verb> <command:noun>-NSGroupSoftwareDownload</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Download software update package.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-NSGroupSoftwareDownload</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-NSGroupSoftwareDownload</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>version</maml:name> <maml:description> <maml:para>Version string to download.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-NSGroupSoftwareDownload</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Flag to force download.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of 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="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>version</maml:name> <maml:description> <maml:para>Version string to download.</maml:para> </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="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Flag to force download.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Stop-NSGroupSoftwareDownload</command:name> <maml:description> <maml:para>Cancel ongoing download of software.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Stop-</command:verb> <command:noun>-NSGroupSoftwareDownload</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Cancel ongoing download of software.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-NSGroupSoftwareDownload</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Resume-NSGroupSoftwareUpdate</command:name> <maml:description> <maml:para>Resume stopped software update.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Resum</command:verb> <command:noun>-NSGroupSoftwareUpdate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Resume stopped software update.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Resume-NSGroupSoftwareUpdate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSGroupDiscoveredList</command:name> <maml:description> <maml:para>Get list of discovered groups with arrays that are initialized.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get-N</command:verb> <command:noun>-NSGroupDiscoveredList</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Get list of discovered groups with arrays that are initialized.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSGroupDiscoveredList</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroupDiscoveredList</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group_name</maml:name> <maml:description> <maml:para>Name of the group requested to be discovered.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of 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="true (ByValue)" position="named"> <maml:name>group_name</maml:name> <maml:description> <maml:para>Name of the group requested to be discovered.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-NSGroupMerge</command:name> <maml:description> <maml:para>Perform group merge validation.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test-</command:verb> <command:noun>-NSGroupMerge</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Perform group merge validation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-NSGroupMerge</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-NSGroupMerge</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>src_group_name</maml:name> <maml:description> <maml:para>Name of the source group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-NSGroupMerge</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>src_group_ip</maml:name> <maml:description> <maml:para>IP address of the source group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-NSGroupMerge</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>src_username</maml:name> <maml:description> <maml:para>Username of the source group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-NSGroupMerge</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>src_password</maml:name> <maml:description> <maml:para>Password of the source group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-NSGroupMerge</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>src_passphrase</maml:name> <maml:description> <maml:para>Source group encryption passphrase.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-NSGroupMerge</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>skip_secondary_mgmt_ip</maml:name> <maml:description> <maml:para>Skip check for secondary management IP address.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of 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="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>src_group_name</maml:name> <maml:description> <maml:para>Name of the source 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="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>src_group_ip</maml:name> <maml:description> <maml:para>IP address of the source 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="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>src_username</maml:name> <maml:description> <maml:para>Username of the source 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="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>src_password</maml:name> <maml:description> <maml:para>Password of the source 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="true (ByValue)" position="named"> <maml:name>src_passphrase</maml:name> <maml:description> <maml:para>Source group encryption passphrase.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>skip_secondary_mgmt_ip</maml:name> <maml:description> <maml:para>Skip check for secondary management IP address.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Merge-NSGroup</command:name> <maml:description> <maml:para>Perform group merge with the specified group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Merge</command:verb> <command:noun>-NSGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Perform group merge with the specified group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Merge-NSGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Merge-NSGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>src_group_name</maml:name> <maml:description> <maml:para>Name of the source group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Merge-NSGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>src_group_ip</maml:name> <maml:description> <maml:para>IP address of the source group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Merge-NSGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>src_username</maml:name> <maml:description> <maml:para>Username of the source group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Merge-NSGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>src_password</maml:name> <maml:description> <maml:para>Password of the source group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Merge-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>src_passphrase</maml:name> <maml:description> <maml:para>Source group encryption passphrase.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Merge-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Ignore warnings and forcibly merge specified group with this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Merge-NSGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>skip_secondary_mgmt_ip</maml:name> <maml:description> <maml:para>Skip check for secondary management IP address.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of 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="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>src_group_name</maml:name> <maml:description> <maml:para>Name of the source 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="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>src_group_ip</maml:name> <maml:description> <maml:para>IP address of the source 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="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>src_username</maml:name> <maml:description> <maml:para>Username of the source 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="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>src_password</maml:name> <maml:description> <maml:para>Password of the source 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="true (ByValue)" position="named"> <maml:name>src_passphrase</maml:name> <maml:description> <maml:para>Source group encryption passphrase.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Ignore warnings and forcibly merge specified group with this group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>skip_secondary_mgmt_ip</maml:name> <maml:description> <maml:para>Skip check for secondary management IP address.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSGroupgetEULA</command:name> <maml:description> <maml:para>Get URL to download EULA contents.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get-N</command:verb> <command:noun>-NSGroupgetEULA</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Get URL to download EULA contents.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSGroupgetEULA</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroupgetEULA</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>locale</maml:name> <maml:description> <maml:para>Locale of EULA contents. Default is en.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroupgetEULA</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>format</maml:name> <maml:description> <maml:para>Format of EULA contents. Default is HTML.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroupgetEULA</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>phase</maml:name> <maml:description> <maml:para>Phase of EULA contents. Default is setup.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSGroupgetEULA</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Flag to force EULA.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of 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="true (ByValue)" position="named"> <maml:name>locale</maml:name> <maml:description> <maml:para>Locale of EULA contents. Default is en.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>format</maml:name> <maml:description> <maml:para>Format of EULA contents. Default is HTML.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>phase</maml:name> <maml:description> <maml:para>Phase of EULA contents. Default is setup.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Flag to force EULA.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-NSGroupMigrate</command:name> <maml:description> <maml:para>Check if the group Management Service can be migrated to the group Management Service backup array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test-</command:verb> <command:noun>-NSGroupMigrate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Check if the group Management Service can be migrated to the group Management Service backup array.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-NSGroupMigrate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Move-NSGroup</command:name> <maml:description> <maml:para>Migrate the group Management Service to the current group Management Service backup array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Move-</command:verb> <command:noun>-NSGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Migrate the group Management Service to the current group Management Service backup array.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Move-NSGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSGroupTimeZoneList</command:name> <maml:description> <maml:para>Get list of group timezones.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get-N</command:verb> <command:noun>-NSGroupTimeZoneList</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Get list of group timezones.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSGroupTimeZoneList</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSReplicationPartner</command:name> <maml:description> <maml:para>Create a replication partner.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSReplicationPartner</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Create a replication partner.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for a replication partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of replication partner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of replication partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of replication partner used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of replication partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>partner_type</maml:name> <maml:description> <maml:para>Replication partner type. Possible values are group or pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>alias</maml:name> <maml:description> <maml:para>Name this group uses to identify itself to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>secret</maml:name> <maml:description> <maml:para>Replication partner shared secret, used for mutual authentication of the partners.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this replication partner was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this replication partner was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>control_port</maml:name> <maml:description> <maml:para>Port number of partner control interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>hostname</maml:name> <maml:description> <maml:para>IP address or hostname of partner interface. This must be the partner's Group Management IP address.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>port_range_start</maml:name> <maml:description> <maml:para>For tunnel_endpoint partner types, first port available on the ssh proxy available for reverse forwarding. It must be guaranteed that the proxy has the next N ports reserved for this partner, where N is the count of DSDs in this group. This attribute is only valid for tunnel_endpoint partner type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>proxy_hostname</maml:name> <maml:description> <maml:para>IP address of tunnel endpoint. Only valid for tunnel_endpoint partner types.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>proxy_user</maml:name> <maml:description> <maml:para>User to authenticate with tunnel endpoint. Only valid for tunnel_endpoint partner types.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_hostname</maml:name> <maml:description> <maml:para>IP address or hostname of partner data interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>data_port</maml:name> <maml:description> <maml:para>Port number of partner data interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_alive</maml:name> <maml:description> <maml:para>Whether the partner is available, and responding to pings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>partner_group_uid</maml:name> <maml:description> <maml:para>Replication partner group uid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_keepalive_error</maml:name> <maml:description> <maml:para>Most recent error while attempting to ping the partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cfg_sync_status</maml:name> <maml:description> <maml:para>Indicates whether all volumes and volume collections have been synced to the partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_sync_error</maml:name> <maml:description> <maml:para>Most recent error seen while attempting to sync objects to the partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_serial</maml:name> <maml:description> <maml:para>Serial number of group leader array of the partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>version</maml:name> <maml:description> <maml:para>Replication version of the partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>The pool ID where volumes replicated from this partner will be created. Replica volumes created as clones ignore this parameter and are always created in the same pool as their parent volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>The pool name where volumes replicated from this partner will be created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folder_id</maml:name> <maml:description> <maml:para>The Folder ID within the pool where volumes replicated from this partner will be created. This is not supported for pool partners.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folder_name</maml:name> <maml:description> <maml:para>The Folder name within the pool where volumes replicated from this partner will be created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>match_folder</maml:name> <maml:description> <maml:para>Indicates whether to match the upstream volume's folder on the downstream.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>paused</maml:name> <maml:description> <maml:para>Indicates whether replication traffic from/to this partner has been halted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>unique_name</maml:name> <maml:description> <maml:para>Indicates whether this partner actively mangles object names to avoid name conflicts during replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>subnet_label</maml:name> <maml:description> <maml:para>Label of the subnet used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>subnet_type</maml:name> <maml:description> <maml:para>Type of the subnet used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>throttles</maml:name> <maml:description> <maml:para>Throttles used while replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>throttled_bandwidth</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as megabits per second or as the largest possible 64-bit signed integer (9223372036854775807) to indicate that there is no throttle. This attribute is superseded by throttled_bandwidth_current.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>throttled_bandwidth_current</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as megabits per second or as -1 to indicate that there is no throttle.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>throttled_bandwidth_kbps</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as kilobits per second or as the largest possible 64-bit signed integer (9223372036854775807) to indicate that there is no throttle. This attribute is superseded by throttled_bandwidth_current_kbps.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>throttled_bandwidth_current_kbps</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as kilobits per second or as -1 to indicate that there is no throttle.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>subnet_network</maml:name> <maml:description> <maml:para>Subnet used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>subnet_netmask</maml:name> <maml:description> <maml:para>Subnet mask used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_collection_list</maml:name> <maml:description> <maml:para>List of volume collections that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_collection_list_count</maml:name> <maml:description> <maml:para>Count of volume collections that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_list_count</maml:name> <maml:description> <maml:para>Count of volumes that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replication_direction</maml:name> <maml:description> <maml:para>Direction of replication configured with this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for a replication partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of replication partner.</maml:para> </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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of replication partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of replication partner used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of replication partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>partner_type</maml:name> <maml:description> <maml:para>Replication partner type. Possible values are group or pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>alias</maml:name> <maml:description> <maml:para>Name this group uses to identify itself to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>secret</maml:name> <maml:description> <maml:para>Replication partner shared secret, used for mutual authentication of the partners.</maml:para> </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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this replication partner was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this replication partner was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>control_port</maml:name> <maml:description> <maml:para>Port number of partner control interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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>hostname</maml:name> <maml:description> <maml:para>IP address or hostname of partner interface. This must be the partner's Group Management IP address.</maml:para> </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="true (ByValue)" position="named"> <maml:name>port_range_start</maml:name> <maml:description> <maml:para>For tunnel_endpoint partner types, first port available on the ssh proxy available for reverse forwarding. It must be guaranteed that the proxy has the next N ports reserved for this partner, where N is the count of DSDs in this group. This attribute is only valid for tunnel_endpoint partner type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>proxy_hostname</maml:name> <maml:description> <maml:para>IP address of tunnel endpoint. Only valid for tunnel_endpoint partner types.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>proxy_user</maml:name> <maml:description> <maml:para>User to authenticate with tunnel endpoint. Only valid for tunnel_endpoint partner types.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>repl_hostname</maml:name> <maml:description> <maml:para>IP address or hostname of partner data interface.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>data_port</maml:name> <maml:description> <maml:para>Port number of partner data interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_alive</maml:name> <maml:description> <maml:para>Whether the partner is available, and responding to pings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>partner_group_uid</maml:name> <maml:description> <maml:para>Replication partner group uid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_keepalive_error</maml:name> <maml:description> <maml:para>Most recent error while attempting to ping the partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>cfg_sync_status</maml:name> <maml:description> <maml:para>Indicates whether all volumes and volume collections have been synced to the partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>last_sync_error</maml:name> <maml:description> <maml:para>Most recent error seen while attempting to sync objects to the partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>array_serial</maml:name> <maml:description> <maml:para>Serial number of group leader array of the partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>version</maml:name> <maml:description> <maml:para>Replication version of the partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>The pool ID where volumes replicated from this partner will be created. Replica volumes created as clones ignore this parameter and are always created in the same pool as their parent volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>The pool name where volumes replicated from this partner will be created.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>folder_id</maml:name> <maml:description> <maml:para>The Folder ID within the pool where volumes replicated from this partner will be created. This is not supported for pool partners.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>folder_name</maml:name> <maml:description> <maml:para>The Folder name within the pool where volumes replicated from this partner will be created.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>match_folder</maml:name> <maml:description> <maml:para>Indicates whether to match the upstream volume's folder on the downstream.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>paused</maml:name> <maml:description> <maml:para>Indicates whether replication traffic from/to this partner has been halted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>unique_name</maml:name> <maml:description> <maml:para>Indicates whether this partner actively mangles object names to avoid name conflicts during replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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>subnet_label</maml:name> <maml:description> <maml:para>Label of the subnet used to replicate to this partner.</maml:para> </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="true (ByValue)" position="named"> <maml:name>subnet_type</maml:name> <maml:description> <maml:para>Type of the subnet used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>throttles</maml:name> <maml:description> <maml:para>Throttles used while replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>throttled_bandwidth</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as megabits per second or as the largest possible 64-bit signed integer (9223372036854775807) to indicate that there is no throttle. This attribute is superseded by throttled_bandwidth_current.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>throttled_bandwidth_current</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as megabits per second or as -1 to indicate that there is no throttle.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>throttled_bandwidth_kbps</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as kilobits per second or as the largest possible 64-bit signed integer (9223372036854775807) to indicate that there is no throttle. This attribute is superseded by throttled_bandwidth_current_kbps.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>throttled_bandwidth_current_kbps</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as kilobits per second or as -1 to indicate that there is no throttle.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>subnet_network</maml:name> <maml:description> <maml:para>Subnet used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>subnet_netmask</maml:name> <maml:description> <maml:para>Subnet mask used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volume_collection_list</maml:name> <maml:description> <maml:para>List of volume collections that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_collection_list_count</maml:name> <maml:description> <maml:para>Count of volume collections that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_list_count</maml:name> <maml:description> <maml:para>Count of volumes that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>replication_direction</maml:name> <maml:description> <maml:para>Direction of replication configured with this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSReplicationPartner</command:name> <maml:description> <maml:para>List the replication partners available.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSReplicationPartner</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List the replication partners available.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for a replication partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of replication partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of replication partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of replication partner used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of replication partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>partner_type</maml:name> <maml:description> <maml:para>Replication partner type. Possible values are group or pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>alias</maml:name> <maml:description> <maml:para>Name this group uses to identify itself to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>secret</maml:name> <maml:description> <maml:para>Replication partner shared secret, used for mutual authentication of the partners.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this replication partner was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this replication partner was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>control_port</maml:name> <maml:description> <maml:para>Port number of partner control interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>hostname</maml:name> <maml:description> <maml:para>IP address or hostname of partner interface. This must be the partner's Group Management IP address.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>port_range_start</maml:name> <maml:description> <maml:para>For tunnel_endpoint partner types, first port available on the ssh proxy available for reverse forwarding. It must be guaranteed that the proxy has the next N ports reserved for this partner, where N is the count of DSDs in this group. This attribute is only valid for tunnel_endpoint partner type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>proxy_hostname</maml:name> <maml:description> <maml:para>IP address of tunnel endpoint. Only valid for tunnel_endpoint partner types.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>proxy_user</maml:name> <maml:description> <maml:para>User to authenticate with tunnel endpoint. Only valid for tunnel_endpoint partner types.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_hostname</maml:name> <maml:description> <maml:para>IP address or hostname of partner data interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>data_port</maml:name> <maml:description> <maml:para>Port number of partner data interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_alive</maml:name> <maml:description> <maml:para>Whether the partner is available, and responding to pings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>partner_group_uid</maml:name> <maml:description> <maml:para>Replication partner group uid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_keepalive_error</maml:name> <maml:description> <maml:para>Most recent error while attempting to ping the partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cfg_sync_status</maml:name> <maml:description> <maml:para>Indicates whether all volumes and volume collections have been synced to the partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_sync_error</maml:name> <maml:description> <maml:para>Most recent error seen while attempting to sync objects to the partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_serial</maml:name> <maml:description> <maml:para>Serial number of group leader array of the partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>version</maml:name> <maml:description> <maml:para>Replication version of the partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>The pool ID where volumes replicated from this partner will be created. Replica volumes created as clones ignore this parameter and are always created in the same pool as their parent volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>The pool name where volumes replicated from this partner will be created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folder_id</maml:name> <maml:description> <maml:para>The Folder ID within the pool where volumes replicated from this partner will be created. This is not supported for pool partners.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folder_name</maml:name> <maml:description> <maml:para>The Folder name within the pool where volumes replicated from this partner will be created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>match_folder</maml:name> <maml:description> <maml:para>Indicates whether to match the upstream volume's folder on the downstream.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>paused</maml:name> <maml:description> <maml:para>Indicates whether replication traffic from/to this partner has been halted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>unique_name</maml:name> <maml:description> <maml:para>Indicates whether this partner actively mangles object names to avoid name conflicts during replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>subnet_label</maml:name> <maml:description> <maml:para>Label of the subnet used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>subnet_type</maml:name> <maml:description> <maml:para>Type of the subnet used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>throttles</maml:name> <maml:description> <maml:para>Throttles used while replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>throttled_bandwidth</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as megabits per second or as the largest possible 64-bit signed integer (9223372036854775807) to indicate that there is no throttle. This attribute is superseded by throttled_bandwidth_current.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>throttled_bandwidth_current</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as megabits per second or as -1 to indicate that there is no throttle.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>throttled_bandwidth_kbps</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as kilobits per second or as the largest possible 64-bit signed integer (9223372036854775807) to indicate that there is no throttle. This attribute is superseded by throttled_bandwidth_current_kbps.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>throttled_bandwidth_current_kbps</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as kilobits per second or as -1 to indicate that there is no throttle.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>subnet_network</maml:name> <maml:description> <maml:para>Subnet used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>subnet_netmask</maml:name> <maml:description> <maml:para>Subnet mask used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_collection_list</maml:name> <maml:description> <maml:para>List of volume collections that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_collection_list_count</maml:name> <maml:description> <maml:para>Count of volume collections that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_list_count</maml:name> <maml:description> <maml:para>Count of volumes that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replication_direction</maml:name> <maml:description> <maml:para>Direction of replication configured with this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for a replication partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of replication partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of replication partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of replication partner used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of replication partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>partner_type</maml:name> <maml:description> <maml:para>Replication partner type. Possible values are group or pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>alias</maml:name> <maml:description> <maml:para>Name this group uses to identify itself to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>secret</maml:name> <maml:description> <maml:para>Replication partner shared secret, used for mutual authentication of the partners.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this replication partner was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this replication partner was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>control_port</maml:name> <maml:description> <maml:para>Port number of partner control interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>hostname</maml:name> <maml:description> <maml:para>IP address or hostname of partner interface. This must be the partner's Group Management IP address.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>port_range_start</maml:name> <maml:description> <maml:para>For tunnel_endpoint partner types, first port available on the ssh proxy available for reverse forwarding. It must be guaranteed that the proxy has the next N ports reserved for this partner, where N is the count of DSDs in this group. This attribute is only valid for tunnel_endpoint partner type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>proxy_hostname</maml:name> <maml:description> <maml:para>IP address of tunnel endpoint. Only valid for tunnel_endpoint partner types.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>proxy_user</maml:name> <maml:description> <maml:para>User to authenticate with tunnel endpoint. Only valid for tunnel_endpoint partner types.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>repl_hostname</maml:name> <maml:description> <maml:para>IP address or hostname of partner data interface.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>data_port</maml:name> <maml:description> <maml:para>Port number of partner data interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_alive</maml:name> <maml:description> <maml:para>Whether the partner is available, and responding to pings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>partner_group_uid</maml:name> <maml:description> <maml:para>Replication partner group uid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_keepalive_error</maml:name> <maml:description> <maml:para>Most recent error while attempting to ping the partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>cfg_sync_status</maml:name> <maml:description> <maml:para>Indicates whether all volumes and volume collections have been synced to the partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>last_sync_error</maml:name> <maml:description> <maml:para>Most recent error seen while attempting to sync objects to the partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>array_serial</maml:name> <maml:description> <maml:para>Serial number of group leader array of the partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>version</maml:name> <maml:description> <maml:para>Replication version of the partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>The pool ID where volumes replicated from this partner will be created. Replica volumes created as clones ignore this parameter and are always created in the same pool as their parent volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>The pool name where volumes replicated from this partner will be created.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>folder_id</maml:name> <maml:description> <maml:para>The Folder ID within the pool where volumes replicated from this partner will be created. This is not supported for pool partners.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>folder_name</maml:name> <maml:description> <maml:para>The Folder name within the pool where volumes replicated from this partner will be created.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>match_folder</maml:name> <maml:description> <maml:para>Indicates whether to match the upstream volume's folder on the downstream.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>paused</maml:name> <maml:description> <maml:para>Indicates whether replication traffic from/to this partner has been halted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>unique_name</maml:name> <maml:description> <maml:para>Indicates whether this partner actively mangles object names to avoid name conflicts during replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>subnet_label</maml:name> <maml:description> <maml:para>Label of the subnet used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>subnet_type</maml:name> <maml:description> <maml:para>Type of the subnet used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>throttles</maml:name> <maml:description> <maml:para>Throttles used while replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>throttled_bandwidth</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as megabits per second or as the largest possible 64-bit signed integer (9223372036854775807) to indicate that there is no throttle. This attribute is superseded by throttled_bandwidth_current.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>throttled_bandwidth_current</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as megabits per second or as -1 to indicate that there is no throttle.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>throttled_bandwidth_kbps</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as kilobits per second or as the largest possible 64-bit signed integer (9223372036854775807) to indicate that there is no throttle. This attribute is superseded by throttled_bandwidth_current_kbps.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>throttled_bandwidth_current_kbps</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as kilobits per second or as -1 to indicate that there is no throttle.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>subnet_network</maml:name> <maml:description> <maml:para>Subnet used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>subnet_netmask</maml:name> <maml:description> <maml:para>Subnet mask used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volume_collection_list</maml:name> <maml:description> <maml:para>List of volume collections that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_collection_list_count</maml:name> <maml:description> <maml:para>Count of volume collections that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_list_count</maml:name> <maml:description> <maml:para>Count of volumes that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>replication_direction</maml:name> <maml:description> <maml:para>Direction of replication configured with this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSReplicationPartner</command:name> <maml:description> <maml:para>Modify attributes of a replication partner.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSReplicationPartner</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Modify attributes of a replication partner.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for a replication partner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of replication partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of replication partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of replication partner used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of replication partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>partner_type</maml:name> <maml:description> <maml:para>Replication partner type. Possible values are group or pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>alias</maml:name> <maml:description> <maml:para>Name this group uses to identify itself to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>secret</maml:name> <maml:description> <maml:para>Replication partner shared secret, used for mutual authentication of the partners.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this replication partner was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this replication partner was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>control_port</maml:name> <maml:description> <maml:para>Port number of partner control interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>hostname</maml:name> <maml:description> <maml:para>IP address or hostname of partner interface. This must be the partner's Group Management IP address.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>port_range_start</maml:name> <maml:description> <maml:para>For tunnel_endpoint partner types, first port available on the ssh proxy available for reverse forwarding. It must be guaranteed that the proxy has the next N ports reserved for this partner, where N is the count of DSDs in this group. This attribute is only valid for tunnel_endpoint partner type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>proxy_hostname</maml:name> <maml:description> <maml:para>IP address of tunnel endpoint. Only valid for tunnel_endpoint partner types.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>proxy_user</maml:name> <maml:description> <maml:para>User to authenticate with tunnel endpoint. Only valid for tunnel_endpoint partner types.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_hostname</maml:name> <maml:description> <maml:para>IP address or hostname of partner data interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>data_port</maml:name> <maml:description> <maml:para>Port number of partner data interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_alive</maml:name> <maml:description> <maml:para>Whether the partner is available, and responding to pings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>partner_group_uid</maml:name> <maml:description> <maml:para>Replication partner group uid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_keepalive_error</maml:name> <maml:description> <maml:para>Most recent error while attempting to ping the partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cfg_sync_status</maml:name> <maml:description> <maml:para>Indicates whether all volumes and volume collections have been synced to the partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_sync_error</maml:name> <maml:description> <maml:para>Most recent error seen while attempting to sync objects to the partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_serial</maml:name> <maml:description> <maml:para>Serial number of group leader array of the partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>version</maml:name> <maml:description> <maml:para>Replication version of the partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>The pool ID where volumes replicated from this partner will be created. Replica volumes created as clones ignore this parameter and are always created in the same pool as their parent volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>The pool name where volumes replicated from this partner will be created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folder_id</maml:name> <maml:description> <maml:para>The Folder ID within the pool where volumes replicated from this partner will be created. This is not supported for pool partners.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folder_name</maml:name> <maml:description> <maml:para>The Folder name within the pool where volumes replicated from this partner will be created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>match_folder</maml:name> <maml:description> <maml:para>Indicates whether to match the upstream volume's folder on the downstream.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>paused</maml:name> <maml:description> <maml:para>Indicates whether replication traffic from/to this partner has been halted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>unique_name</maml:name> <maml:description> <maml:para>Indicates whether this partner actively mangles object names to avoid name conflicts during replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>subnet_label</maml:name> <maml:description> <maml:para>Label of the subnet used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>subnet_type</maml:name> <maml:description> <maml:para>Type of the subnet used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>throttles</maml:name> <maml:description> <maml:para>Throttles used while replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>throttled_bandwidth</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as megabits per second or as the largest possible 64-bit signed integer (9223372036854775807) to indicate that there is no throttle. This attribute is superseded by throttled_bandwidth_current.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>throttled_bandwidth_current</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as megabits per second or as -1 to indicate that there is no throttle.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>throttled_bandwidth_kbps</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as kilobits per second or as the largest possible 64-bit signed integer (9223372036854775807) to indicate that there is no throttle. This attribute is superseded by throttled_bandwidth_current_kbps.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>throttled_bandwidth_current_kbps</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as kilobits per second or as -1 to indicate that there is no throttle.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>subnet_network</maml:name> <maml:description> <maml:para>Subnet used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>subnet_netmask</maml:name> <maml:description> <maml:para>Subnet mask used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_collection_list</maml:name> <maml:description> <maml:para>List of volume collections that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_collection_list_count</maml:name> <maml:description> <maml:para>Count of volume collections that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_list_count</maml:name> <maml:description> <maml:para>Count of volumes that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replication_direction</maml:name> <maml:description> <maml:para>Direction of replication configured with this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for a replication partner.</maml:para> </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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of replication partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of replication partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of replication partner used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of replication partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>partner_type</maml:name> <maml:description> <maml:para>Replication partner type. Possible values are group or pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>alias</maml:name> <maml:description> <maml:para>Name this group uses to identify itself to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>secret</maml:name> <maml:description> <maml:para>Replication partner shared secret, used for mutual authentication of the partners.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this replication partner was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this replication partner was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>control_port</maml:name> <maml:description> <maml:para>Port number of partner control interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>hostname</maml:name> <maml:description> <maml:para>IP address or hostname of partner interface. This must be the partner's Group Management IP address.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>port_range_start</maml:name> <maml:description> <maml:para>For tunnel_endpoint partner types, first port available on the ssh proxy available for reverse forwarding. It must be guaranteed that the proxy has the next N ports reserved for this partner, where N is the count of DSDs in this group. This attribute is only valid for tunnel_endpoint partner type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>proxy_hostname</maml:name> <maml:description> <maml:para>IP address of tunnel endpoint. Only valid for tunnel_endpoint partner types.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>proxy_user</maml:name> <maml:description> <maml:para>User to authenticate with tunnel endpoint. Only valid for tunnel_endpoint partner types.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>repl_hostname</maml:name> <maml:description> <maml:para>IP address or hostname of partner data interface.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>data_port</maml:name> <maml:description> <maml:para>Port number of partner data interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_alive</maml:name> <maml:description> <maml:para>Whether the partner is available, and responding to pings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>partner_group_uid</maml:name> <maml:description> <maml:para>Replication partner group uid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_keepalive_error</maml:name> <maml:description> <maml:para>Most recent error while attempting to ping the partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>cfg_sync_status</maml:name> <maml:description> <maml:para>Indicates whether all volumes and volume collections have been synced to the partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>last_sync_error</maml:name> <maml:description> <maml:para>Most recent error seen while attempting to sync objects to the partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>array_serial</maml:name> <maml:description> <maml:para>Serial number of group leader array of the partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>version</maml:name> <maml:description> <maml:para>Replication version of the partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>The pool ID where volumes replicated from this partner will be created. Replica volumes created as clones ignore this parameter and are always created in the same pool as their parent volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>The pool name where volumes replicated from this partner will be created.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>folder_id</maml:name> <maml:description> <maml:para>The Folder ID within the pool where volumes replicated from this partner will be created. This is not supported for pool partners.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>folder_name</maml:name> <maml:description> <maml:para>The Folder name within the pool where volumes replicated from this partner will be created.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>match_folder</maml:name> <maml:description> <maml:para>Indicates whether to match the upstream volume's folder on the downstream.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>paused</maml:name> <maml:description> <maml:para>Indicates whether replication traffic from/to this partner has been halted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>unique_name</maml:name> <maml:description> <maml:para>Indicates whether this partner actively mangles object names to avoid name conflicts during replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>subnet_label</maml:name> <maml:description> <maml:para>Label of the subnet used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>subnet_type</maml:name> <maml:description> <maml:para>Type of the subnet used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>throttles</maml:name> <maml:description> <maml:para>Throttles used while replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>throttled_bandwidth</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as megabits per second or as the largest possible 64-bit signed integer (9223372036854775807) to indicate that there is no throttle. This attribute is superseded by throttled_bandwidth_current.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>throttled_bandwidth_current</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as megabits per second or as -1 to indicate that there is no throttle.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>throttled_bandwidth_kbps</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as kilobits per second or as the largest possible 64-bit signed integer (9223372036854775807) to indicate that there is no throttle. This attribute is superseded by throttled_bandwidth_current_kbps.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>throttled_bandwidth_current_kbps</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as kilobits per second or as -1 to indicate that there is no throttle.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>subnet_network</maml:name> <maml:description> <maml:para>Subnet used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>subnet_netmask</maml:name> <maml:description> <maml:para>Subnet mask used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volume_collection_list</maml:name> <maml:description> <maml:para>List of volume collections that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_collection_list_count</maml:name> <maml:description> <maml:para>Count of volume collections that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_list_count</maml:name> <maml:description> <maml:para>Count of volumes that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>replication_direction</maml:name> <maml:description> <maml:para>Direction of replication configured with this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSReplicationPartner</command:name> <maml:description> <maml:para>Delete a replication partner.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSReplicationPartner</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Delete a replication partner.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for a replication partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of replication partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of replication partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of replication partner used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of replication partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>partner_type</maml:name> <maml:description> <maml:para>Replication partner type. Possible values are group or pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>alias</maml:name> <maml:description> <maml:para>Name this group uses to identify itself to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>secret</maml:name> <maml:description> <maml:para>Replication partner shared secret, used for mutual authentication of the partners.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this replication partner was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this replication partner was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>control_port</maml:name> <maml:description> <maml:para>Port number of partner control interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>hostname</maml:name> <maml:description> <maml:para>IP address or hostname of partner interface. This must be the partner's Group Management IP address.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>port_range_start</maml:name> <maml:description> <maml:para>For tunnel_endpoint partner types, first port available on the ssh proxy available for reverse forwarding. It must be guaranteed that the proxy has the next N ports reserved for this partner, where N is the count of DSDs in this group. This attribute is only valid for tunnel_endpoint partner type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>proxy_hostname</maml:name> <maml:description> <maml:para>IP address of tunnel endpoint. Only valid for tunnel_endpoint partner types.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>proxy_user</maml:name> <maml:description> <maml:para>User to authenticate with tunnel endpoint. Only valid for tunnel_endpoint partner types.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_hostname</maml:name> <maml:description> <maml:para>IP address or hostname of partner data interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>data_port</maml:name> <maml:description> <maml:para>Port number of partner data interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_alive</maml:name> <maml:description> <maml:para>Whether the partner is available, and responding to pings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>partner_group_uid</maml:name> <maml:description> <maml:para>Replication partner group uid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_keepalive_error</maml:name> <maml:description> <maml:para>Most recent error while attempting to ping the partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cfg_sync_status</maml:name> <maml:description> <maml:para>Indicates whether all volumes and volume collections have been synced to the partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_sync_error</maml:name> <maml:description> <maml:para>Most recent error seen while attempting to sync objects to the partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_serial</maml:name> <maml:description> <maml:para>Serial number of group leader array of the partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>version</maml:name> <maml:description> <maml:para>Replication version of the partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>The pool ID where volumes replicated from this partner will be created. Replica volumes created as clones ignore this parameter and are always created in the same pool as their parent volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>The pool name where volumes replicated from this partner will be created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folder_id</maml:name> <maml:description> <maml:para>The Folder ID within the pool where volumes replicated from this partner will be created. This is not supported for pool partners.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folder_name</maml:name> <maml:description> <maml:para>The Folder name within the pool where volumes replicated from this partner will be created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>match_folder</maml:name> <maml:description> <maml:para>Indicates whether to match the upstream volume's folder on the downstream.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>paused</maml:name> <maml:description> <maml:para>Indicates whether replication traffic from/to this partner has been halted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>unique_name</maml:name> <maml:description> <maml:para>Indicates whether this partner actively mangles object names to avoid name conflicts during replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>subnet_label</maml:name> <maml:description> <maml:para>Label of the subnet used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>subnet_type</maml:name> <maml:description> <maml:para>Type of the subnet used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>throttles</maml:name> <maml:description> <maml:para>Throttles used while replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>throttled_bandwidth</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as megabits per second or as the largest possible 64-bit signed integer (9223372036854775807) to indicate that there is no throttle. This attribute is superseded by throttled_bandwidth_current.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>throttled_bandwidth_current</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as megabits per second or as -1 to indicate that there is no throttle.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>throttled_bandwidth_kbps</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as kilobits per second or as the largest possible 64-bit signed integer (9223372036854775807) to indicate that there is no throttle. This attribute is superseded by throttled_bandwidth_current_kbps.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>throttled_bandwidth_current_kbps</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as kilobits per second or as -1 to indicate that there is no throttle.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>subnet_network</maml:name> <maml:description> <maml:para>Subnet used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>subnet_netmask</maml:name> <maml:description> <maml:para>Subnet mask used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_collection_list</maml:name> <maml:description> <maml:para>List of volume collections that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_collection_list_count</maml:name> <maml:description> <maml:para>Count of volume collections that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_list_count</maml:name> <maml:description> <maml:para>Count of volumes that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSReplicationPartner</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replication_direction</maml:name> <maml:description> <maml:para>Direction of replication configured with this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for a replication partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of replication partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of replication partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of replication partner used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of replication partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>partner_type</maml:name> <maml:description> <maml:para>Replication partner type. Possible values are group or pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>alias</maml:name> <maml:description> <maml:para>Name this group uses to identify itself to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>secret</maml:name> <maml:description> <maml:para>Replication partner shared secret, used for mutual authentication of the partners.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this replication partner was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this replication partner was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>control_port</maml:name> <maml:description> <maml:para>Port number of partner control interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>hostname</maml:name> <maml:description> <maml:para>IP address or hostname of partner interface. This must be the partner's Group Management IP address.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>port_range_start</maml:name> <maml:description> <maml:para>For tunnel_endpoint partner types, first port available on the ssh proxy available for reverse forwarding. It must be guaranteed that the proxy has the next N ports reserved for this partner, where N is the count of DSDs in this group. This attribute is only valid for tunnel_endpoint partner type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>proxy_hostname</maml:name> <maml:description> <maml:para>IP address of tunnel endpoint. Only valid for tunnel_endpoint partner types.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>proxy_user</maml:name> <maml:description> <maml:para>User to authenticate with tunnel endpoint. Only valid for tunnel_endpoint partner types.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>repl_hostname</maml:name> <maml:description> <maml:para>IP address or hostname of partner data interface.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>data_port</maml:name> <maml:description> <maml:para>Port number of partner data interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_alive</maml:name> <maml:description> <maml:para>Whether the partner is available, and responding to pings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>partner_group_uid</maml:name> <maml:description> <maml:para>Replication partner group uid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_keepalive_error</maml:name> <maml:description> <maml:para>Most recent error while attempting to ping the partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>cfg_sync_status</maml:name> <maml:description> <maml:para>Indicates whether all volumes and volume collections have been synced to the partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>last_sync_error</maml:name> <maml:description> <maml:para>Most recent error seen while attempting to sync objects to the partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>array_serial</maml:name> <maml:description> <maml:para>Serial number of group leader array of the partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>version</maml:name> <maml:description> <maml:para>Replication version of the partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>The pool ID where volumes replicated from this partner will be created. Replica volumes created as clones ignore this parameter and are always created in the same pool as their parent volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>The pool name where volumes replicated from this partner will be created.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>folder_id</maml:name> <maml:description> <maml:para>The Folder ID within the pool where volumes replicated from this partner will be created. This is not supported for pool partners.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>folder_name</maml:name> <maml:description> <maml:para>The Folder name within the pool where volumes replicated from this partner will be created.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>match_folder</maml:name> <maml:description> <maml:para>Indicates whether to match the upstream volume's folder on the downstream.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>paused</maml:name> <maml:description> <maml:para>Indicates whether replication traffic from/to this partner has been halted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>unique_name</maml:name> <maml:description> <maml:para>Indicates whether this partner actively mangles object names to avoid name conflicts during replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>subnet_label</maml:name> <maml:description> <maml:para>Label of the subnet used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>subnet_type</maml:name> <maml:description> <maml:para>Type of the subnet used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>throttles</maml:name> <maml:description> <maml:para>Throttles used while replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>throttled_bandwidth</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as megabits per second or as the largest possible 64-bit signed integer (9223372036854775807) to indicate that there is no throttle. This attribute is superseded by throttled_bandwidth_current.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>throttled_bandwidth_current</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as megabits per second or as -1 to indicate that there is no throttle.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>throttled_bandwidth_kbps</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as kilobits per second or as the largest possible 64-bit signed integer (9223372036854775807) to indicate that there is no throttle. This attribute is superseded by throttled_bandwidth_current_kbps.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>throttled_bandwidth_current_kbps</maml:name> <maml:description> <maml:para>Current bandwidth throttle for this partner, expressed either as kilobits per second or as -1 to indicate that there is no throttle.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>subnet_network</maml:name> <maml:description> <maml:para>Subnet used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>subnet_netmask</maml:name> <maml:description> <maml:para>Subnet mask used to replicate to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volume_collection_list</maml:name> <maml:description> <maml:para>List of volume collections that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_collection_list_count</maml:name> <maml:description> <maml:para>Count of volume collections that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_list_count</maml:name> <maml:description> <maml:para>Count of volumes that are replicating from/to this partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>replication_direction</maml:name> <maml:description> <maml:para>Direction of replication configured with this partner.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Suspend-NSReplicationPartner</command:name> <maml:description> <maml:para>Pause replication for the specified partner.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Suspe</command:verb> <command:noun>-NSReplicationPartner</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Pause replication for the specified partner.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Suspend-NSReplicationPartner</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the partner to pause.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the partner to pause.</maml:para> </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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Resume-NSReplicationPartner</command:name> <maml:description> <maml:para>Resume replication for the specified partner.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Resum</command:verb> <command:noun>-NSReplicationPartner</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Resume replication for the specified partner.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Resume-NSReplicationPartner</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the partner to resume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the partner to resume.</maml:para> </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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-NSReplicationPartner</command:name> <maml:description> <maml:para>Test connectivity to the specified partner.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test-</command:verb> <command:noun>-NSReplicationPartner</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Test connectivity to the specified partner.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-NSReplicationPartner</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the partner to test.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the partner to test.</maml:para> </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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSTrustedOauthIssuer</command:name> <maml:description> <maml:para>Creates a trusted issuer with its public key.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSTrustedOauthIssuer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Creates a trusted issuer with its public key.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSTrustedOauthIssuer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the trusted oauth issuer record.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSTrustedOauthIssuer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Issuer ID string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSTrustedOauthIssuer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>jwks_url</maml:name> <maml:description> <maml:para>The URL from which the device will download the public key set for signature verification.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSTrustedOauthIssuer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>key_set</maml:name> <maml:description> <maml:para>List of public keys for verifying signatures.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the trusted oauth issuer record.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Issuer ID 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="true (ByValue)" position="named"> <maml:name>jwks_url</maml:name> <maml:description> <maml:para>The URL from which the device will download the public key set for signature verification.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>key_set</maml:name> <maml:description> <maml:para>List of public keys for verifying signatures.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSTrustedOauthIssuer</command:name> <maml:description> <maml:para>List the set of trusted oauth issuers or a details about a particular trusted oauth issuer.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSTrustedOauthIssuer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List the set of trusted oauth issuers or a details about a particular trusted oauth issuer.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSTrustedOauthIssuer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the trusted oauth issuer record.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSTrustedOauthIssuer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Issuer ID string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSTrustedOauthIssuer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>jwks_url</maml:name> <maml:description> <maml:para>The URL from which the device will download the public key set for signature verification.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSTrustedOauthIssuer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>key_set</maml:name> <maml:description> <maml:para>List of public keys for verifying signatures.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the trusted oauth issuer record.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Issuer ID string.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>jwks_url</maml:name> <maml:description> <maml:para>The URL from which the device will download the public key set for signature verification.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>key_set</maml:name> <maml:description> <maml:para>List of public keys for verifying signatures.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSMasterKey</command:name> <maml:description> <maml:para>Create master key.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSMasterKey</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Create master key.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSMasterKey</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier of the master key.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSMasterKey</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the master key. The only allowed value is "default".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSMasterKey</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>passphrase</maml:name> <maml:description> <maml:para>Passphrase used to protect the master key, required during creation, enabling/disabling the key and change the passphrase to a new value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSMasterKey</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>halfkey</maml:name> <maml:description> <maml:para>When changing the passphrase, this authenticates the change operation, for support use only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSMasterKey</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>new_passphrase</maml:name> <maml:description> <maml:para>When changing the passphrase, this attribute specifies the new value of the passphrase.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSMasterKey</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>active</maml:name> <maml:description> <maml:para>Whether the master key is active or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSMasterKey</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>purge_age</maml:name> <maml:description> <maml:para>Default minimum age (in hours) of inactive encryption keys to be purged. '0' indicates to purge keys immediately.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier of the master key.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the master key. The only allowed value is "default".</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>passphrase</maml:name> <maml:description> <maml:para>Passphrase used to protect the master key, required during creation, enabling/disabling the key and change the passphrase to a new value.</maml:para> </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="true (ByValue)" position="named"> <maml:name>halfkey</maml:name> <maml:description> <maml:para>When changing the passphrase, this authenticates the change operation, for support use only.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>new_passphrase</maml:name> <maml:description> <maml:para>When changing the passphrase, this attribute specifies the new value of the passphrase.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>active</maml:name> <maml:description> <maml:para>Whether the master key is active or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>purge_age</maml:name> <maml:description> <maml:para>Default minimum age (in hours) of inactive encryption keys to be purged. '0' indicates to purge keys immediately.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSMasterKey</command:name> <maml:description> <maml:para>Read master key status.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSMasterKey</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Read master key status.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSMasterKey</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier of the master key.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSMasterKey</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the master key. The only allowed value is "default".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSMasterKey</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>passphrase</maml:name> <maml:description> <maml:para>Passphrase used to protect the master key, required during creation, enabling/disabling the key and change the passphrase to a new value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSMasterKey</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>halfkey</maml:name> <maml:description> <maml:para>When changing the passphrase, this authenticates the change operation, for support use only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSMasterKey</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>new_passphrase</maml:name> <maml:description> <maml:para>When changing the passphrase, this attribute specifies the new value of the passphrase.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSMasterKey</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>active</maml:name> <maml:description> <maml:para>Whether the master key is active or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSMasterKey</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>purge_age</maml:name> <maml:description> <maml:para>Default minimum age (in hours) of inactive encryption keys to be purged. '0' indicates to purge keys immediately.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier of the master key.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the master key. The only allowed value is "default".</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>passphrase</maml:name> <maml:description> <maml:para>Passphrase used to protect the master key, required during creation, enabling/disabling the key and change the passphrase to a new value.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>halfkey</maml:name> <maml:description> <maml:para>When changing the passphrase, this authenticates the change operation, for support use only.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>new_passphrase</maml:name> <maml:description> <maml:para>When changing the passphrase, this attribute specifies the new value of the passphrase.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>active</maml:name> <maml:description> <maml:para>Whether the master key is active or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>purge_age</maml:name> <maml:description> <maml:para>Default minimum age (in hours) of inactive encryption keys to be purged. '0' indicates to purge keys immediately.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSMasterKey</command:name> <maml:description> <maml:para>Enable/disable the master key or change the passphrase to a new value, 'passphrase' attribute is always required. Updating 'active' attribute to enable or disable the master key. Updating 'new_passphrase' attribute to change the passphrase to a new value. Changing the activeness and the passphrase of the key are not allowed in the same update.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSMasterKey</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Enable/disable the master key or change the passphrase to a new value, 'passphrase' attribute is always required. Updating 'active' attribute to enable or disable the master key. Updating 'new_passphrase' attribute to change the passphrase to a new value. Changing the activeness and the passphrase of the key are not allowed in the same update.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSMasterKey</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier of the master key.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSMasterKey</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the master key. The only allowed value is "default".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSMasterKey</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>passphrase</maml:name> <maml:description> <maml:para>Passphrase used to protect the master key, required during creation, enabling/disabling the key and change the passphrase to a new value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSMasterKey</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>halfkey</maml:name> <maml:description> <maml:para>When changing the passphrase, this authenticates the change operation, for support use only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSMasterKey</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>new_passphrase</maml:name> <maml:description> <maml:para>When changing the passphrase, this attribute specifies the new value of the passphrase.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSMasterKey</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>active</maml:name> <maml:description> <maml:para>Whether the master key is active or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSMasterKey</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>purge_age</maml:name> <maml:description> <maml:para>Default minimum age (in hours) of inactive encryption keys to be purged. '0' indicates to purge keys immediately.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier of the master key.</maml:para> </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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the master key. The only allowed value is "default".</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>passphrase</maml:name> <maml:description> <maml:para>Passphrase used to protect the master key, required during creation, enabling/disabling the key and change the passphrase to a new value.</maml:para> </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="true (ByValue)" position="named"> <maml:name>halfkey</maml:name> <maml:description> <maml:para>When changing the passphrase, this authenticates the change operation, for support use only.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>new_passphrase</maml:name> <maml:description> <maml:para>When changing the passphrase, this attribute specifies the new value of the passphrase.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>active</maml:name> <maml:description> <maml:para>Whether the master key is active or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>purge_age</maml:name> <maml:description> <maml:para>Default minimum age (in hours) of inactive encryption keys to be purged. '0' indicates to purge keys immediately.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSMasterKey</command:name> <maml:description> <maml:para>Delete master key.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSMasterKey</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Delete master key.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSMasterKey</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier of the master key.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSMasterKey</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the master key. The only allowed value is "default".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSMasterKey</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>passphrase</maml:name> <maml:description> <maml:para>Passphrase used to protect the master key, required during creation, enabling/disabling the key and change the passphrase to a new value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSMasterKey</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>halfkey</maml:name> <maml:description> <maml:para>When changing the passphrase, this authenticates the change operation, for support use only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSMasterKey</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>new_passphrase</maml:name> <maml:description> <maml:para>When changing the passphrase, this attribute specifies the new value of the passphrase.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSMasterKey</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>active</maml:name> <maml:description> <maml:para>Whether the master key is active or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSMasterKey</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>purge_age</maml:name> <maml:description> <maml:para>Default minimum age (in hours) of inactive encryption keys to be purged. '0' indicates to purge keys immediately.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier of the master key.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the master key. The only allowed value is "default".</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>passphrase</maml:name> <maml:description> <maml:para>Passphrase used to protect the master key, required during creation, enabling/disabling the key and change the passphrase to a new value.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>halfkey</maml:name> <maml:description> <maml:para>When changing the passphrase, this authenticates the change operation, for support use only.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>new_passphrase</maml:name> <maml:description> <maml:para>When changing the passphrase, this attribute specifies the new value of the passphrase.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>active</maml:name> <maml:description> <maml:para>Whether the master key is active or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>purge_age</maml:name> <maml:description> <maml:para>Default minimum age (in hours) of inactive encryption keys to be purged. '0' indicates to purge keys immediately.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Clear-NSMasterKeyInactive</command:name> <maml:description> <maml:para>Purges encryption keys that have been inactive for the age or longer. If you do not specify an age, the keys will be purged immediately.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>-NSMasterKeyInactive</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Purges encryption keys that have been inactive for the age or longer. If you do not specify an age, the keys will be purged immediately.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-NSMasterKeyInactive</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the master key.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Clear-NSMasterKeyInactive</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>age</maml:name> <maml:description> <maml:para>Minimum age (in hours) of inactive encryption keys to be purged. '0' indicates to purge the keys immediately.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the master key.</maml:para> </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="true (ByValue)" position="named"> <maml:name>age</maml:name> <maml:description> <maml:para>Minimum age (in hours) of inactive encryption keys to be purged. '0' indicates to purge the keys immediately.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSEvent</command:name> <maml:description> <maml:para>List a set of event records or a single event record.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSEvent</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List a set of event records or a single event record.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSEvent</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the event record.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSEvent</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>Type of the event record.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSEvent</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of alert macro to generate.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSEvent</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>scope</maml:name> <maml:description> <maml:para>The array name for array level event.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSEvent</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>target</maml:name> <maml:description> <maml:para>Name of object upon which the event occurred.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSEvent</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>target_type</maml:name> <maml:description> <maml:para>Target type of the event record.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSEvent</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>timestamp</maml:name> <maml:description> <maml:para>Time when this event happened.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSEvent</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>category</maml:name> <maml:description> <maml:para>Category of the event record.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSEvent</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>severity</maml:name> <maml:description> <maml:para>Severity level of the event.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSEvent</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>summary</maml:name> <maml:description> <maml:para>Summary of the event.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSEvent</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>activity</maml:name> <maml:description> <maml:para>Description of the event.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSEvent</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>alarm_id</maml:name> <maml:description> <maml:para>The alarm ID if the event is related to an alarm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSEvent</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>params</maml:name> <maml:description> <maml:para>Arguments provided for event creation in key-value structure. Until KV implementation for events, will ignore keys (though keys must be non-empty) and take values positionally.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSEvent</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Tenant ID of the event. This is used to determine what tenant context the event belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the event record.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>Type of the event record.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of alert macro to generate.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>scope</maml:name> <maml:description> <maml:para>The array name for array level event.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>target</maml:name> <maml:description> <maml:para>Name of object upon which the event occurred.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>target_type</maml:name> <maml:description> <maml:para>Target type of the event record.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>timestamp</maml:name> <maml:description> <maml:para>Time when this event happened.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>category</maml:name> <maml:description> <maml:para>Category of the event record.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>severity</maml:name> <maml:description> <maml:para>Severity level of the event.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>summary</maml:name> <maml:description> <maml:para>Summary of the event.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>activity</maml:name> <maml:description> <maml:para>Description of the event.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>alarm_id</maml:name> <maml:description> <maml:para>The alarm ID if the event is related to an alarm.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>params</maml:name> <maml:description> <maml:para>Arguments provided for event creation in key-value structure. Until KV implementation for events, will ignore keys (though keys must be non-empty) and take values positionally.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Tenant ID of the event. This is used to determine what tenant context the event belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSApplicationServer</command:name> <maml:description> <maml:para>Create a new application server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSApplicationServer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Create a new application server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the application server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSApplicationServer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name for the application server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSApplicationServer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>hostname</maml:name> <maml:description> <maml:para>Application server hostname.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>Application server port number.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>Application server username.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of application server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Application server password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>server_type</maml:name> <maml:description> <maml:para>Application server type ({invalid|vss|vmware|cisco|stack_vision|container_node}).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment an application server's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this application server was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this application server was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the application server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name for the application 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="true (ByValue)" position="named"> <maml:name>hostname</maml:name> <maml:description> <maml:para>Application server hostname.</maml:para> </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="true (ByValue)" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>Application server port number.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>Application server username.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of application server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Application server password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>server_type</maml:name> <maml:description> <maml:para>Application server type ({invalid|vss|vmware|cisco|stack_vision|container_node}).</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment an application server's attributes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this application server was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this application server was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> New-NSApplicatinServer -name 10.18.237.115 -hostname TestCreate1 name id description ---- -- ----------- 10.18.237.115 2928eada7f8dd99d3b000000000000000000000048 </dev:code> <dev:remarks> <maml:para>This command will Create a new Application Server using the bare minimum fields required. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 2 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> New-NSApplicationServer -name TestCreate2 -hostname 10.18.238.159 -port 1337 -username MyUser -password MySecret -description "My Wordy Description" -server_type vss name id description ---- -- ----------- TestCreate2 2928eada7f8dd99d3b000000000000000000000049 My Wordy Description </dev:code> <dev:remarks> <maml:para>This command will Create a new Application Server using all of the fields. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSApplicationServer</command:name> <maml:description> <maml:para>List application servers.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSApplicationServer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List application servers.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the application server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name for the application server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>hostname</maml:name> <maml:description> <maml:para>Application server hostname.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>Application server port number.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>Application server username.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of application server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Application server password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>server_type</maml:name> <maml:description> <maml:para>Application server type ({invalid|vss|vmware|cisco|stack_vision|container_node}).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment an application server's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this application server was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this application server was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the application server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name for the application server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>hostname</maml:name> <maml:description> <maml:para>Application server hostname.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>Application server port number.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>Application server username.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of application server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Application server password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>server_type</maml:name> <maml:description> <maml:para>Application server type ({invalid|vss|vmware|cisco|stack_vision|container_node}).</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment an application server's attributes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this application server was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this application server was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSApplicatinServer name id description ---- -- ----------- TestServer1 2928eada7f8dd99d3b000000000000000000000001 My First Test Server TestServer2 2928eada7f8dd99d3b000000000000000000000002 My Second Test Server TestServer3 2928eada7f8dd99d3b000000000000000000000003 My Second Test Server TestCreate1 2928eada7f8dd99d3b000000000000000000000020 TestCreate2 2928eada7f8dd99d3b000000000000000000000046 My Wordy Description 10.18.237.115 2928eada7f8dd99d3b000000000000000000000047 Adding A Description </dev:code> <dev:remarks> <maml:para>This command will retrieves list of current Application Server. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 2 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSApplicatinServer -name TestServer1 name id description ---- -- ----------- TestServer1 2928eada7f8dd99d3b000000000000000000000001 My First Test Server </dev:code> <dev:remarks> <maml:para>This command will retrieve a specific Application Server specified by name. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSApplicationServer</command:name> <maml:description> <maml:para>Modify attributes of the specified application server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSApplicationServer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Modify attributes of the specified application server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSApplicationServer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the application server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name for the application server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>hostname</maml:name> <maml:description> <maml:para>Application server hostname.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>Application server port number.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>Application server username.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of application server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Application server password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>server_type</maml:name> <maml:description> <maml:para>Application server type ({invalid|vss|vmware|cisco|stack_vision|container_node}).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment an application server's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this application server was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this application server was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the application 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name for the application server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>hostname</maml:name> <maml:description> <maml:para>Application server hostname.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>Application server port number.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>Application server username.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of application server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Application server password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>server_type</maml:name> <maml:description> <maml:para>Application server type ({invalid|vss|vmware|cisco|stack_vision|container_node}).</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment an application server's attributes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this application server was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this application server was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Set-NSApplicatinServer -id 2928eada7f8dd99d3b00000000000000000000004a -description "Adding A Description" name id description ---- -- ----------- 10.18.237.115 2928eada7f8dd99d3b00000000000000000000004a Adding A Description </dev:code> <dev:remarks> <maml:para>This command will add a description to an existing Application Server. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSApplicationServer</command:name> <maml:description> <maml:para>Delete the specified application server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSApplicationServer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Delete the specified application server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the application server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name for the application server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>hostname</maml:name> <maml:description> <maml:para>Application server hostname.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>Application server port number.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>Application server username.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of application server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Application server password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>server_type</maml:name> <maml:description> <maml:para>Application server type ({invalid|vss|vmware|cisco|stack_vision|container_node}).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment an application server's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this application server was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSApplicationServer</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this application server was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the application server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name for the application server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>hostname</maml:name> <maml:description> <maml:para>Application server hostname.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>Application server port number.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>Application server username.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of application server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Application server password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>server_type</maml:name> <maml:description> <maml:para>Application server type ({invalid|vss|vmware|cisco|stack_vision|container_node}).</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment an application server's attributes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this application server was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this application server was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Remove-NSApplicatinServer -id 2928eada7f8dd99d3b000000000000000000000048 </dev:code> <dev:remarks> <maml:para>This command will remove Application Server using the supplied ID number. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSFibreChannelPort</command:name> <maml:description> <maml:para>List a set of Fibre Channel ports for all reachable arrays or a set of Fibre Channel ports for a single array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSFibreChannelPort</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List a set of Fibre Channel ports for all reachable arrays or a set of Fibre Channel ports for a single array.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSFibreChannelPort</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelPort</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_name_or_serial</maml:name> <maml:description> <maml:para>Name or serial number of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelPort</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>controller_name</maml:name> <maml:description> <maml:para>Name (A or B) of the controller to which the port belongs.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelPort</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fc_port_name</maml:name> <maml:description> <maml:para>Name of the Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelPort</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>bus_location</maml:name> <maml:description> <maml:para>PCI bus location of the HBA (Host Bus Adapter) for this Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelPort</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>HBA (Host Bus Adapter) port number for this Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelPort</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>slot</maml:name> <maml:description> <maml:para>HBA (Host Bus Adapter) slot number for this Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelPort</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>orientation</maml:name> <maml:description> <maml:para>Orientation of FC ports on a HBA. An orientation of 'right_to_left' indicates that ports are ordered as 3,2,1,0 on the slot. Possible values: 'left_to_right', 'right_to_left'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelPort</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>link_info</maml:name> <maml:description> <maml:para>Information about the Fibre Channel link associated with this port.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelPort</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>rx_power</maml:name> <maml:description> <maml:para>SFP RX power in uW.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelPort</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tx_power</maml:name> <maml:description> <maml:para>SFP TX power in uW.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>array_name_or_serial</maml:name> <maml:description> <maml:para>Name or serial number of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>controller_name</maml:name> <maml:description> <maml:para>Name (A or B) of the controller to which the port belongs.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>fc_port_name</maml:name> <maml:description> <maml:para>Name of the Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>bus_location</maml:name> <maml:description> <maml:para>PCI bus location of the HBA (Host Bus Adapter) for this Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>HBA (Host Bus Adapter) port number for this Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>slot</maml:name> <maml:description> <maml:para>HBA (Host Bus Adapter) slot number for this Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>orientation</maml:name> <maml:description> <maml:para>Orientation of FC ports on a HBA. An orientation of 'right_to_left' indicates that ports are ordered as 3,2,1,0 on the slot. Possible values: 'left_to_right', 'right_to_left'.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>link_info</maml:name> <maml:description> <maml:para>Information about the Fibre Channel link associated with this port.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>rx_power</maml:name> <maml:description> <maml:para>SFP RX power in uW.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>tx_power</maml:name> <maml:description> <maml:para>SFP TX power in uW.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSLdapDomain</command:name> <maml:description> <maml:para>Given a unique domain name, create an LDAP domain for the group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSLdapDomain</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Given a unique domain name, create an LDAP domain for the group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the LDAP Domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSLdapDomain</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>domain_name</maml:name> <maml:description> <maml:para>Domain name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>domain_description</maml:name> <maml:description> <maml:para>Description of the domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>domain_enabled</maml:name> <maml:description> <maml:para>Indicates whether the LDAP domain is currently active or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSLdapDomain</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>server_uri_list</maml:name> <maml:description> <maml:para>A set of up to 3 LDAP URIs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>bind_user</maml:name> <maml:description> <maml:para>Full Distinguished Name of LDAP admin user. If empty, attempt to bind anonymously.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>bind_password</maml:name> <maml:description> <maml:para>Password for the Full Distinguished Name of LDAP admin user. This parameter is mandatory if the bind_user is given.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>base_dn</maml:name> <maml:description> <maml:para>The Distinguished Name of the base object from which to start all searches.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user_search_filter</maml:name> <maml:description> <maml:para>Limit the results returned based on specific search criteria.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user_search_base_list</maml:name> <maml:description> <maml:para>A set of upto 10 Relative Distinguished Names, relative to the Base DN, from which to search for User objects.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group_search_filter</maml:name> <maml:description> <maml:para>Limit the results returned based on specific search criteria.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group_search_base_list</maml:name> <maml:description> <maml:para>A set of upto 10 Relative Distinguished Names, relative to the Base DN, from which to search for Group objects.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSLdapDomain</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>schema_type</maml:name> <maml:description> <maml:para>Enum values are OpenLDAP or AD.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the LDAP Domain.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>domain_name</maml:name> <maml:description> <maml:para>Domain name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>domain_description</maml:name> <maml:description> <maml:para>Description of the domain.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>domain_enabled</maml:name> <maml:description> <maml:para>Indicates whether the LDAP domain is currently active or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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>server_uri_list</maml:name> <maml:description> <maml:para>A set of up to 3 LDAP URIs.</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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>bind_user</maml:name> <maml:description> <maml:para>Full Distinguished Name of LDAP admin user. If empty, attempt to bind anonymously.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>bind_password</maml:name> <maml:description> <maml:para>Password for the Full Distinguished Name of LDAP admin user. This parameter is mandatory if the bind_user is given.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>base_dn</maml:name> <maml:description> <maml:para>The Distinguished Name of the base object from which to start all searches.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>user_search_filter</maml:name> <maml:description> <maml:para>Limit the results returned based on specific search criteria.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>user_search_base_list</maml:name> <maml:description> <maml:para>A set of upto 10 Relative Distinguished Names, relative to the Base DN, from which to search for User objects.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>group_search_filter</maml:name> <maml:description> <maml:para>Limit the results returned based on specific search criteria.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>group_search_base_list</maml:name> <maml:description> <maml:para>A set of upto 10 Relative Distinguished Names, relative to the Base DN, from which to search for Group objects.</maml:para> </maml:description> <command:parameterValue required="false" 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="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>schema_type</maml:name> <maml:description> <maml:para>Enum values are OpenLDAP or AD.</maml:para> </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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSLdapDomain</command:name> <maml:description> <maml:para>List the LDAP Information.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSLdapDomain</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List the LDAP Information.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the LDAP Domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>domain_name</maml:name> <maml:description> <maml:para>Domain name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>domain_description</maml:name> <maml:description> <maml:para>Description of the domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>domain_enabled</maml:name> <maml:description> <maml:para>Indicates whether the LDAP domain is currently active or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>server_uri_list</maml:name> <maml:description> <maml:para>A set of up to 3 LDAP URIs.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>bind_user</maml:name> <maml:description> <maml:para>Full Distinguished Name of LDAP admin user. If empty, attempt to bind anonymously.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>bind_password</maml:name> <maml:description> <maml:para>Password for the Full Distinguished Name of LDAP admin user. This parameter is mandatory if the bind_user is given.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>base_dn</maml:name> <maml:description> <maml:para>The Distinguished Name of the base object from which to start all searches.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user_search_filter</maml:name> <maml:description> <maml:para>Limit the results returned based on specific search criteria.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user_search_base_list</maml:name> <maml:description> <maml:para>A set of upto 10 Relative Distinguished Names, relative to the Base DN, from which to search for User objects.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group_search_filter</maml:name> <maml:description> <maml:para>Limit the results returned based on specific search criteria.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group_search_base_list</maml:name> <maml:description> <maml:para>A set of upto 10 Relative Distinguished Names, relative to the Base DN, from which to search for Group objects.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>schema_type</maml:name> <maml:description> <maml:para>Enum values are OpenLDAP or AD.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the LDAP Domain.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>domain_name</maml:name> <maml:description> <maml:para>Domain name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>domain_description</maml:name> <maml:description> <maml:para>Description of the domain.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>domain_enabled</maml:name> <maml:description> <maml:para>Indicates whether the LDAP domain is currently active or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>server_uri_list</maml:name> <maml:description> <maml:para>A set of up to 3 LDAP URIs.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>bind_user</maml:name> <maml:description> <maml:para>Full Distinguished Name of LDAP admin user. If empty, attempt to bind anonymously.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>bind_password</maml:name> <maml:description> <maml:para>Password for the Full Distinguished Name of LDAP admin user. This parameter is mandatory if the bind_user is given.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>base_dn</maml:name> <maml:description> <maml:para>The Distinguished Name of the base object from which to start all searches.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>user_search_filter</maml:name> <maml:description> <maml:para>Limit the results returned based on specific search criteria.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>user_search_base_list</maml:name> <maml:description> <maml:para>A set of upto 10 Relative Distinguished Names, relative to the Base DN, from which to search for User objects.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>group_search_filter</maml:name> <maml:description> <maml:para>Limit the results returned based on specific search criteria.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>group_search_base_list</maml:name> <maml:description> <maml:para>A set of upto 10 Relative Distinguished Names, relative to the Base DN, from which to search for Group objects.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>schema_type</maml:name> <maml:description> <maml:para>Enum values are OpenLDAP or AD.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSLdapDomain</command:name> <maml:description> <maml:para>Updates the LDAP configuration.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSLdapDomain</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Updates the LDAP configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSLdapDomain</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the LDAP Domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>domain_name</maml:name> <maml:description> <maml:para>Domain name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>domain_description</maml:name> <maml:description> <maml:para>Description of the domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>domain_enabled</maml:name> <maml:description> <maml:para>Indicates whether the LDAP domain is currently active or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>server_uri_list</maml:name> <maml:description> <maml:para>A set of up to 3 LDAP URIs.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>bind_user</maml:name> <maml:description> <maml:para>Full Distinguished Name of LDAP admin user. If empty, attempt to bind anonymously.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>bind_password</maml:name> <maml:description> <maml:para>Password for the Full Distinguished Name of LDAP admin user. This parameter is mandatory if the bind_user is given.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>base_dn</maml:name> <maml:description> <maml:para>The Distinguished Name of the base object from which to start all searches.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user_search_filter</maml:name> <maml:description> <maml:para>Limit the results returned based on specific search criteria.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user_search_base_list</maml:name> <maml:description> <maml:para>A set of upto 10 Relative Distinguished Names, relative to the Base DN, from which to search for User objects.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group_search_filter</maml:name> <maml:description> <maml:para>Limit the results returned based on specific search criteria.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group_search_base_list</maml:name> <maml:description> <maml:para>A set of upto 10 Relative Distinguished Names, relative to the Base DN, from which to search for Group objects.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>schema_type</maml:name> <maml:description> <maml:para>Enum values are OpenLDAP or AD.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the LDAP 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="true (ByValue)" position="named"> <maml:name>domain_name</maml:name> <maml:description> <maml:para>Domain name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>domain_description</maml:name> <maml:description> <maml:para>Description of the domain.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>domain_enabled</maml:name> <maml:description> <maml:para>Indicates whether the LDAP domain is currently active or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>server_uri_list</maml:name> <maml:description> <maml:para>A set of up to 3 LDAP URIs.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>bind_user</maml:name> <maml:description> <maml:para>Full Distinguished Name of LDAP admin user. If empty, attempt to bind anonymously.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>bind_password</maml:name> <maml:description> <maml:para>Password for the Full Distinguished Name of LDAP admin user. This parameter is mandatory if the bind_user is given.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>base_dn</maml:name> <maml:description> <maml:para>The Distinguished Name of the base object from which to start all searches.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>user_search_filter</maml:name> <maml:description> <maml:para>Limit the results returned based on specific search criteria.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>user_search_base_list</maml:name> <maml:description> <maml:para>A set of upto 10 Relative Distinguished Names, relative to the Base DN, from which to search for User objects.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>group_search_filter</maml:name> <maml:description> <maml:para>Limit the results returned based on specific search criteria.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>group_search_base_list</maml:name> <maml:description> <maml:para>A set of upto 10 Relative Distinguished Names, relative to the Base DN, from which to search for Group objects.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>schema_type</maml:name> <maml:description> <maml:para>Enum values are OpenLDAP or AD.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSLdapDomain</command:name> <maml:description> <maml:para>Delete the LDAP configuration.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSLdapDomain</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Delete the LDAP configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the LDAP Domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>domain_name</maml:name> <maml:description> <maml:para>Domain name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>domain_description</maml:name> <maml:description> <maml:para>Description of the domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>domain_enabled</maml:name> <maml:description> <maml:para>Indicates whether the LDAP domain is currently active or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>server_uri_list</maml:name> <maml:description> <maml:para>A set of up to 3 LDAP URIs.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>bind_user</maml:name> <maml:description> <maml:para>Full Distinguished Name of LDAP admin user. If empty, attempt to bind anonymously.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>bind_password</maml:name> <maml:description> <maml:para>Password for the Full Distinguished Name of LDAP admin user. This parameter is mandatory if the bind_user is given.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>base_dn</maml:name> <maml:description> <maml:para>The Distinguished Name of the base object from which to start all searches.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user_search_filter</maml:name> <maml:description> <maml:para>Limit the results returned based on specific search criteria.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user_search_base_list</maml:name> <maml:description> <maml:para>A set of upto 10 Relative Distinguished Names, relative to the Base DN, from which to search for User objects.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group_search_filter</maml:name> <maml:description> <maml:para>Limit the results returned based on specific search criteria.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group_search_base_list</maml:name> <maml:description> <maml:para>A set of upto 10 Relative Distinguished Names, relative to the Base DN, from which to search for Group objects.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSLdapDomain</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>schema_type</maml:name> <maml:description> <maml:para>Enum values are OpenLDAP or AD.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the LDAP Domain.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>domain_name</maml:name> <maml:description> <maml:para>Domain name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>domain_description</maml:name> <maml:description> <maml:para>Description of the domain.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>domain_enabled</maml:name> <maml:description> <maml:para>Indicates whether the LDAP domain is currently active or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>server_uri_list</maml:name> <maml:description> <maml:para>A set of up to 3 LDAP URIs.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>bind_user</maml:name> <maml:description> <maml:para>Full Distinguished Name of LDAP admin user. If empty, attempt to bind anonymously.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>bind_password</maml:name> <maml:description> <maml:para>Password for the Full Distinguished Name of LDAP admin user. This parameter is mandatory if the bind_user is given.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>base_dn</maml:name> <maml:description> <maml:para>The Distinguished Name of the base object from which to start all searches.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>user_search_filter</maml:name> <maml:description> <maml:para>Limit the results returned based on specific search criteria.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>user_search_base_list</maml:name> <maml:description> <maml:para>A set of upto 10 Relative Distinguished Names, relative to the Base DN, from which to search for User objects.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>group_search_filter</maml:name> <maml:description> <maml:para>Limit the results returned based on specific search criteria.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>group_search_base_list</maml:name> <maml:description> <maml:para>A set of upto 10 Relative Distinguished Names, relative to the Base DN, from which to search for Group objects.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>schema_type</maml:name> <maml:description> <maml:para>Enum values are OpenLDAP or AD.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-NSLdapDomainUser</command:name> <maml:description> <maml:para>Tests whether the user exist in the given LDAP Domain.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test-</command:verb> <command:noun>-NSLdapDomainUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Tests whether the user exist in the given LDAP Domain.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-NSLdapDomainUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Unique identifier for the LDAP Domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-NSLdapDomainUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user</maml:name> <maml:description> <maml:para>Name of the LDAP Domain user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Unique identifier for the LDAP 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="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>user</maml:name> <maml:description> <maml:para>Name of the LDAP Domain user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-NSLdapDomainGroup</command:name> <maml:description> <maml:para>Tests whether the user group exist in the given LDAP Domain.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test-</command:verb> <command:noun>-NSLdapDomainGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Tests whether the user group exist in the given LDAP Domain.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-NSLdapDomainGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Unique identifier for the LDAP Domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-NSLdapDomainGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group</maml:name> <maml:description> <maml:para>Name of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Unique identifier for the LDAP 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="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>group</maml:name> <maml:description> <maml:para>Name of 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-NSLdapDomain</command:name> <maml:description> <maml:para>Reports the LDAP connectivity status of the given LDAP ID.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test-</command:verb> <command:noun>-NSLdapDomain</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Reports the LDAP connectivity status of the given LDAP ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-NSLdapDomain</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Unique identifier for the LDAP Domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Unique identifier for the LDAP 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSVersion</command:name> <maml:description> <maml:para>Read API versions.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSVersion</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Read API versions.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSVersion</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>API version number.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVersion</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>software_version</maml:name> <maml:description> <maml:para>Software version of the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>API version number.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>software_version</maml:name> <maml:description> <maml:para>Software version of the group.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSInitiator</command:name> <maml:description> <maml:para>Create an initiator used for authentication.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSInitiator</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Create an initiator used for authentication.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for initiator.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiator</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Access protocol used by the initiator. Valid values are 'iscsi' and 'fc'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiator</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>initiator_group_id</maml:name> <maml:description> <maml:para>Identifier of the initiator group that this initiator is assigned to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>initiator_group_name</maml:name> <maml:description> <maml:para>Name of the initiator group that this initiator is assigned to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>label</maml:name> <maml:description> <maml:para>Unique Identifier of the iSCSI initiator. Label is required when creating iSCSI initiator.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iqn</maml:name> <maml:description> <maml:para>IQN name of the iSCSI initiator. Each initiator IQN name must have an associated IP address specified using the 'ip_address' attribute. You can choose not to enter the IP address for an initiator if you prefer not to authenticate using both name and IP address, in this case the IP address will be returned as '*'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ip_address</maml:name> <maml:description> <maml:para>IP address of the iSCSI initiator. Each initiator IP address must have an associated name specified using 'name' attribute. You can choose not to enter the name for an initiator if you prefer not to authenticate using both name and IP address, in this case the IQN name will be returned as '*'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>alias</maml:name> <maml:description> <maml:para>Alias of the Fibre Channel initiator. Maximum alias length is 32 characters. Each initiator alias must have an associated WWPN specified using the 'wwpn' attribute. You can choose not to enter the WWPN for an initiator when using previously saved initiator alias.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>chapuser_id</maml:name> <maml:description> <maml:para>Identifier for the CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>wwpn</maml:name> <maml:description> <maml:para>WWPN (World Wide Port Name) of the Fibre Channel initiator. WWPN is required when creating a Fibre Channel initiator. Each initiator WWPN can have an associated alias specified using the 'alias' attribute. You can choose not to enter the alias for an initiator if you prefer not to assign an initiator alias.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vp_override</maml:name> <maml:description> <maml:para>Flag to allow modifying VP created initiator groups. When set to true, user can add this initiator to a VP created initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this initiator group was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this initiator group was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>override_existing_alias</maml:name> <maml:description> <maml:para>Forcibly add Fibre Channel initiator to initiator group by updating or removing conflicting Fibre Channel initiator aliases.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for initiator.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Access protocol used by the initiator. Valid values are 'iscsi' and 'fc'.</maml:para> </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="true (ByValue)" position="named"> <maml:name>initiator_group_id</maml:name> <maml:description> <maml:para>Identifier of the initiator group that this initiator is assigned to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>initiator_group_name</maml:name> <maml:description> <maml:para>Name of the initiator group that this initiator is assigned to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>label</maml:name> <maml:description> <maml:para>Unique Identifier of the iSCSI initiator. Label is required when creating iSCSI initiator.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>iqn</maml:name> <maml:description> <maml:para>IQN name of the iSCSI initiator. Each initiator IQN name must have an associated IP address specified using the 'ip_address' attribute. You can choose not to enter the IP address for an initiator if you prefer not to authenticate using both name and IP address, in this case the IP address will be returned as '*'.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>ip_address</maml:name> <maml:description> <maml:para>IP address of the iSCSI initiator. Each initiator IP address must have an associated name specified using 'name' attribute. You can choose not to enter the name for an initiator if you prefer not to authenticate using both name and IP address, in this case the IQN name will be returned as '*'.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>alias</maml:name> <maml:description> <maml:para>Alias of the Fibre Channel initiator. Maximum alias length is 32 characters. Each initiator alias must have an associated WWPN specified using the 'wwpn' attribute. You can choose not to enter the WWPN for an initiator when using previously saved initiator alias.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>chapuser_id</maml:name> <maml:description> <maml:para>Identifier for the CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>wwpn</maml:name> <maml:description> <maml:para>WWPN (World Wide Port Name) of the Fibre Channel initiator. WWPN is required when creating a Fibre Channel initiator. Each initiator WWPN can have an associated alias specified using the 'alias' attribute. You can choose not to enter the alias for an initiator if you prefer not to assign an initiator alias.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vp_override</maml:name> <maml:description> <maml:para>Flag to allow modifying VP created initiator groups. When set to true, user can add this initiator to a VP created initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this initiator group was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this initiator group was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>override_existing_alias</maml:name> <maml:description> <maml:para>Forcibly add Fibre Channel initiator to initiator group by updating or removing conflicting Fibre Channel initiator aliases.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> New-NSInitiator -label TestInitiator-134 -initiator_group_id 0228eada7f8dd99d3b000000000000000000000057 -access_protocol iscsi -iqn "iqn.2007-11.com.storage:TEST3" Label IQN WWPN ----- --- ---- TestInitiator-134 iqn.2007-11.com.storage:TEST3 </dev:code> <dev:remarks> <maml:para>This command create a new initiator group. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSInitiator</command:name> <maml:description> <maml:para>List a set of initiators used for authentication.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSInitiator</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List a set of initiators used for authentication.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for initiator.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Access protocol used by the initiator. Valid values are 'iscsi' and 'fc'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>initiator_group_id</maml:name> <maml:description> <maml:para>Identifier of the initiator group that this initiator is assigned to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>initiator_group_name</maml:name> <maml:description> <maml:para>Name of the initiator group that this initiator is assigned to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>label</maml:name> <maml:description> <maml:para>Unique Identifier of the iSCSI initiator. Label is required when creating iSCSI initiator.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iqn</maml:name> <maml:description> <maml:para>IQN name of the iSCSI initiator. Each initiator IQN name must have an associated IP address specified using the 'ip_address' attribute. You can choose not to enter the IP address for an initiator if you prefer not to authenticate using both name and IP address, in this case the IP address will be returned as '*'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ip_address</maml:name> <maml:description> <maml:para>IP address of the iSCSI initiator. Each initiator IP address must have an associated name specified using 'name' attribute. You can choose not to enter the name for an initiator if you prefer not to authenticate using both name and IP address, in this case the IQN name will be returned as '*'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>alias</maml:name> <maml:description> <maml:para>Alias of the Fibre Channel initiator. Maximum alias length is 32 characters. Each initiator alias must have an associated WWPN specified using the 'wwpn' attribute. You can choose not to enter the WWPN for an initiator when using previously saved initiator alias.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>chapuser_id</maml:name> <maml:description> <maml:para>Identifier for the CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>wwpn</maml:name> <maml:description> <maml:para>WWPN (World Wide Port Name) of the Fibre Channel initiator. WWPN is required when creating a Fibre Channel initiator. Each initiator WWPN can have an associated alias specified using the 'alias' attribute. You can choose not to enter the alias for an initiator if you prefer not to assign an initiator alias.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vp_override</maml:name> <maml:description> <maml:para>Flag to allow modifying VP created initiator groups. When set to true, user can add this initiator to a VP created initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this initiator group was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this initiator group was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>override_existing_alias</maml:name> <maml:description> <maml:para>Forcibly add Fibre Channel initiator to initiator group by updating or removing conflicting Fibre Channel initiator aliases.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for initiator.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Access protocol used by the initiator. Valid values are 'iscsi' and 'fc'.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>initiator_group_id</maml:name> <maml:description> <maml:para>Identifier of the initiator group that this initiator is assigned to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>initiator_group_name</maml:name> <maml:description> <maml:para>Name of the initiator group that this initiator is assigned to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>label</maml:name> <maml:description> <maml:para>Unique Identifier of the iSCSI initiator. Label is required when creating iSCSI initiator.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>iqn</maml:name> <maml:description> <maml:para>IQN name of the iSCSI initiator. Each initiator IQN name must have an associated IP address specified using the 'ip_address' attribute. You can choose not to enter the IP address for an initiator if you prefer not to authenticate using both name and IP address, in this case the IP address will be returned as '*'.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>ip_address</maml:name> <maml:description> <maml:para>IP address of the iSCSI initiator. Each initiator IP address must have an associated name specified using 'name' attribute. You can choose not to enter the name for an initiator if you prefer not to authenticate using both name and IP address, in this case the IQN name will be returned as '*'.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>alias</maml:name> <maml:description> <maml:para>Alias of the Fibre Channel initiator. Maximum alias length is 32 characters. Each initiator alias must have an associated WWPN specified using the 'wwpn' attribute. You can choose not to enter the WWPN for an initiator when using previously saved initiator alias.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>chapuser_id</maml:name> <maml:description> <maml:para>Identifier for the CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>wwpn</maml:name> <maml:description> <maml:para>WWPN (World Wide Port Name) of the Fibre Channel initiator. WWPN is required when creating a Fibre Channel initiator. Each initiator WWPN can have an associated alias specified using the 'alias' attribute. You can choose not to enter the alias for an initiator if you prefer not to assign an initiator alias.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vp_override</maml:name> <maml:description> <maml:para>Flag to allow modifying VP created initiator groups. When set to true, user can add this initiator to a VP created initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this initiator group was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this initiator group was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>override_existing_alias</maml:name> <maml:description> <maml:para>Forcibly add Fibre Channel initiator to initiator group by updating or removing conflicting Fibre Channel initiator aliases.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSInitiator</command:name> <maml:description> <maml:para>Delete the specified initiator.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSInitiator</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Delete the specified initiator.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for initiator.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Access protocol used by the initiator. Valid values are 'iscsi' and 'fc'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>initiator_group_id</maml:name> <maml:description> <maml:para>Identifier of the initiator group that this initiator is assigned to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>initiator_group_name</maml:name> <maml:description> <maml:para>Name of the initiator group that this initiator is assigned to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>label</maml:name> <maml:description> <maml:para>Unique Identifier of the iSCSI initiator. Label is required when creating iSCSI initiator.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iqn</maml:name> <maml:description> <maml:para>IQN name of the iSCSI initiator. Each initiator IQN name must have an associated IP address specified using the 'ip_address' attribute. You can choose not to enter the IP address for an initiator if you prefer not to authenticate using both name and IP address, in this case the IP address will be returned as '*'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ip_address</maml:name> <maml:description> <maml:para>IP address of the iSCSI initiator. Each initiator IP address must have an associated name specified using 'name' attribute. You can choose not to enter the name for an initiator if you prefer not to authenticate using both name and IP address, in this case the IQN name will be returned as '*'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>alias</maml:name> <maml:description> <maml:para>Alias of the Fibre Channel initiator. Maximum alias length is 32 characters. Each initiator alias must have an associated WWPN specified using the 'wwpn' attribute. You can choose not to enter the WWPN for an initiator when using previously saved initiator alias.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>chapuser_id</maml:name> <maml:description> <maml:para>Identifier for the CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>wwpn</maml:name> <maml:description> <maml:para>WWPN (World Wide Port Name) of the Fibre Channel initiator. WWPN is required when creating a Fibre Channel initiator. Each initiator WWPN can have an associated alias specified using the 'alias' attribute. You can choose not to enter the alias for an initiator if you prefer not to assign an initiator alias.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vp_override</maml:name> <maml:description> <maml:para>Flag to allow modifying VP created initiator groups. When set to true, user can add this initiator to a VP created initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this initiator group was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this initiator group was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiator</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>override_existing_alias</maml:name> <maml:description> <maml:para>Forcibly add Fibre Channel initiator to initiator group by updating or removing conflicting Fibre Channel initiator aliases.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for initiator.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Access protocol used by the initiator. Valid values are 'iscsi' and 'fc'.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>initiator_group_id</maml:name> <maml:description> <maml:para>Identifier of the initiator group that this initiator is assigned to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>initiator_group_name</maml:name> <maml:description> <maml:para>Name of the initiator group that this initiator is assigned to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>label</maml:name> <maml:description> <maml:para>Unique Identifier of the iSCSI initiator. Label is required when creating iSCSI initiator.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>iqn</maml:name> <maml:description> <maml:para>IQN name of the iSCSI initiator. Each initiator IQN name must have an associated IP address specified using the 'ip_address' attribute. You can choose not to enter the IP address for an initiator if you prefer not to authenticate using both name and IP address, in this case the IP address will be returned as '*'.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>ip_address</maml:name> <maml:description> <maml:para>IP address of the iSCSI initiator. Each initiator IP address must have an associated name specified using 'name' attribute. You can choose not to enter the name for an initiator if you prefer not to authenticate using both name and IP address, in this case the IQN name will be returned as '*'.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>alias</maml:name> <maml:description> <maml:para>Alias of the Fibre Channel initiator. Maximum alias length is 32 characters. Each initiator alias must have an associated WWPN specified using the 'wwpn' attribute. You can choose not to enter the WWPN for an initiator when using previously saved initiator alias.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>chapuser_id</maml:name> <maml:description> <maml:para>Identifier for the CHAP user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>wwpn</maml:name> <maml:description> <maml:para>WWPN (World Wide Port Name) of the Fibre Channel initiator. WWPN is required when creating a Fibre Channel initiator. Each initiator WWPN can have an associated alias specified using the 'alias' attribute. You can choose not to enter the alias for an initiator if you prefer not to assign an initiator alias.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vp_override</maml:name> <maml:description> <maml:para>Flag to allow modifying VP created initiator groups. When set to true, user can add this initiator to a VP created initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this initiator group was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this initiator group was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>override_existing_alias</maml:name> <maml:description> <maml:para>Forcibly add Fibre Channel initiator to initiator group by updating or removing conflicting Fibre Channel initiator aliases.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Remove-NSInitiator -id 0b28eada7f8dd99d3b000000000000000000000026 </dev:code> <dev:remarks> <maml:para>This command will remove an initiator specified by its ID. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSSubscriber</command:name> <maml:description> <maml:para>Create a subscriber.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSSubscriber</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Create a subscriber.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for subscriber.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSubscriber</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>This is generally used to indicate the type of subscriber e.g. SMIS/GUI/ThirdParty etc. This is free form and doesn't need to be unique.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>renew_interval</maml:name> <maml:description> <maml:para>The interval in seconds within which the subscriber is expected to send a renew message over the websocket channel in case there is no traffic on the websocket channel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>renew_response_timeout</maml:name> <maml:description> <maml:para>The interval in seconds after the subscriber sends a renew message within which the subscriber expects to get a response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_connected</maml:name> <maml:description> <maml:para>True if the subscriber has an active websocket connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>notification_count</maml:name> <maml:description> <maml:para>Number of notifications sent to subscriber.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly modify a connected subscriber.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for subscriber.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>This is generally used to indicate the type of subscriber e.g. SMIS/GUI/ThirdParty etc. This is free form and doesn't need to be unique.</maml:para> </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="true (ByValue)" position="named"> <maml:name>renew_interval</maml:name> <maml:description> <maml:para>The interval in seconds within which the subscriber is expected to send a renew message over the websocket channel in case there is no traffic on the websocket channel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>renew_response_timeout</maml:name> <maml:description> <maml:para>The interval in seconds after the subscriber sends a renew message within which the subscriber expects to get a response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_connected</maml:name> <maml:description> <maml:para>True if the subscriber has an active websocket connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>notification_count</maml:name> <maml:description> <maml:para>Number of notifications sent to subscriber.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly modify a connected subscriber.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSSubscriber</command:name> <maml:description> <maml:para>Retrieve information about a single subscriber or all subscribers.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSSubscriber</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Retrieve information about a single subscriber or all subscribers.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for subscriber.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>This is generally used to indicate the type of subscriber e.g. SMIS/GUI/ThirdParty etc. This is free form and doesn't need to be unique.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>renew_interval</maml:name> <maml:description> <maml:para>The interval in seconds within which the subscriber is expected to send a renew message over the websocket channel in case there is no traffic on the websocket channel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>renew_response_timeout</maml:name> <maml:description> <maml:para>The interval in seconds after the subscriber sends a renew message within which the subscriber expects to get a response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_connected</maml:name> <maml:description> <maml:para>True if the subscriber has an active websocket connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>notification_count</maml:name> <maml:description> <maml:para>Number of notifications sent to subscriber.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly modify a connected subscriber.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for subscriber.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>This is generally used to indicate the type of subscriber e.g. SMIS/GUI/ThirdParty etc. This is free form and doesn't need to be unique.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>renew_interval</maml:name> <maml:description> <maml:para>The interval in seconds within which the subscriber is expected to send a renew message over the websocket channel in case there is no traffic on the websocket channel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>renew_response_timeout</maml:name> <maml:description> <maml:para>The interval in seconds after the subscriber sends a renew message within which the subscriber expects to get a response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_connected</maml:name> <maml:description> <maml:para>True if the subscriber has an active websocket connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>notification_count</maml:name> <maml:description> <maml:para>Number of notifications sent to subscriber.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly modify a connected subscriber.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSSubscriber</command:name> <maml:description> <maml:para>Modify subscriber attributes. Use 'force=true' to modify the renew intervals for a subscriber that is actively connected via websocket.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSSubscriber</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Modify subscriber attributes. Use 'force=true' to modify the renew intervals for a subscriber that is actively connected via websocket.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for subscriber.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>This is generally used to indicate the type of subscriber e.g. SMIS/GUI/ThirdParty etc. This is free form and doesn't need to be unique.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>renew_interval</maml:name> <maml:description> <maml:para>The interval in seconds within which the subscriber is expected to send a renew message over the websocket channel in case there is no traffic on the websocket channel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>renew_response_timeout</maml:name> <maml:description> <maml:para>The interval in seconds after the subscriber sends a renew message within which the subscriber expects to get a response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_connected</maml:name> <maml:description> <maml:para>True if the subscriber has an active websocket connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>notification_count</maml:name> <maml:description> <maml:para>Number of notifications sent to subscriber.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly modify a connected subscriber.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for subscriber.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>This is generally used to indicate the type of subscriber e.g. SMIS/GUI/ThirdParty etc. This is free form and doesn't need to be unique.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>renew_interval</maml:name> <maml:description> <maml:para>The interval in seconds within which the subscriber is expected to send a renew message over the websocket channel in case there is no traffic on the websocket channel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>renew_response_timeout</maml:name> <maml:description> <maml:para>The interval in seconds after the subscriber sends a renew message within which the subscriber expects to get a response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_connected</maml:name> <maml:description> <maml:para>True if the subscriber has an active websocket connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>notification_count</maml:name> <maml:description> <maml:para>Number of notifications sent to subscriber.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly modify a connected subscriber.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSSubscriber</command:name> <maml:description> <maml:para>Delete the subscriber. Deleting the subscriber will cause all of its subscriptions to get deleted as well.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSSubscriber</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Delete the subscriber. Deleting the subscriber will cause all of its subscriptions to get deleted as well.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for subscriber.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>This is generally used to indicate the type of subscriber e.g. SMIS/GUI/ThirdParty etc. This is free form and doesn't need to be unique.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>renew_interval</maml:name> <maml:description> <maml:para>The interval in seconds within which the subscriber is expected to send a renew message over the websocket channel in case there is no traffic on the websocket channel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>renew_response_timeout</maml:name> <maml:description> <maml:para>The interval in seconds after the subscriber sends a renew message within which the subscriber expects to get a response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_connected</maml:name> <maml:description> <maml:para>True if the subscriber has an active websocket connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>notification_count</maml:name> <maml:description> <maml:para>Number of notifications sent to subscriber.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSubscriber</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly modify a connected subscriber.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for subscriber.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>This is generally used to indicate the type of subscriber e.g. SMIS/GUI/ThirdParty etc. This is free form and doesn't need to be unique.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>renew_interval</maml:name> <maml:description> <maml:para>The interval in seconds within which the subscriber is expected to send a renew message over the websocket channel in case there is no traffic on the websocket channel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>renew_response_timeout</maml:name> <maml:description> <maml:para>The interval in seconds after the subscriber sends a renew message within which the subscriber expects to get a response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_connected</maml:name> <maml:description> <maml:para>True if the subscriber has an active websocket connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>notification_count</maml:name> <maml:description> <maml:para>Number of notifications sent to subscriber.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly modify a connected subscriber.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSPerformancePolicy</command:name> <maml:description> <maml:para>Create performance policy.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSPerformancePolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Create performance policy.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Unique Identifier for the Performance Policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPerformancePolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the Performance Policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of the Performance Policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of the Performance Policy used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of a performance policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>block_size</maml:name> <maml:description> <maml:para>Block Size in bytes to be used by the volumes created with this specific performance policy. Supported block sizes are 4096 bytes (4 KB), 8192 bytes (8 KB), 16384 bytes(16 KB), and 32768 bytes (32 KB). Block size of a performance policy cannot be changed once the performance policy is created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compress</maml:name> <maml:description> <maml:para>Flag denoting if data in the associated volume should be compressed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache</maml:name> <maml:description> <maml:para>Flag denoting if data in the associated volume should be cached.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache_policy</maml:name> <maml:description> <maml:para>Specifies how data of associated volume should be cached. Supports two policies, 'normal' and 'aggressive'. 'normal' policy caches data but skips in certain conditions such as sequential I/O. 'aggressive' policy will accelerate caching of all data belonging to this volume, regardless of sequentiality.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>space_policy</maml:name> <maml:description> <maml:para>Specifies the state of the volume upon space constraint violation such as volume limit violation or volumes above their volume reserve, if the pool free space is exhausted. Supports two policies, 'offline' and 'non_writable'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_category</maml:name> <maml:description> <maml:para>Specifies the application category of the associated volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_enabled</maml:name> <maml:description> <maml:para>Specifies if dedupe is enabled for volumes created with this performance policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>deprecated</maml:name> <maml:description> <maml:para>Specifies if this performance policy is deprecated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>predefined</maml:name> <maml:description> <maml:para>Specifies if this performance policy is predefined (read-only).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when the performance policy was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when the performance policy's configurations were last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sample_rate</maml:name> <maml:description> <maml:para>Sample rate value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Number of volumes using this performance policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_override_pools</maml:name> <maml:description> <maml:para>List of pools that override performance policy's dedupe setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Unique Identifier for the Performance Policy.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the Performance 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of the Performance Policy.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of the Performance Policy used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of a performance policy.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>block_size</maml:name> <maml:description> <maml:para>Block Size in bytes to be used by the volumes created with this specific performance policy. Supported block sizes are 4096 bytes (4 KB), 8192 bytes (8 KB), 16384 bytes(16 KB), and 32768 bytes (32 KB). Block size of a performance policy cannot be changed once the performance policy is created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compress</maml:name> <maml:description> <maml:para>Flag denoting if data in the associated volume should be compressed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache</maml:name> <maml:description> <maml:para>Flag denoting if data in the associated volume should be cached.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache_policy</maml:name> <maml:description> <maml:para>Specifies how data of associated volume should be cached. Supports two policies, 'normal' and 'aggressive'. 'normal' policy caches data but skips in certain conditions such as sequential I/O. 'aggressive' policy will accelerate caching of all data belonging to this volume, regardless of sequentiality.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>space_policy</maml:name> <maml:description> <maml:para>Specifies the state of the volume upon space constraint violation such as volume limit violation or volumes above their volume reserve, if the pool free space is exhausted. Supports two policies, 'offline' and 'non_writable'.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_category</maml:name> <maml:description> <maml:para>Specifies the application category of the associated volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>dedupe_enabled</maml:name> <maml:description> <maml:para>Specifies if dedupe is enabled for volumes created with this performance policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>deprecated</maml:name> <maml:description> <maml:para>Specifies if this performance policy is deprecated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>predefined</maml:name> <maml:description> <maml:para>Specifies if this performance policy is predefined (read-only).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when the performance policy was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when the performance policy's configurations were last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>sample_rate</maml:name> <maml:description> <maml:para>Sample rate value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Number of volumes using this performance policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_override_pools</maml:name> <maml:description> <maml:para>List of pools that override performance policy's dedupe setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> New-NSPerformancePolicy -name MyTestPolicy1 name id app_category block_size description cache_policy compress dedupe_enabled predefined space_policy ---- -- ------------ ---------- ----------- ------------ -------- -------------- ---------- ------------ MyTestPolicy1 0328eada7f8dd99d3b000000000000000000000061 Unassigned 4096 normal True False False offline </dev:code> <dev:remarks> <maml:para>This command will create a new minimal performance policy from the array. Most settings such as block size will use the default 4K. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 2 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> New-NSPerformancePolicy -name MyTestPolicy2 -description "My Test Perf Policy" -block_size 8192 -compress True name id app_category block_size description cache_policy compress dedupe_enabled predefined space_policy ---- -- ------------ ---------- ----------- ------------ -------- -------------- ---------- ------------ MyTestPolicy2 0328eada7f8dd99d3b000000000000000000000062 Unassigned 8192 My Test Perf Policy normal True False False offline </dev:code> <dev:remarks> <maml:para>This command will create a common performance policy from the array. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSPerformancePolicy</command:name> <maml:description> <maml:para>List all the performance policies.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSPerformancePolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List all the performance policies.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Unique Identifier for the Performance Policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the Performance Policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of the Performance Policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of the Performance Policy used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of a performance policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>block_size</maml:name> <maml:description> <maml:para>Block Size in bytes to be used by the volumes created with this specific performance policy. Supported block sizes are 4096 bytes (4 KB), 8192 bytes (8 KB), 16384 bytes(16 KB), and 32768 bytes (32 KB). Block size of a performance policy cannot be changed once the performance policy is created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compress</maml:name> <maml:description> <maml:para>Flag denoting if data in the associated volume should be compressed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache</maml:name> <maml:description> <maml:para>Flag denoting if data in the associated volume should be cached.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache_policy</maml:name> <maml:description> <maml:para>Specifies how data of associated volume should be cached. Supports two policies, 'normal' and 'aggressive'. 'normal' policy caches data but skips in certain conditions such as sequential I/O. 'aggressive' policy will accelerate caching of all data belonging to this volume, regardless of sequentiality.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>space_policy</maml:name> <maml:description> <maml:para>Specifies the state of the volume upon space constraint violation such as volume limit violation or volumes above their volume reserve, if the pool free space is exhausted. Supports two policies, 'offline' and 'non_writable'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_category</maml:name> <maml:description> <maml:para>Specifies the application category of the associated volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_enabled</maml:name> <maml:description> <maml:para>Specifies if dedupe is enabled for volumes created with this performance policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>deprecated</maml:name> <maml:description> <maml:para>Specifies if this performance policy is deprecated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>predefined</maml:name> <maml:description> <maml:para>Specifies if this performance policy is predefined (read-only).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when the performance policy was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when the performance policy's configurations were last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sample_rate</maml:name> <maml:description> <maml:para>Sample rate value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Number of volumes using this performance policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_override_pools</maml:name> <maml:description> <maml:para>List of pools that override performance policy's dedupe setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Unique Identifier for the Performance Policy.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the Performance Policy.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of the Performance Policy.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of the Performance Policy used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of a performance policy.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>block_size</maml:name> <maml:description> <maml:para>Block Size in bytes to be used by the volumes created with this specific performance policy. Supported block sizes are 4096 bytes (4 KB), 8192 bytes (8 KB), 16384 bytes(16 KB), and 32768 bytes (32 KB). Block size of a performance policy cannot be changed once the performance policy is created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compress</maml:name> <maml:description> <maml:para>Flag denoting if data in the associated volume should be compressed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache</maml:name> <maml:description> <maml:para>Flag denoting if data in the associated volume should be cached.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache_policy</maml:name> <maml:description> <maml:para>Specifies how data of associated volume should be cached. Supports two policies, 'normal' and 'aggressive'. 'normal' policy caches data but skips in certain conditions such as sequential I/O. 'aggressive' policy will accelerate caching of all data belonging to this volume, regardless of sequentiality.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>space_policy</maml:name> <maml:description> <maml:para>Specifies the state of the volume upon space constraint violation such as volume limit violation or volumes above their volume reserve, if the pool free space is exhausted. Supports two policies, 'offline' and 'non_writable'.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_category</maml:name> <maml:description> <maml:para>Specifies the application category of the associated volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>dedupe_enabled</maml:name> <maml:description> <maml:para>Specifies if dedupe is enabled for volumes created with this performance policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>deprecated</maml:name> <maml:description> <maml:para>Specifies if this performance policy is deprecated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>predefined</maml:name> <maml:description> <maml:para>Specifies if this performance policy is predefined (read-only).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when the performance policy was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when the performance policy's configurations were last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>sample_rate</maml:name> <maml:description> <maml:para>Sample rate value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Number of volumes using this performance policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_override_pools</maml:name> <maml:description> <maml:para>List of pools that override performance policy's dedupe setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSPerformancePolicy name id app_category block_size description cache_policy ---- -- ------------ ---------- ----------- ------------ default 0328eada7f8dd99d3b000000000000000000000001 Other 4096 Default performance policy normal Exchange 2003 data store 0328eada7f8dd99d3b000000000000000000000002 Exchange 4096 Performance policy suitable for use with Microsoft Exchange 2003 data store normal Exchange 2007 data store 0328eada7f8dd99d3b000000000000000000000003 Exchange 8192 Performance policy suitable for use with Microsoft Exchange 2007 data store normal Exchange log 0328eada7f8dd99d3b000000000000000000000004 Exchange 16384 Performance policy suitable for use with Microsoft Exchange log normal </dev:code> <dev:remarks> <maml:para>This command will retrieve the initiator groups from the array. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 2 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> PS:> Get-NSPerformancePolicy -name SQL Server name id app_category block_size description cache_policy compress dedupe_enabled pre def ine d ---- -- ------------ ---------- ----------- ------------ -------- -------------- --- SQL Server 0328eada7f8dd99d3b000000000000000000000005 SQL Server 8192 Performance policy suitable for use with Microsoft SQL Server normal True False Tru </dev:code> <dev:remarks> <maml:para>This command will retrieve a specific Performance Policy from the array by name. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSPerformancePolicy</command:name> <maml:description> <maml:para>Update attributes of a performance policy. Block size of a performance policy cannot be changed once the perfomance policy is created.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSPerformancePolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Update attributes of a performance policy. Block size of a performance policy cannot be changed once the perfomance policy is created.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSPerformancePolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Unique Identifier for the Performance Policy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the Performance Policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of the Performance Policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of the Performance Policy used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of a performance policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>block_size</maml:name> <maml:description> <maml:para>Block Size in bytes to be used by the volumes created with this specific performance policy. Supported block sizes are 4096 bytes (4 KB), 8192 bytes (8 KB), 16384 bytes(16 KB), and 32768 bytes (32 KB). Block size of a performance policy cannot be changed once the performance policy is created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compress</maml:name> <maml:description> <maml:para>Flag denoting if data in the associated volume should be compressed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache</maml:name> <maml:description> <maml:para>Flag denoting if data in the associated volume should be cached.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache_policy</maml:name> <maml:description> <maml:para>Specifies how data of associated volume should be cached. Supports two policies, 'normal' and 'aggressive'. 'normal' policy caches data but skips in certain conditions such as sequential I/O. 'aggressive' policy will accelerate caching of all data belonging to this volume, regardless of sequentiality.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>space_policy</maml:name> <maml:description> <maml:para>Specifies the state of the volume upon space constraint violation such as volume limit violation or volumes above their volume reserve, if the pool free space is exhausted. Supports two policies, 'offline' and 'non_writable'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_category</maml:name> <maml:description> <maml:para>Specifies the application category of the associated volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_enabled</maml:name> <maml:description> <maml:para>Specifies if dedupe is enabled for volumes created with this performance policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>deprecated</maml:name> <maml:description> <maml:para>Specifies if this performance policy is deprecated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>predefined</maml:name> <maml:description> <maml:para>Specifies if this performance policy is predefined (read-only).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when the performance policy was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when the performance policy's configurations were last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sample_rate</maml:name> <maml:description> <maml:para>Sample rate value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Number of volumes using this performance policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_override_pools</maml:name> <maml:description> <maml:para>List of pools that override performance policy's dedupe setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Unique Identifier for the Performance 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the Performance Policy.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of the Performance Policy.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of the Performance Policy used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of a performance policy.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>block_size</maml:name> <maml:description> <maml:para>Block Size in bytes to be used by the volumes created with this specific performance policy. Supported block sizes are 4096 bytes (4 KB), 8192 bytes (8 KB), 16384 bytes(16 KB), and 32768 bytes (32 KB). Block size of a performance policy cannot be changed once the performance policy is created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compress</maml:name> <maml:description> <maml:para>Flag denoting if data in the associated volume should be compressed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache</maml:name> <maml:description> <maml:para>Flag denoting if data in the associated volume should be cached.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache_policy</maml:name> <maml:description> <maml:para>Specifies how data of associated volume should be cached. Supports two policies, 'normal' and 'aggressive'. 'normal' policy caches data but skips in certain conditions such as sequential I/O. 'aggressive' policy will accelerate caching of all data belonging to this volume, regardless of sequentiality.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>space_policy</maml:name> <maml:description> <maml:para>Specifies the state of the volume upon space constraint violation such as volume limit violation or volumes above their volume reserve, if the pool free space is exhausted. Supports two policies, 'offline' and 'non_writable'.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_category</maml:name> <maml:description> <maml:para>Specifies the application category of the associated volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>dedupe_enabled</maml:name> <maml:description> <maml:para>Specifies if dedupe is enabled for volumes created with this performance policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>deprecated</maml:name> <maml:description> <maml:para>Specifies if this performance policy is deprecated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>predefined</maml:name> <maml:description> <maml:para>Specifies if this performance policy is predefined (read-only).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when the performance policy was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when the performance policy's configurations were last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>sample_rate</maml:name> <maml:description> <maml:para>Sample rate value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Number of volumes using this performance policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_override_pools</maml:name> <maml:description> <maml:para>List of pools that override performance policy's dedupe setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Set-NSPerformancePolicy -id 0328eada7f8dd99d3b000000000000000000000061 -description "My New Description" name id app_category block_size description cache_policy compress dedupe_enabled predefined space_policy ---- -- ------------ ---------- ----------- ------------ -------- -------------- ---------- ------------ MyTestPolicy1 0328eada7f8dd99d3b000000000000000000000061 Unassigned 4096 My New Description normal True False False offline </dev:code> <dev:remarks> <maml:para>This command will Modify a setting of the specified Performance Policy. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSPerformancePolicy</command:name> <maml:description> <maml:para>Delete a performance policy.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSPerformancePolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Delete a performance policy.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Unique Identifier for the Performance Policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the Performance Policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of the Performance Policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of the Performance Policy used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of a performance policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>block_size</maml:name> <maml:description> <maml:para>Block Size in bytes to be used by the volumes created with this specific performance policy. Supported block sizes are 4096 bytes (4 KB), 8192 bytes (8 KB), 16384 bytes(16 KB), and 32768 bytes (32 KB). Block size of a performance policy cannot be changed once the performance policy is created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compress</maml:name> <maml:description> <maml:para>Flag denoting if data in the associated volume should be compressed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache</maml:name> <maml:description> <maml:para>Flag denoting if data in the associated volume should be cached.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache_policy</maml:name> <maml:description> <maml:para>Specifies how data of associated volume should be cached. Supports two policies, 'normal' and 'aggressive'. 'normal' policy caches data but skips in certain conditions such as sequential I/O. 'aggressive' policy will accelerate caching of all data belonging to this volume, regardless of sequentiality.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>space_policy</maml:name> <maml:description> <maml:para>Specifies the state of the volume upon space constraint violation such as volume limit violation or volumes above their volume reserve, if the pool free space is exhausted. Supports two policies, 'offline' and 'non_writable'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_category</maml:name> <maml:description> <maml:para>Specifies the application category of the associated volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_enabled</maml:name> <maml:description> <maml:para>Specifies if dedupe is enabled for volumes created with this performance policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>deprecated</maml:name> <maml:description> <maml:para>Specifies if this performance policy is deprecated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>predefined</maml:name> <maml:description> <maml:para>Specifies if this performance policy is predefined (read-only).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when the performance policy was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when the performance policy's configurations were last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sample_rate</maml:name> <maml:description> <maml:para>Sample rate value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Number of volumes using this performance policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSPerformancePolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_override_pools</maml:name> <maml:description> <maml:para>List of pools that override performance policy's dedupe setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Unique Identifier for the Performance Policy.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the Performance Policy.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of the Performance Policy.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of the Performance Policy used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of a performance policy.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>block_size</maml:name> <maml:description> <maml:para>Block Size in bytes to be used by the volumes created with this specific performance policy. Supported block sizes are 4096 bytes (4 KB), 8192 bytes (8 KB), 16384 bytes(16 KB), and 32768 bytes (32 KB). Block size of a performance policy cannot be changed once the performance policy is created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compress</maml:name> <maml:description> <maml:para>Flag denoting if data in the associated volume should be compressed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache</maml:name> <maml:description> <maml:para>Flag denoting if data in the associated volume should be cached.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache_policy</maml:name> <maml:description> <maml:para>Specifies how data of associated volume should be cached. Supports two policies, 'normal' and 'aggressive'. 'normal' policy caches data but skips in certain conditions such as sequential I/O. 'aggressive' policy will accelerate caching of all data belonging to this volume, regardless of sequentiality.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>space_policy</maml:name> <maml:description> <maml:para>Specifies the state of the volume upon space constraint violation such as volume limit violation or volumes above their volume reserve, if the pool free space is exhausted. Supports two policies, 'offline' and 'non_writable'.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_category</maml:name> <maml:description> <maml:para>Specifies the application category of the associated volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>dedupe_enabled</maml:name> <maml:description> <maml:para>Specifies if dedupe is enabled for volumes created with this performance policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>deprecated</maml:name> <maml:description> <maml:para>Specifies if this performance policy is deprecated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>predefined</maml:name> <maml:description> <maml:para>Specifies if this performance policy is predefined (read-only).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when the performance policy was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when the performance policy's configurations were last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>sample_rate</maml:name> <maml:description> <maml:para>Sample rate value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Number of volumes using this performance policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_override_pools</maml:name> <maml:description> <maml:para>List of pools that override performance policy's dedupe setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Remove-NSPerformancePolicy -id 0328eada7f8dd99d3b000000000000000000000061 </dev:code> <dev:remarks> <maml:para>This command will remove the specified Performance Policy. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSKeyManager</command:name> <maml:description> <maml:para>Add External Key Manager for encryption keys.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSKeyManager</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Add External Key Manager for encryption keys.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for External Key Manager.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSKeyManager</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of external key manager.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of external key manager.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSKeyManager</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>hostname</maml:name> <maml:description> <maml:para>Hostname or IP Address for the External Key Manager.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSKeyManager</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>Port number for the External Key Manager.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSKeyManager</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>protocol</maml:name> <maml:description> <maml:para>KMIP protocol supported by External Key Manager.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>External Key Manager username. String up to 255 printable characters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>External Key Manager user password. String up to 255 printable characters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>active</maml:name> <maml:description> <maml:para>Whether the given key manager is active or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Connection status of a given external key manager.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vendor</maml:name> <maml:description> <maml:para>KMIP vendor name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for External Key Manager.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of external key manager.</maml:para> </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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of external key manager.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>hostname</maml:name> <maml:description> <maml:para>Hostname or IP Address for the External Key Manager.</maml:para> </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="true (ByValue)" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>Port number for the External Key Manager.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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>protocol</maml:name> <maml:description> <maml:para>KMIP protocol supported by External Key Manager.</maml:para> </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="true (ByValue)" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>External Key Manager username. String up to 255 printable characters.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>External Key Manager user password. String up to 255 printable characters.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>active</maml:name> <maml:description> <maml:para>Whether the given key manager is active or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Connection status of a given external key manager.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vendor</maml:name> <maml:description> <maml:para>KMIP vendor name.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSKeyManager</command:name> <maml:description> <maml:para>List External Key Manager Information.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSKeyManager</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List External Key Manager Information.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for External Key Manager.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of external key manager.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of external key manager.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>hostname</maml:name> <maml:description> <maml:para>Hostname or IP Address for the External Key Manager.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>Port number for the External Key Manager.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>protocol</maml:name> <maml:description> <maml:para>KMIP protocol supported by External Key Manager.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>External Key Manager username. String up to 255 printable characters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>External Key Manager user password. String up to 255 printable characters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>active</maml:name> <maml:description> <maml:para>Whether the given key manager is active or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Connection status of a given external key manager.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vendor</maml:name> <maml:description> <maml:para>KMIP vendor name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for External Key Manager.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of external key manager.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of external key manager.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>hostname</maml:name> <maml:description> <maml:para>Hostname or IP Address for the External Key Manager.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>Port number for the External Key Manager.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>protocol</maml:name> <maml:description> <maml:para>KMIP protocol supported by External Key Manager.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>External Key Manager username. String up to 255 printable characters.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>External Key Manager user password. String up to 255 printable characters.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>active</maml:name> <maml:description> <maml:para>Whether the given key manager is active or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Connection status of a given external key manager.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vendor</maml:name> <maml:description> <maml:para>KMIP vendor name.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSKeyManager</command:name> <maml:description> <maml:para>Updates External Key Manager configuration.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSKeyManager</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Updates External Key Manager configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for External Key Manager.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of external key manager.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of external key manager.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>hostname</maml:name> <maml:description> <maml:para>Hostname or IP Address for the External Key Manager.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>Port number for the External Key Manager.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>protocol</maml:name> <maml:description> <maml:para>KMIP protocol supported by External Key Manager.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>External Key Manager username. String up to 255 printable characters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>External Key Manager user password. String up to 255 printable characters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>active</maml:name> <maml:description> <maml:para>Whether the given key manager is active or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Connection status of a given external key manager.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vendor</maml:name> <maml:description> <maml:para>KMIP vendor name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for External Key Manager.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of external key manager.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of external key manager.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>hostname</maml:name> <maml:description> <maml:para>Hostname or IP Address for the External Key Manager.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>Port number for the External Key Manager.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>protocol</maml:name> <maml:description> <maml:para>KMIP protocol supported by External Key Manager.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>External Key Manager username. String up to 255 printable characters.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>External Key Manager user password. String up to 255 printable characters.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>active</maml:name> <maml:description> <maml:para>Whether the given key manager is active or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Connection status of a given external key manager.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vendor</maml:name> <maml:description> <maml:para>KMIP vendor name.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSKeyManager</command:name> <maml:description> <maml:para>Remove external key manager. You must migrate the keys to an inactive external key manager before removing the active key manager. If you remove the active external key manager the passphrase is used to enable the internal key manager.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remov</command:verb> <command:noun>-NSKeyManager</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Remove external key manager. You must migrate the keys to an inactive external key manager before removing the active key manager. If you remove the active external key manager the passphrase is used to enable the internal key manager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSKeyManager</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the external key manager.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSKeyManager</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>passphrase</maml:name> <maml:description> <maml:para>Passphrase used to protect the master key, required during deletion of external key manager.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the external key manager.</maml:para> </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="true (ByValue)" position="named"> <maml:name>passphrase</maml:name> <maml:description> <maml:para>Passphrase used to protect the master key, required during deletion of external key manager.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Move-NSKeyManager</command:name> <maml:description> <maml:para>Migrate volume encryption keys from the active key manager to the destination id given in the input. After successfully migrating the encryption keys, the destination key manager is made the active key manager.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Move-</command:verb> <command:noun>-NSKeyManager</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Migrate volume encryption keys from the active key manager to the destination id given in the input. After successfully migrating the encryption keys, the destination key manager is made the active key manager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Move-NSKeyManager</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the destination external key manager.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the destination external key manager.</maml:para> </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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSUserPolicy</command:name> <maml:description> <maml:para>Read the password policies configured.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSUserPolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Read the password policies configured.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSUserPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the security policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUserPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>allowed_attempts</maml:name> <maml:description> <maml:para>Number of authentication attempts allowed before the user account is locked. Allowed range is [1, 10] inclusive. '0' indicates no limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUserPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>min_length</maml:name> <maml:description> <maml:para>Minimum length for user passwords. Allowed range is [8, 255] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUserPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>upper</maml:name> <maml:description> <maml:para>Number of uppercase characters required in user passwords. Allowed range is [0, 255] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUserPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>lower</maml:name> <maml:description> <maml:para>Number of lowercase characters required in user passwords. Allowed range is [0, 255] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUserPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>digit</maml:name> <maml:description> <maml:para>Number of numerical characters required in user passwords. Allowed range is [0, 255] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUserPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>special</maml:name> <maml:description> <maml:para>Number of special characters required in user passwords. Allowed range is [0, 255] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUserPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>previous_diff</maml:name> <maml:description> <maml:para>Number of characters that must be different from the previous password. Allowed range is [1, 255] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUserPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>no_reuse</maml:name> <maml:description> <maml:para>Number of times that a password must change before you can reuse a previous password. Allowed range is [1,20] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUserPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>max_sessions</maml:name> <maml:description> <maml:para>Maximum number of sessions allowed for a group. Allowed range is [10, 1000] inclusive. '0' indicates no limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the security policy.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>allowed_attempts</maml:name> <maml:description> <maml:para>Number of authentication attempts allowed before the user account is locked. Allowed range is [1, 10] inclusive. '0' indicates no limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>min_length</maml:name> <maml:description> <maml:para>Minimum length for user passwords. Allowed range is [8, 255] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>upper</maml:name> <maml:description> <maml:para>Number of uppercase characters required in user passwords. Allowed range is [0, 255] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>lower</maml:name> <maml:description> <maml:para>Number of lowercase characters required in user passwords. Allowed range is [0, 255] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>digit</maml:name> <maml:description> <maml:para>Number of numerical characters required in user passwords. Allowed range is [0, 255] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>special</maml:name> <maml:description> <maml:para>Number of special characters required in user passwords. Allowed range is [0, 255] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>previous_diff</maml:name> <maml:description> <maml:para>Number of characters that must be different from the previous password. Allowed range is [1, 255] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>no_reuse</maml:name> <maml:description> <maml:para>Number of times that a password must change before you can reuse a previous password. Allowed range is [1,20] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>max_sessions</maml:name> <maml:description> <maml:para>Maximum number of sessions allowed for a group. Allowed range is [10, 1000] inclusive. '0' indicates no limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSUserPolicy</command:name> <maml:description> <maml:para>Updates the Password policies configuration.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSUserPolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Updates the Password policies configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSUserPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the security policy.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUserPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>allowed_attempts</maml:name> <maml:description> <maml:para>Number of authentication attempts allowed before the user account is locked. Allowed range is [1, 10] inclusive. '0' indicates no limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUserPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>min_length</maml:name> <maml:description> <maml:para>Minimum length for user passwords. Allowed range is [8, 255] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUserPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>upper</maml:name> <maml:description> <maml:para>Number of uppercase characters required in user passwords. Allowed range is [0, 255] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUserPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>lower</maml:name> <maml:description> <maml:para>Number of lowercase characters required in user passwords. Allowed range is [0, 255] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUserPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>digit</maml:name> <maml:description> <maml:para>Number of numerical characters required in user passwords. Allowed range is [0, 255] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUserPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>special</maml:name> <maml:description> <maml:para>Number of special characters required in user passwords. Allowed range is [0, 255] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUserPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>previous_diff</maml:name> <maml:description> <maml:para>Number of characters that must be different from the previous password. Allowed range is [1, 255] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUserPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>no_reuse</maml:name> <maml:description> <maml:para>Number of times that a password must change before you can reuse a previous password. Allowed range is [1,20] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUserPolicy</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>max_sessions</maml:name> <maml:description> <maml:para>Maximum number of sessions allowed for a group. Allowed range is [10, 1000] inclusive. '0' indicates no limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the security policy.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>allowed_attempts</maml:name> <maml:description> <maml:para>Number of authentication attempts allowed before the user account is locked. Allowed range is [1, 10] inclusive. '0' indicates no limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>min_length</maml:name> <maml:description> <maml:para>Minimum length for user passwords. Allowed range is [8, 255] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>upper</maml:name> <maml:description> <maml:para>Number of uppercase characters required in user passwords. Allowed range is [0, 255] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>lower</maml:name> <maml:description> <maml:para>Number of lowercase characters required in user passwords. Allowed range is [0, 255] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>digit</maml:name> <maml:description> <maml:para>Number of numerical characters required in user passwords. Allowed range is [0, 255] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>special</maml:name> <maml:description> <maml:para>Number of special characters required in user passwords. Allowed range is [0, 255] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>previous_diff</maml:name> <maml:description> <maml:para>Number of characters that must be different from the previous password. Allowed range is [1, 255] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>no_reuse</maml:name> <maml:description> <maml:para>Number of times that a password must change before you can reuse a previous password. Allowed range is [1,20] inclusive.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>max_sessions</maml:name> <maml:description> <maml:para>Maximum number of sessions allowed for a group. Allowed range is [10, 1000] inclusive. '0' indicates no limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSSnapshotCollection</command:name> <maml:description> <maml:para>Create a snapshot collection. VSS application-synchronized snapshot collection must specify the 'allow_writes' parameter ans set it to 'true'.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSSnapshotCollection</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Create a snapshot collection. VSS application-synchronized snapshot collection must specify the 'allow_writes' parameter ans set it to 'true'.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volcoll_name</maml:name> <maml:description> <maml:para>Volume collection name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volcoll_id</maml:name> <maml:description> <maml:para>Parent volume collection ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>origin_name</maml:name> <maml:description> <maml:para>Origination group name/ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_replica</maml:name> <maml:description> <maml:para>Indicates if snapshot collection was created as a replica.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>srep_owner_name</maml:name> <maml:description> <maml:para>Name of the partner where the snapshots in this snapshot collection reside.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>srep_owner_id</maml:name> <maml:description> <maml:para>ID of the partner where snapshots for this snapshot collection reside which were created by synchronous replication. Field will be null if no peer snapshot_collection was created by synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>peer_snapcoll_id</maml:name> <maml:description> <maml:para>ID of the peer snapshot collection created by synchronous replication. Field will be null if no peer snapshot_collection was created by synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Current number of live, non-hidden snaps in this collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_complete</maml:name> <maml:description> <maml:para>Is complete.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_manual</maml:name> <maml:description> <maml:para>Is manual.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_external_trigger</maml:name> <maml:description> <maml:para>Is externally triggered.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_unmanaged</maml:name> <maml:description> <maml:para>Indicates whether a snapshot collection is unmanaged. This is based on the state of individual snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_manually_managed</maml:name> <maml:description> <maml:para>Indicates whether a snapshot collection is managed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_status</maml:name> <maml:description> <maml:para>Replication status.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_start_time</maml:name> <maml:description> <maml:para>Replication start time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_complete_time</maml:name> <maml:description> <maml:para>Replication complete time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_bytes_transferred</maml:name> <maml:description> <maml:para>Number of bytes transferred after replication completes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this snapshot collection was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this snapshot collection was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>online_status</maml:name> <maml:description> <maml:para>Online status of snapcoll. This is based on the online status of the individual snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_snap_attr_list</maml:name> <maml:description> <maml:para>List of snapshot attributes for snapshots being created as part of snapshot collection creation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snapshots_list</maml:name> <maml:description> <maml:para>List of snapshots in the snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replicate</maml:name> <maml:description> <maml:para>True if this snapshot collection has been marked for replication. This attribute cannot be updated for synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replicate_to</maml:name> <maml:description> <maml:para>Specifies the partner name that the snapshots in this snapshot collection are replicated to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>start_online</maml:name> <maml:description> <maml:para>Start with snapshot set online.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>allow_writes</maml:name> <maml:description> <maml:para>Allow applications to write to created snapshot(s). Mandatory and must be set to 'true' for VSS application synchronized snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>disable_appsync</maml:name> <maml:description> <maml:para>Do not perform application synchronization for this snapshot, create a crash-consistent snapshot instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_verify</maml:name> <maml:description> <maml:para>Run verification tool on this snapshot. This option can only be used with a volume collection that has application synchronization.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>skip_db_consistency_check</maml:name> <maml:description> <maml:para>Skip consistency check for database files on this snapshot. This option only applies to volume collections with application synchronization set to VSS, application ID set to MS Exchange 2010 or later with Database Availability Group (DAG), snap_verify option set to true, and disable_appsync option set to false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sched_id</maml:name> <maml:description> <maml:para>ID of protection schedule of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sched_name</maml:name> <maml:description> <maml:para>Name of protection schedule of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>invoke_on_upstream_partner</maml:name> <maml:description> <maml:para>Invoke snapshot request on upstream partner. This operation is not supported for synchronous replication volume vollections.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type for snapshots being created as part of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>expiry_after</maml:name> <maml:description> <maml:para>Number of seconds after which this snapcoll is considered expired by the snapshot TTL. A value of 0 indicates that the snapshot never expires, 1 indicates that the snapshot uses a group-level configured TTL value and any other value indicates the number of seconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment a snapshot collection's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified snapshot collection even if it is the last replicated snapshot. Doing so could lead to full re-seeding at the next replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of snapshot collection.</maml:para> </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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volcoll_name</maml:name> <maml:description> <maml:para>Volume collection name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volcoll_id</maml:name> <maml:description> <maml:para>Parent volume collection ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>origin_name</maml:name> <maml:description> <maml:para>Origination group name/ID.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>is_replica</maml:name> <maml:description> <maml:para>Indicates if snapshot collection was created as a replica.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>srep_owner_name</maml:name> <maml:description> <maml:para>Name of the partner where the snapshots in this snapshot collection reside.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>srep_owner_id</maml:name> <maml:description> <maml:para>ID of the partner where snapshots for this snapshot collection reside which were created by synchronous replication. Field will be null if no peer snapshot_collection was created by synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>peer_snapcoll_id</maml:name> <maml:description> <maml:para>ID of the peer snapshot collection created by synchronous replication. Field will be null if no peer snapshot_collection was created by synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Current number of live, non-hidden snaps in this collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_complete</maml:name> <maml:description> <maml:para>Is complete.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_manual</maml:name> <maml:description> <maml:para>Is manual.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_external_trigger</maml:name> <maml:description> <maml:para>Is externally triggered.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_unmanaged</maml:name> <maml:description> <maml:para>Indicates whether a snapshot collection is unmanaged. This is based on the state of individual snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_manually_managed</maml:name> <maml:description> <maml:para>Indicates whether a snapshot collection is managed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_status</maml:name> <maml:description> <maml:para>Replication status.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>repl_start_time</maml:name> <maml:description> <maml:para>Replication start time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_complete_time</maml:name> <maml:description> <maml:para>Replication complete time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_bytes_transferred</maml:name> <maml:description> <maml:para>Number of bytes transferred after replication completes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this snapshot collection was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this snapshot collection was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>online_status</maml:name> <maml:description> <maml:para>Online status of snapcoll. This is based on the online status of the individual snapshots.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vol_snap_attr_list</maml:name> <maml:description> <maml:para>List of snapshot attributes for snapshots being created as part of snapshot collection creation.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snapshots_list</maml:name> <maml:description> <maml:para>List of snapshots in the snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>replicate</maml:name> <maml:description> <maml:para>True if this snapshot collection has been marked for replication. This attribute cannot be updated for synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>replicate_to</maml:name> <maml:description> <maml:para>Specifies the partner name that the snapshots in this snapshot collection are replicated to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>start_online</maml:name> <maml:description> <maml:para>Start with snapshot set online.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>allow_writes</maml:name> <maml:description> <maml:para>Allow applications to write to created snapshot(s). Mandatory and must be set to 'true' for VSS application synchronized snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>disable_appsync</maml:name> <maml:description> <maml:para>Do not perform application synchronization for this snapshot, create a crash-consistent snapshot instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_verify</maml:name> <maml:description> <maml:para>Run verification tool on this snapshot. This option can only be used with a volume collection that has application synchronization.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>skip_db_consistency_check</maml:name> <maml:description> <maml:para>Skip consistency check for database files on this snapshot. This option only applies to volume collections with application synchronization set to VSS, application ID set to MS Exchange 2010 or later with Database Availability Group (DAG), snap_verify option set to true, and disable_appsync option set to false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>sched_id</maml:name> <maml:description> <maml:para>ID of protection schedule of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>sched_name</maml:name> <maml:description> <maml:para>Name of protection schedule of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>invoke_on_upstream_partner</maml:name> <maml:description> <maml:para>Invoke snapshot request on upstream partner. This operation is not supported for synchronous replication volume vollections.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type for snapshots being created as part of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>expiry_after</maml:name> <maml:description> <maml:para>Number of seconds after which this snapcoll is considered expired by the snapshot TTL. A value of 0 indicates that the snapshot never expires, 1 indicates that the snapshot uses a group-level configured TTL value and any other value indicates the number of seconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment a snapshot collection's attributes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified snapshot collection even if it is the last replicated snapshot. Doing so could lead to full re-seeding at the next replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> PS:> New-nsSnapshotcollection -name TestSnapcol-819 -volcoll_id 0728eada7f8dd99d3b000000000000000000000007 name id volcoll_name sched_name online description ---- -- ------------ ---------- ------ ----------- TestSnapcol-819 0528eada7f8dd99d3b0000000000000000000000b9 mycol1 </dev:code> <dev:remarks> <maml:para>This command will create a new Snapshot collection using the minimal number of parameters. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSSnapshotCollection</command:name> <maml:description> <maml:para>Read information about specified snapshot collection.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSSnapshotCollection</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Read information about specified snapshot collection.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volcoll_name</maml:name> <maml:description> <maml:para>Volume collection name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volcoll_id</maml:name> <maml:description> <maml:para>Parent volume collection ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>origin_name</maml:name> <maml:description> <maml:para>Origination group name/ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_replica</maml:name> <maml:description> <maml:para>Indicates if snapshot collection was created as a replica.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>srep_owner_name</maml:name> <maml:description> <maml:para>Name of the partner where the snapshots in this snapshot collection reside.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>srep_owner_id</maml:name> <maml:description> <maml:para>ID of the partner where snapshots for this snapshot collection reside which were created by synchronous replication. Field will be null if no peer snapshot_collection was created by synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>peer_snapcoll_id</maml:name> <maml:description> <maml:para>ID of the peer snapshot collection created by synchronous replication. Field will be null if no peer snapshot_collection was created by synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Current number of live, non-hidden snaps in this collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_complete</maml:name> <maml:description> <maml:para>Is complete.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_manual</maml:name> <maml:description> <maml:para>Is manual.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_external_trigger</maml:name> <maml:description> <maml:para>Is externally triggered.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_unmanaged</maml:name> <maml:description> <maml:para>Indicates whether a snapshot collection is unmanaged. This is based on the state of individual snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_manually_managed</maml:name> <maml:description> <maml:para>Indicates whether a snapshot collection is managed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_status</maml:name> <maml:description> <maml:para>Replication status.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_start_time</maml:name> <maml:description> <maml:para>Replication start time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_complete_time</maml:name> <maml:description> <maml:para>Replication complete time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_bytes_transferred</maml:name> <maml:description> <maml:para>Number of bytes transferred after replication completes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this snapshot collection was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this snapshot collection was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>online_status</maml:name> <maml:description> <maml:para>Online status of snapcoll. This is based on the online status of the individual snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_snap_attr_list</maml:name> <maml:description> <maml:para>List of snapshot attributes for snapshots being created as part of snapshot collection creation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snapshots_list</maml:name> <maml:description> <maml:para>List of snapshots in the snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replicate</maml:name> <maml:description> <maml:para>True if this snapshot collection has been marked for replication. This attribute cannot be updated for synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replicate_to</maml:name> <maml:description> <maml:para>Specifies the partner name that the snapshots in this snapshot collection are replicated to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>start_online</maml:name> <maml:description> <maml:para>Start with snapshot set online.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>allow_writes</maml:name> <maml:description> <maml:para>Allow applications to write to created snapshot(s). Mandatory and must be set to 'true' for VSS application synchronized snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>disable_appsync</maml:name> <maml:description> <maml:para>Do not perform application synchronization for this snapshot, create a crash-consistent snapshot instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_verify</maml:name> <maml:description> <maml:para>Run verification tool on this snapshot. This option can only be used with a volume collection that has application synchronization.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>skip_db_consistency_check</maml:name> <maml:description> <maml:para>Skip consistency check for database files on this snapshot. This option only applies to volume collections with application synchronization set to VSS, application ID set to MS Exchange 2010 or later with Database Availability Group (DAG), snap_verify option set to true, and disable_appsync option set to false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sched_id</maml:name> <maml:description> <maml:para>ID of protection schedule of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sched_name</maml:name> <maml:description> <maml:para>Name of protection schedule of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>invoke_on_upstream_partner</maml:name> <maml:description> <maml:para>Invoke snapshot request on upstream partner. This operation is not supported for synchronous replication volume vollections.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type for snapshots being created as part of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>expiry_after</maml:name> <maml:description> <maml:para>Number of seconds after which this snapcoll is considered expired by the snapshot TTL. A value of 0 indicates that the snapshot never expires, 1 indicates that the snapshot uses a group-level configured TTL value and any other value indicates the number of seconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment a snapshot collection's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified snapshot collection even if it is the last replicated snapshot. Doing so could lead to full re-seeding at the next replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volcoll_name</maml:name> <maml:description> <maml:para>Volume collection name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volcoll_id</maml:name> <maml:description> <maml:para>Parent volume collection ID.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>origin_name</maml:name> <maml:description> <maml:para>Origination group name/ID.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>is_replica</maml:name> <maml:description> <maml:para>Indicates if snapshot collection was created as a replica.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>srep_owner_name</maml:name> <maml:description> <maml:para>Name of the partner where the snapshots in this snapshot collection reside.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>srep_owner_id</maml:name> <maml:description> <maml:para>ID of the partner where snapshots for this snapshot collection reside which were created by synchronous replication. Field will be null if no peer snapshot_collection was created by synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>peer_snapcoll_id</maml:name> <maml:description> <maml:para>ID of the peer snapshot collection created by synchronous replication. Field will be null if no peer snapshot_collection was created by synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Current number of live, non-hidden snaps in this collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_complete</maml:name> <maml:description> <maml:para>Is complete.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_manual</maml:name> <maml:description> <maml:para>Is manual.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_external_trigger</maml:name> <maml:description> <maml:para>Is externally triggered.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_unmanaged</maml:name> <maml:description> <maml:para>Indicates whether a snapshot collection is unmanaged. This is based on the state of individual snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_manually_managed</maml:name> <maml:description> <maml:para>Indicates whether a snapshot collection is managed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_status</maml:name> <maml:description> <maml:para>Replication status.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>repl_start_time</maml:name> <maml:description> <maml:para>Replication start time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_complete_time</maml:name> <maml:description> <maml:para>Replication complete time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_bytes_transferred</maml:name> <maml:description> <maml:para>Number of bytes transferred after replication completes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this snapshot collection was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this snapshot collection was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>online_status</maml:name> <maml:description> <maml:para>Online status of snapcoll. This is based on the online status of the individual snapshots.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vol_snap_attr_list</maml:name> <maml:description> <maml:para>List of snapshot attributes for snapshots being created as part of snapshot collection creation.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snapshots_list</maml:name> <maml:description> <maml:para>List of snapshots in the snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>replicate</maml:name> <maml:description> <maml:para>True if this snapshot collection has been marked for replication. This attribute cannot be updated for synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>replicate_to</maml:name> <maml:description> <maml:para>Specifies the partner name that the snapshots in this snapshot collection are replicated to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>start_online</maml:name> <maml:description> <maml:para>Start with snapshot set online.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>allow_writes</maml:name> <maml:description> <maml:para>Allow applications to write to created snapshot(s). Mandatory and must be set to 'true' for VSS application synchronized snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>disable_appsync</maml:name> <maml:description> <maml:para>Do not perform application synchronization for this snapshot, create a crash-consistent snapshot instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_verify</maml:name> <maml:description> <maml:para>Run verification tool on this snapshot. This option can only be used with a volume collection that has application synchronization.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>skip_db_consistency_check</maml:name> <maml:description> <maml:para>Skip consistency check for database files on this snapshot. This option only applies to volume collections with application synchronization set to VSS, application ID set to MS Exchange 2010 or later with Database Availability Group (DAG), snap_verify option set to true, and disable_appsync option set to false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>sched_id</maml:name> <maml:description> <maml:para>ID of protection schedule of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>sched_name</maml:name> <maml:description> <maml:para>Name of protection schedule of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>invoke_on_upstream_partner</maml:name> <maml:description> <maml:para>Invoke snapshot request on upstream partner. This operation is not supported for synchronous replication volume vollections.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type for snapshots being created as part of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>expiry_after</maml:name> <maml:description> <maml:para>Number of seconds after which this snapcoll is considered expired by the snapshot TTL. A value of 0 indicates that the snapshot never expires, 1 indicates that the snapshot uses a group-level configured TTL value and any other value indicates the number of seconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment a snapshot collection's attributes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified snapshot collection even if it is the last replicated snapshot. Doing so could lead to full re-seeding at the next replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSSnapshotCollection name id volcoll_name sched_name online description ---- -- ------------ ---------- ------ ----------- Testsnap1 0528eada7f8dd99d3b000000000000000000000005 testcol1 mycol1-mydailybackup-2018-07-13:... 0528eada7f8dd99d3b000000000000000000000007 mycol1 mydailybackup Created by protection policy mycol1 schedule my... mycol1-mydailybackup-2018-07-16:... 0528eada7f8dd99d3b000000000000000000000008 mycol1 mydailybackup Created by protection policy mycol1 schedule my... mycol1-mydailybackup-2018-07-17:... 0528eada7f8dd99d3b000000000000000000000009 mycol1 mydailybackup Created by protection policy mycol1 schedule my... </dev:code> <dev:remarks> <maml:para>This command will retrieve the Snapshot Collection from the array. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 2 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSSnapshotCollection -name Testsnap1 name id volcoll_name sched_name online description ---- -- ------------ ---------- ------ ----------- Testsnap1 0528eada7f8dd99d3b000000000000000000000005 testcol1 </dev:code> <dev:remarks> <maml:para>This command will retrieve a specific Snapshot Collection from the array by name. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSSnapshotCollection</command:name> <maml:description> <maml:para>Update a snapshot collection.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSSnapshotCollection</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Update a snapshot collection.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for snapshot collection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volcoll_name</maml:name> <maml:description> <maml:para>Volume collection name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volcoll_id</maml:name> <maml:description> <maml:para>Parent volume collection ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>origin_name</maml:name> <maml:description> <maml:para>Origination group name/ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_replica</maml:name> <maml:description> <maml:para>Indicates if snapshot collection was created as a replica.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>srep_owner_name</maml:name> <maml:description> <maml:para>Name of the partner where the snapshots in this snapshot collection reside.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>srep_owner_id</maml:name> <maml:description> <maml:para>ID of the partner where snapshots for this snapshot collection reside which were created by synchronous replication. Field will be null if no peer snapshot_collection was created by synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>peer_snapcoll_id</maml:name> <maml:description> <maml:para>ID of the peer snapshot collection created by synchronous replication. Field will be null if no peer snapshot_collection was created by synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Current number of live, non-hidden snaps in this collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_complete</maml:name> <maml:description> <maml:para>Is complete.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_manual</maml:name> <maml:description> <maml:para>Is manual.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_external_trigger</maml:name> <maml:description> <maml:para>Is externally triggered.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_unmanaged</maml:name> <maml:description> <maml:para>Indicates whether a snapshot collection is unmanaged. This is based on the state of individual snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_manually_managed</maml:name> <maml:description> <maml:para>Indicates whether a snapshot collection is managed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_status</maml:name> <maml:description> <maml:para>Replication status.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_start_time</maml:name> <maml:description> <maml:para>Replication start time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_complete_time</maml:name> <maml:description> <maml:para>Replication complete time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_bytes_transferred</maml:name> <maml:description> <maml:para>Number of bytes transferred after replication completes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this snapshot collection was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this snapshot collection was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>online_status</maml:name> <maml:description> <maml:para>Online status of snapcoll. This is based on the online status of the individual snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_snap_attr_list</maml:name> <maml:description> <maml:para>List of snapshot attributes for snapshots being created as part of snapshot collection creation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snapshots_list</maml:name> <maml:description> <maml:para>List of snapshots in the snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replicate</maml:name> <maml:description> <maml:para>True if this snapshot collection has been marked for replication. This attribute cannot be updated for synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replicate_to</maml:name> <maml:description> <maml:para>Specifies the partner name that the snapshots in this snapshot collection are replicated to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>start_online</maml:name> <maml:description> <maml:para>Start with snapshot set online.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>allow_writes</maml:name> <maml:description> <maml:para>Allow applications to write to created snapshot(s). Mandatory and must be set to 'true' for VSS application synchronized snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>disable_appsync</maml:name> <maml:description> <maml:para>Do not perform application synchronization for this snapshot, create a crash-consistent snapshot instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_verify</maml:name> <maml:description> <maml:para>Run verification tool on this snapshot. This option can only be used with a volume collection that has application synchronization.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>skip_db_consistency_check</maml:name> <maml:description> <maml:para>Skip consistency check for database files on this snapshot. This option only applies to volume collections with application synchronization set to VSS, application ID set to MS Exchange 2010 or later with Database Availability Group (DAG), snap_verify option set to true, and disable_appsync option set to false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sched_id</maml:name> <maml:description> <maml:para>ID of protection schedule of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sched_name</maml:name> <maml:description> <maml:para>Name of protection schedule of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>invoke_on_upstream_partner</maml:name> <maml:description> <maml:para>Invoke snapshot request on upstream partner. This operation is not supported for synchronous replication volume vollections.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type for snapshots being created as part of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>expiry_after</maml:name> <maml:description> <maml:para>Number of seconds after which this snapcoll is considered expired by the snapshot TTL. A value of 0 indicates that the snapshot never expires, 1 indicates that the snapshot uses a group-level configured TTL value and any other value indicates the number of seconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment a snapshot collection's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified snapshot collection even if it is the last replicated snapshot. Doing so could lead to full re-seeding at the next replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for snapshot collection.</maml:para> </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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volcoll_name</maml:name> <maml:description> <maml:para>Volume collection name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volcoll_id</maml:name> <maml:description> <maml:para>Parent volume collection ID.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>origin_name</maml:name> <maml:description> <maml:para>Origination group name/ID.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>is_replica</maml:name> <maml:description> <maml:para>Indicates if snapshot collection was created as a replica.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>srep_owner_name</maml:name> <maml:description> <maml:para>Name of the partner where the snapshots in this snapshot collection reside.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>srep_owner_id</maml:name> <maml:description> <maml:para>ID of the partner where snapshots for this snapshot collection reside which were created by synchronous replication. Field will be null if no peer snapshot_collection was created by synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>peer_snapcoll_id</maml:name> <maml:description> <maml:para>ID of the peer snapshot collection created by synchronous replication. Field will be null if no peer snapshot_collection was created by synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Current number of live, non-hidden snaps in this collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_complete</maml:name> <maml:description> <maml:para>Is complete.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_manual</maml:name> <maml:description> <maml:para>Is manual.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_external_trigger</maml:name> <maml:description> <maml:para>Is externally triggered.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_unmanaged</maml:name> <maml:description> <maml:para>Indicates whether a snapshot collection is unmanaged. This is based on the state of individual snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_manually_managed</maml:name> <maml:description> <maml:para>Indicates whether a snapshot collection is managed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_status</maml:name> <maml:description> <maml:para>Replication status.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>repl_start_time</maml:name> <maml:description> <maml:para>Replication start time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_complete_time</maml:name> <maml:description> <maml:para>Replication complete time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_bytes_transferred</maml:name> <maml:description> <maml:para>Number of bytes transferred after replication completes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this snapshot collection was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this snapshot collection was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>online_status</maml:name> <maml:description> <maml:para>Online status of snapcoll. This is based on the online status of the individual snapshots.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vol_snap_attr_list</maml:name> <maml:description> <maml:para>List of snapshot attributes for snapshots being created as part of snapshot collection creation.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snapshots_list</maml:name> <maml:description> <maml:para>List of snapshots in the snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>replicate</maml:name> <maml:description> <maml:para>True if this snapshot collection has been marked for replication. This attribute cannot be updated for synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>replicate_to</maml:name> <maml:description> <maml:para>Specifies the partner name that the snapshots in this snapshot collection are replicated to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>start_online</maml:name> <maml:description> <maml:para>Start with snapshot set online.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>allow_writes</maml:name> <maml:description> <maml:para>Allow applications to write to created snapshot(s). Mandatory and must be set to 'true' for VSS application synchronized snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>disable_appsync</maml:name> <maml:description> <maml:para>Do not perform application synchronization for this snapshot, create a crash-consistent snapshot instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_verify</maml:name> <maml:description> <maml:para>Run verification tool on this snapshot. This option can only be used with a volume collection that has application synchronization.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>skip_db_consistency_check</maml:name> <maml:description> <maml:para>Skip consistency check for database files on this snapshot. This option only applies to volume collections with application synchronization set to VSS, application ID set to MS Exchange 2010 or later with Database Availability Group (DAG), snap_verify option set to true, and disable_appsync option set to false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>sched_id</maml:name> <maml:description> <maml:para>ID of protection schedule of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>sched_name</maml:name> <maml:description> <maml:para>Name of protection schedule of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>invoke_on_upstream_partner</maml:name> <maml:description> <maml:para>Invoke snapshot request on upstream partner. This operation is not supported for synchronous replication volume vollections.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type for snapshots being created as part of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>expiry_after</maml:name> <maml:description> <maml:para>Number of seconds after which this snapcoll is considered expired by the snapshot TTL. A value of 0 indicates that the snapshot never expires, 1 indicates that the snapshot uses a group-level configured TTL value and any other value indicates the number of seconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment a snapshot collection's attributes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified snapshot collection even if it is the last replicated snapshot. Doing so could lead to full re-seeding at the next replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Set-NSSnapshotcollection -id 0528eada7f8dd99d3b0000000000000000000000ba -description Test name id volcoll_name sched_name online description ---- -- ------------ ---------- ------ ----------- TestSnapColl-784 0528eada7f8dd99d3b0000000000000000000000ba mycol1 Test </dev:code> <dev:remarks> <maml:para>This command will set the value of offline for the Snapshotcollection specified by id. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSSnapshotCollection</command:name> <maml:description> <maml:para>Delete a snapshot collection.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSSnapshotCollection</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Delete a snapshot collection.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volcoll_name</maml:name> <maml:description> <maml:para>Volume collection name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volcoll_id</maml:name> <maml:description> <maml:para>Parent volume collection ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>origin_name</maml:name> <maml:description> <maml:para>Origination group name/ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_replica</maml:name> <maml:description> <maml:para>Indicates if snapshot collection was created as a replica.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>srep_owner_name</maml:name> <maml:description> <maml:para>Name of the partner where the snapshots in this snapshot collection reside.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>srep_owner_id</maml:name> <maml:description> <maml:para>ID of the partner where snapshots for this snapshot collection reside which were created by synchronous replication. Field will be null if no peer snapshot_collection was created by synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>peer_snapcoll_id</maml:name> <maml:description> <maml:para>ID of the peer snapshot collection created by synchronous replication. Field will be null if no peer snapshot_collection was created by synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Current number of live, non-hidden snaps in this collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_complete</maml:name> <maml:description> <maml:para>Is complete.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_manual</maml:name> <maml:description> <maml:para>Is manual.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_external_trigger</maml:name> <maml:description> <maml:para>Is externally triggered.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_unmanaged</maml:name> <maml:description> <maml:para>Indicates whether a snapshot collection is unmanaged. This is based on the state of individual snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_manually_managed</maml:name> <maml:description> <maml:para>Indicates whether a snapshot collection is managed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_status</maml:name> <maml:description> <maml:para>Replication status.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_start_time</maml:name> <maml:description> <maml:para>Replication start time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_complete_time</maml:name> <maml:description> <maml:para>Replication complete time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_bytes_transferred</maml:name> <maml:description> <maml:para>Number of bytes transferred after replication completes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this snapshot collection was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this snapshot collection was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>online_status</maml:name> <maml:description> <maml:para>Online status of snapcoll. This is based on the online status of the individual snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_snap_attr_list</maml:name> <maml:description> <maml:para>List of snapshot attributes for snapshots being created as part of snapshot collection creation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snapshots_list</maml:name> <maml:description> <maml:para>List of snapshots in the snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replicate</maml:name> <maml:description> <maml:para>True if this snapshot collection has been marked for replication. This attribute cannot be updated for synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replicate_to</maml:name> <maml:description> <maml:para>Specifies the partner name that the snapshots in this snapshot collection are replicated to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>start_online</maml:name> <maml:description> <maml:para>Start with snapshot set online.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>allow_writes</maml:name> <maml:description> <maml:para>Allow applications to write to created snapshot(s). Mandatory and must be set to 'true' for VSS application synchronized snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>disable_appsync</maml:name> <maml:description> <maml:para>Do not perform application synchronization for this snapshot, create a crash-consistent snapshot instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_verify</maml:name> <maml:description> <maml:para>Run verification tool on this snapshot. This option can only be used with a volume collection that has application synchronization.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>skip_db_consistency_check</maml:name> <maml:description> <maml:para>Skip consistency check for database files on this snapshot. This option only applies to volume collections with application synchronization set to VSS, application ID set to MS Exchange 2010 or later with Database Availability Group (DAG), snap_verify option set to true, and disable_appsync option set to false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sched_id</maml:name> <maml:description> <maml:para>ID of protection schedule of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sched_name</maml:name> <maml:description> <maml:para>Name of protection schedule of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>invoke_on_upstream_partner</maml:name> <maml:description> <maml:para>Invoke snapshot request on upstream partner. This operation is not supported for synchronous replication volume vollections.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type for snapshots being created as part of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>expiry_after</maml:name> <maml:description> <maml:para>Number of seconds after which this snapcoll is considered expired by the snapshot TTL. A value of 0 indicates that the snapshot never expires, 1 indicates that the snapshot uses a group-level configured TTL value and any other value indicates the number of seconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment a snapshot collection's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshotCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified snapshot collection even if it is the last replicated snapshot. Doing so could lead to full re-seeding at the next replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volcoll_name</maml:name> <maml:description> <maml:para>Volume collection name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volcoll_id</maml:name> <maml:description> <maml:para>Parent volume collection ID.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>origin_name</maml:name> <maml:description> <maml:para>Origination group name/ID.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>is_replica</maml:name> <maml:description> <maml:para>Indicates if snapshot collection was created as a replica.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>srep_owner_name</maml:name> <maml:description> <maml:para>Name of the partner where the snapshots in this snapshot collection reside.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>srep_owner_id</maml:name> <maml:description> <maml:para>ID of the partner where snapshots for this snapshot collection reside which were created by synchronous replication. Field will be null if no peer snapshot_collection was created by synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>peer_snapcoll_id</maml:name> <maml:description> <maml:para>ID of the peer snapshot collection created by synchronous replication. Field will be null if no peer snapshot_collection was created by synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Current number of live, non-hidden snaps in this collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_complete</maml:name> <maml:description> <maml:para>Is complete.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_manual</maml:name> <maml:description> <maml:para>Is manual.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_external_trigger</maml:name> <maml:description> <maml:para>Is externally triggered.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_unmanaged</maml:name> <maml:description> <maml:para>Indicates whether a snapshot collection is unmanaged. This is based on the state of individual snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_manually_managed</maml:name> <maml:description> <maml:para>Indicates whether a snapshot collection is managed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_status</maml:name> <maml:description> <maml:para>Replication status.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>repl_start_time</maml:name> <maml:description> <maml:para>Replication start time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_complete_time</maml:name> <maml:description> <maml:para>Replication complete time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_bytes_transferred</maml:name> <maml:description> <maml:para>Number of bytes transferred after replication completes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this snapshot collection was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this snapshot collection was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>online_status</maml:name> <maml:description> <maml:para>Online status of snapcoll. This is based on the online status of the individual snapshots.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vol_snap_attr_list</maml:name> <maml:description> <maml:para>List of snapshot attributes for snapshots being created as part of snapshot collection creation.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snapshots_list</maml:name> <maml:description> <maml:para>List of snapshots in the snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>replicate</maml:name> <maml:description> <maml:para>True if this snapshot collection has been marked for replication. This attribute cannot be updated for synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>replicate_to</maml:name> <maml:description> <maml:para>Specifies the partner name that the snapshots in this snapshot collection are replicated to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>start_online</maml:name> <maml:description> <maml:para>Start with snapshot set online.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>allow_writes</maml:name> <maml:description> <maml:para>Allow applications to write to created snapshot(s). Mandatory and must be set to 'true' for VSS application synchronized snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>disable_appsync</maml:name> <maml:description> <maml:para>Do not perform application synchronization for this snapshot, create a crash-consistent snapshot instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_verify</maml:name> <maml:description> <maml:para>Run verification tool on this snapshot. This option can only be used with a volume collection that has application synchronization.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>skip_db_consistency_check</maml:name> <maml:description> <maml:para>Skip consistency check for database files on this snapshot. This option only applies to volume collections with application synchronization set to VSS, application ID set to MS Exchange 2010 or later with Database Availability Group (DAG), snap_verify option set to true, and disable_appsync option set to false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>sched_id</maml:name> <maml:description> <maml:para>ID of protection schedule of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>sched_name</maml:name> <maml:description> <maml:para>Name of protection schedule of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>invoke_on_upstream_partner</maml:name> <maml:description> <maml:para>Invoke snapshot request on upstream partner. This operation is not supported for synchronous replication volume vollections.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type for snapshots being created as part of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>expiry_after</maml:name> <maml:description> <maml:para>Number of seconds after which this snapcoll is considered expired by the snapshot TTL. A value of 0 indicates that the snapshot never expires, 1 indicates that the snapshot uses a group-level configured TTL value and any other value indicates the number of seconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment a snapshot collection's attributes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified snapshot collection even if it is the last replicated snapshot. Doing so could lead to full re-seeding at the next replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Remove-NSSnapshotCollection -id 0528eada7f8dd99d3b0000000000000000000000bb </dev:code> <dev:remarks> <maml:para>This command will remove an initiator group specified by its ID. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSShelf</command:name> <maml:description> <maml:para>Retrieve information about a shelf or a list of shelves.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSShelf</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Retrieve information about a shelf or a list of shelves.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of shelf.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_name</maml:name> <maml:description> <maml:para>Name of array the shelf belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_id</maml:name> <maml:description> <maml:para>ID of array the shelf belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>partial_response_ok</maml:name> <maml:description> <maml:para>Indicate that it is okay to provide partially available response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>chassis_type</maml:name> <maml:description> <maml:para>Chassis type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ctrlrs</maml:name> <maml:description> <maml:para>List of ctrlr info.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>serial</maml:name> <maml:description> <maml:para>The serial number of the chassis.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>model</maml:name> <maml:description> <maml:para>Model of the shelf or head unit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>model_ext</maml:name> <maml:description> <maml:para>Extended model of the shelf or head unit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>chassis_sensors</maml:name> <maml:description> <maml:para>List of chassis sensor readings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>psu_overall_status</maml:name> <maml:description> <maml:para>The overall status for the PSUs.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fan_overall_status</maml:name> <maml:description> <maml:para>The overall status for the fans on both controllers.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>temp_overall_status</maml:name> <maml:description> <maml:para>The overall status for the temperature on both controllers.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>disk_sets</maml:name> <maml:description> <maml:para>Attributes for the disk sets in this shelf.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>activated</maml:name> <maml:description> <maml:para>Activated state for shelf or disk set means it is available to store date on. An activated shelf may not be deactivated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>driveset</maml:name> <maml:description> <maml:para>Driveset to activate.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly activate shelf.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>accept_foreign</maml:name> <maml:description> <maml:para>Accept the removal of data on the shelf disks and activate foreign shelf.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>accept_dedupe_impact</maml:name> <maml:description> <maml:para>Accept the reduction or elimination of deduplication capability on the system as a result of activating a shelf that does not meet the necessary deduplication requirements.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_request</maml:name> <maml:description> <maml:para>Indicates this is the last request in a series of shelf add requests.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of shelf.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>array_name</maml:name> <maml:description> <maml:para>Name of array the shelf belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>array_id</maml:name> <maml:description> <maml:para>ID of array the shelf belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>partial_response_ok</maml:name> <maml:description> <maml:para>Indicate that it is okay to provide partially available response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>chassis_type</maml:name> <maml:description> <maml:para>Chassis type.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>ctrlrs</maml:name> <maml:description> <maml:para>List of ctrlr info.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>serial</maml:name> <maml:description> <maml:para>The serial number of the chassis.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>model</maml:name> <maml:description> <maml:para>Model of the shelf or head unit.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>model_ext</maml:name> <maml:description> <maml:para>Extended model of the shelf or head unit.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>chassis_sensors</maml:name> <maml:description> <maml:para>List of chassis sensor readings.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>psu_overall_status</maml:name> <maml:description> <maml:para>The overall status for the PSUs.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>fan_overall_status</maml:name> <maml:description> <maml:para>The overall status for the fans on both controllers.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>temp_overall_status</maml:name> <maml:description> <maml:para>The overall status for the temperature on both controllers.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>disk_sets</maml:name> <maml:description> <maml:para>Attributes for the disk sets in this shelf.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>activated</maml:name> <maml:description> <maml:para>Activated state for shelf or disk set means it is available to store date on. An activated shelf may not be deactivated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>driveset</maml:name> <maml:description> <maml:para>Driveset to activate.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly activate shelf.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>accept_foreign</maml:name> <maml:description> <maml:para>Accept the removal of data on the shelf disks and activate foreign shelf.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>accept_dedupe_impact</maml:name> <maml:description> <maml:para>Accept the reduction or elimination of deduplication capability on the system as a result of activating a shelf that does not meet the necessary deduplication requirements.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_request</maml:name> <maml:description> <maml:para>Indicates this is the last request in a series of shelf add requests.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSShelf</command:name> <maml:description> <maml:para>Activate a shelf. Use 'accept_foreign=true' with 'activated=true' to force a foreign shelf to activate. Use 'accept_dedupe_impact' with 'activated=true' to force activation of a shelf even if it reduces or eliminates the deduplication capabilities of the array. The force option is being deprecated.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSShelf</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Activate a shelf. Use 'accept_foreign=true' with 'activated=true' to force a foreign shelf to activate. Use 'accept_dedupe_impact' with 'activated=true' to force activation of a shelf even if it reduces or eliminates the deduplication capabilities of the array. The force option is being deprecated.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of shelf.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_name</maml:name> <maml:description> <maml:para>Name of array the shelf belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_id</maml:name> <maml:description> <maml:para>ID of array the shelf belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>partial_response_ok</maml:name> <maml:description> <maml:para>Indicate that it is okay to provide partially available response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>chassis_type</maml:name> <maml:description> <maml:para>Chassis type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ctrlrs</maml:name> <maml:description> <maml:para>List of ctrlr info.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>serial</maml:name> <maml:description> <maml:para>The serial number of the chassis.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>model</maml:name> <maml:description> <maml:para>Model of the shelf or head unit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>model_ext</maml:name> <maml:description> <maml:para>Extended model of the shelf or head unit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>chassis_sensors</maml:name> <maml:description> <maml:para>List of chassis sensor readings.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>psu_overall_status</maml:name> <maml:description> <maml:para>The overall status for the PSUs.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fan_overall_status</maml:name> <maml:description> <maml:para>The overall status for the fans on both controllers.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>temp_overall_status</maml:name> <maml:description> <maml:para>The overall status for the temperature on both controllers.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>disk_sets</maml:name> <maml:description> <maml:para>Attributes for the disk sets in this shelf.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSShelf</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>activated</maml:name> <maml:description> <maml:para>Activated state for shelf or disk set means it is available to store date on. An activated shelf may not be deactivated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>driveset</maml:name> <maml:description> <maml:para>Driveset to activate.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly activate shelf.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>accept_foreign</maml:name> <maml:description> <maml:para>Accept the removal of data on the shelf disks and activate foreign shelf.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>accept_dedupe_impact</maml:name> <maml:description> <maml:para>Accept the reduction or elimination of deduplication capability on the system as a result of activating a shelf that does not meet the necessary deduplication requirements.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_request</maml:name> <maml:description> <maml:para>Indicates this is the last request in a series of shelf add requests.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of shelf.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>array_name</maml:name> <maml:description> <maml:para>Name of array the shelf belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>array_id</maml:name> <maml:description> <maml:para>ID of array the shelf belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>partial_response_ok</maml:name> <maml:description> <maml:para>Indicate that it is okay to provide partially available response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>chassis_type</maml:name> <maml:description> <maml:para>Chassis type.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>ctrlrs</maml:name> <maml:description> <maml:para>List of ctrlr info.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>serial</maml:name> <maml:description> <maml:para>The serial number of the chassis.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>model</maml:name> <maml:description> <maml:para>Model of the shelf or head unit.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>model_ext</maml:name> <maml:description> <maml:para>Extended model of the shelf or head unit.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>chassis_sensors</maml:name> <maml:description> <maml:para>List of chassis sensor readings.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>psu_overall_status</maml:name> <maml:description> <maml:para>The overall status for the PSUs.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>fan_overall_status</maml:name> <maml:description> <maml:para>The overall status for the fans on both controllers.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>temp_overall_status</maml:name> <maml:description> <maml:para>The overall status for the temperature on both controllers.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>disk_sets</maml:name> <maml:description> <maml:para>Attributes for the disk sets in this shelf.</maml:para> </maml:description> <command:parameterValue required="false" 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="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>activated</maml:name> <maml:description> <maml:para>Activated state for shelf or disk set means it is available to store date on. An activated shelf may not be deactivated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>driveset</maml:name> <maml:description> <maml:para>Driveset to activate.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly activate shelf.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>accept_foreign</maml:name> <maml:description> <maml:para>Accept the removal of data on the shelf disks and activate foreign shelf.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>accept_dedupe_impact</maml:name> <maml:description> <maml:para>Accept the reduction or elimination of deduplication capability on the system as a result of activating a shelf that does not meet the necessary deduplication requirements.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_request</maml:name> <maml:description> <maml:para>Indicates this is the last request in a series of shelf add requests.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Show-NSShelf</command:name> <maml:description> <maml:para>Turn on chassis identifier for a controller.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Show-</command:verb> <command:noun>-NSShelf</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Turn on chassis identifier for a controller.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Show-NSShelf</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of shelf.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Show-NSShelf</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cid</maml:name> <maml:description> <maml:para>Possible values: 'A', 'B'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Show-NSShelf</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Status value of identifier to set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of shelf.</maml:para> </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="true (ByValue)" position="named"> <maml:name>cid</maml:name> <maml:description> <maml:para>Possible values: 'A', 'B'.</maml:para> </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="true (ByValue)" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Status value of identifier to set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSShelf</command:name> <maml:description> <maml:para>Perform shelf evacuation.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remov</command:verb> <command:noun>-NSShelf</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Perform shelf evacuation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSShelf</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of shelf.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSShelf</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>driveset</maml:name> <maml:description> <maml:para>Driveset to evacuate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dry_run</maml:name> <maml:description> <maml:para>Argument to perform a dry run, not the actual shelf evacuation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>start</maml:name> <maml:description> <maml:para>Argument to perform the shelf evacuation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cancel</maml:name> <maml:description> <maml:para>Argument to cancel the shelf evacuation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pause</maml:name> <maml:description> <maml:para>Argument to pause the shelf evacuation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSShelf</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>resume</maml:name> <maml:description> <maml:para>Argument to resume the shelf evacuation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of shelf.</maml:para> </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="true (ByValue)" position="named"> <maml:name>driveset</maml:name> <maml:description> <maml:para>Driveset to evacuate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dry_run</maml:name> <maml:description> <maml:para>Argument to perform a dry run, not the actual shelf evacuation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>start</maml:name> <maml:description> <maml:para>Argument to perform the shelf evacuation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cancel</maml:name> <maml:description> <maml:para>Argument to cancel the shelf evacuation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pause</maml:name> <maml:description> <maml:para>Argument to pause the shelf evacuation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>resume</maml:name> <maml:description> <maml:para>Argument to resume the shelf evacuation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSProtocolEndpoint</command:name> <maml:description> <maml:para>Retrieve information on a set of protocol endpoints or a single protocol endpoint.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSProtocolEndpoint</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Retrieve information on a set of protocol endpoints or a single protocol endpoint.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSProtocolEndpoint</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the protocol endpoint.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtocolEndpoint</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the protocol endpoint.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtocolEndpoint</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of the protocol endpoint.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtocolEndpoint</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool where the protocol endpoint resides. If pool option is not specified, protocol endpoint is assigned to the default pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtocolEndpoint</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>Identifier associated with the pool in the storage pool table.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtocolEndpoint</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>state</maml:name> <maml:description> <maml:para>Operational state of protocol endpoint.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtocolEndpoint</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>serial_number</maml:name> <maml:description> <maml:para>Identifier associated with the protocol endpoint for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtocolEndpoint</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>target_name</maml:name> <maml:description> <maml:para>The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target protocol endpoint.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtocolEndpoint</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group_specific_ids</maml:name> <maml:description> <maml:para>External UID is used to compute the serial number and IQN which never change even if the running group changes (e.g. after group merge). Group-specific IDs determine whether external UID is used for computing serial number and IQN.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtocolEndpoint</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this protocol endpoint was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtocolEndpoint</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this protocol endpoint was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtocolEndpoint</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_connections</maml:name> <maml:description> <maml:para>Number of connections via this protocol endpoint.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtocolEndpoint</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_iscsi_connections</maml:name> <maml:description> <maml:para>Number of iSCSI connections via this protocol endpoint.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtocolEndpoint</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_fc_connections</maml:name> <maml:description> <maml:para>Number of FC connections via this protocol endpoint.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtocolEndpoint</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_control_records</maml:name> <maml:description> <maml:para>List of access control records that apply to this protocol endpoint.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtocolEndpoint</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_sessions</maml:name> <maml:description> <maml:para>List of iSCSI sessions connected to this protocol endpoint.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtocolEndpoint</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fc_sessions</maml:name> <maml:description> <maml:para>List of FC sessions connected to this protocol endpoint.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtocolEndpoint</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Access protocol of the protocol endpoint. Only initiator groups with the same access protocol can access the protocol endpoint. If not specified in the creation request, it will be the access protocol supported by the group. If the group supports multiple protocols, the default will be Fibre Channel.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the protocol endpoint.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the protocol endpoint.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of the protocol endpoint.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool where the protocol endpoint resides. If pool option is not specified, protocol endpoint is assigned to the default pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>Identifier associated with the pool in the storage pool table.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>state</maml:name> <maml:description> <maml:para>Operational state of protocol endpoint.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>serial_number</maml:name> <maml:description> <maml:para>Identifier associated with the protocol endpoint for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>target_name</maml:name> <maml:description> <maml:para>The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target protocol endpoint.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>group_specific_ids</maml:name> <maml:description> <maml:para>External UID is used to compute the serial number and IQN which never change even if the running group changes (e.g. after group merge). Group-specific IDs determine whether external UID is used for computing serial number and IQN.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this protocol endpoint was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this protocol endpoint was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_connections</maml:name> <maml:description> <maml:para>Number of connections via this protocol endpoint.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_iscsi_connections</maml:name> <maml:description> <maml:para>Number of iSCSI connections via this protocol endpoint.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_fc_connections</maml:name> <maml:description> <maml:para>Number of FC connections via this protocol endpoint.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>access_control_records</maml:name> <maml:description> <maml:para>List of access control records that apply to this protocol endpoint.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>iscsi_sessions</maml:name> <maml:description> <maml:para>List of iSCSI sessions connected to this protocol endpoint.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>fc_sessions</maml:name> <maml:description> <maml:para>List of FC sessions connected to this protocol endpoint.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Access protocol of the protocol endpoint. Only initiator groups with the same access protocol can access the protocol endpoint. If not specified in the creation request, it will be the access protocol supported by the group. If the group supports multiple protocols, the default will be Fibre Channel.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSFibreChannelInterface</command:name> <maml:description> <maml:para>List a set of Fibre Channel interfaces or a single Fibre Channel interface.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSFibreChannelInterface</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List a set of Fibre Channel interfaces or a single Fibre Channel interface.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the Fibre Channel interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_name_or_serial</maml:name> <maml:description> <maml:para>Name or serial number of array where the interface is hosted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>partial_response_ok</maml:name> <maml:description> <maml:para>Indicate that it is ok to provide partially available response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>controller_name</maml:name> <maml:description> <maml:para>Name (A or B) of the controller where the interface is hosted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fc_port_id</maml:name> <maml:description> <maml:para>ID of the port with which the interface is associated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of Fibre Channel interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>wwnn</maml:name> <maml:description> <maml:para>WWNN (World Wide Node Name) for this Fibre Channel interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>wwpn</maml:name> <maml:description> <maml:para>WWPN (World Wide Port Name) for this Fibre Channel interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>peerzone</maml:name> <maml:description> <maml:para>Active peer zone for this Fibre Channel interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>online</maml:name> <maml:description> <maml:para>Identify whether the Fibre Channel interface is online.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>firmware_version</maml:name> <maml:description> <maml:para>Version of the Fibre Channel firmware.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>logical_port_number</maml:name> <maml:description> <maml:para>Logical port number for the Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fc_port_name</maml:name> <maml:description> <maml:para>Name of Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>bus_location</maml:name> <maml:description> <maml:para>PCI bus location of the HBA for this Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>slot</maml:name> <maml:description> <maml:para>HBA slot number for this Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>orientation</maml:name> <maml:description> <maml:para>Orientation of FC ports on a HBA. An orientation of 'right_to_left' indicates that ports are ordered as 3,2,1,0 on the slot. Possible values: 'left_to_right', 'right_to_left'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>HBA port number for this Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>link_info</maml:name> <maml:description> <maml:para>Information about the Fibre Channel link at which interface is operating.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fabric_info</maml:name> <maml:description> <maml:para>Fibre Channel fabric information.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the Fibre Channel interface.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>array_name_or_serial</maml:name> <maml:description> <maml:para>Name or serial number of array where the interface is hosted.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>partial_response_ok</maml:name> <maml:description> <maml:para>Indicate that it is ok to provide partially available response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>controller_name</maml:name> <maml:description> <maml:para>Name (A or B) of the controller where the interface is hosted.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>fc_port_id</maml:name> <maml:description> <maml:para>ID of the port with which the interface is associated.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of Fibre Channel interface.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>wwnn</maml:name> <maml:description> <maml:para>WWNN (World Wide Node Name) for this Fibre Channel interface.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>wwpn</maml:name> <maml:description> <maml:para>WWPN (World Wide Port Name) for this Fibre Channel interface.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>peerzone</maml:name> <maml:description> <maml:para>Active peer zone for this Fibre Channel interface.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>online</maml:name> <maml:description> <maml:para>Identify whether the Fibre Channel interface is online.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>firmware_version</maml:name> <maml:description> <maml:para>Version of the Fibre Channel firmware.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>logical_port_number</maml:name> <maml:description> <maml:para>Logical port number for the Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>fc_port_name</maml:name> <maml:description> <maml:para>Name of Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>bus_location</maml:name> <maml:description> <maml:para>PCI bus location of the HBA for this Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>slot</maml:name> <maml:description> <maml:para>HBA slot number for this Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>orientation</maml:name> <maml:description> <maml:para>Orientation of FC ports on a HBA. An orientation of 'right_to_left' indicates that ports are ordered as 3,2,1,0 on the slot. Possible values: 'left_to_right', 'right_to_left'.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>HBA port number for this Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>link_info</maml:name> <maml:description> <maml:para>Information about the Fibre Channel link at which interface is operating.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>fabric_info</maml:name> <maml:description> <maml:para>Fibre Channel fabric information.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSFibreChannelInterface</command:name> <maml:description> <maml:para>Modify the online attribute (i.e., the administrative state) of the Fibre Channel interface.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSFibreChannelInterface</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Modify the online attribute (i.e., the administrative state) of the Fibre Channel interface.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSFibreChannelInterface</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the Fibre Channel interface.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_name_or_serial</maml:name> <maml:description> <maml:para>Name or serial number of array where the interface is hosted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>partial_response_ok</maml:name> <maml:description> <maml:para>Indicate that it is ok to provide partially available response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>controller_name</maml:name> <maml:description> <maml:para>Name (A or B) of the controller where the interface is hosted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fc_port_id</maml:name> <maml:description> <maml:para>ID of the port with which the interface is associated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of Fibre Channel interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>wwnn</maml:name> <maml:description> <maml:para>WWNN (World Wide Node Name) for this Fibre Channel interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>wwpn</maml:name> <maml:description> <maml:para>WWPN (World Wide Port Name) for this Fibre Channel interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>peerzone</maml:name> <maml:description> <maml:para>Active peer zone for this Fibre Channel interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFibreChannelInterface</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>online</maml:name> <maml:description> <maml:para>Identify whether the Fibre Channel interface is online.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>firmware_version</maml:name> <maml:description> <maml:para>Version of the Fibre Channel firmware.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>logical_port_number</maml:name> <maml:description> <maml:para>Logical port number for the Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fc_port_name</maml:name> <maml:description> <maml:para>Name of Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>bus_location</maml:name> <maml:description> <maml:para>PCI bus location of the HBA for this Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>slot</maml:name> <maml:description> <maml:para>HBA slot number for this Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>orientation</maml:name> <maml:description> <maml:para>Orientation of FC ports on a HBA. An orientation of 'right_to_left' indicates that ports are ordered as 3,2,1,0 on the slot. Possible values: 'left_to_right', 'right_to_left'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>HBA port number for this Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>link_info</maml:name> <maml:description> <maml:para>Information about the Fibre Channel link at which interface is operating.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFibreChannelInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fabric_info</maml:name> <maml:description> <maml:para>Fibre Channel fabric information.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the Fibre Channel interface.</maml:para> </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="true (ByValue)" position="named"> <maml:name>array_name_or_serial</maml:name> <maml:description> <maml:para>Name or serial number of array where the interface is hosted.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>partial_response_ok</maml:name> <maml:description> <maml:para>Indicate that it is ok to provide partially available response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>controller_name</maml:name> <maml:description> <maml:para>Name (A or B) of the controller where the interface is hosted.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>fc_port_id</maml:name> <maml:description> <maml:para>ID of the port with which the interface is associated.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of Fibre Channel interface.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>wwnn</maml:name> <maml:description> <maml:para>WWNN (World Wide Node Name) for this Fibre Channel interface.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>wwpn</maml:name> <maml:description> <maml:para>WWPN (World Wide Port Name) for this Fibre Channel interface.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>peerzone</maml:name> <maml:description> <maml:para>Active peer zone for this Fibre Channel interface.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>online</maml:name> <maml:description> <maml:para>Identify whether the Fibre Channel interface is online.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>firmware_version</maml:name> <maml:description> <maml:para>Version of the Fibre Channel firmware.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>logical_port_number</maml:name> <maml:description> <maml:para>Logical port number for the Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>fc_port_name</maml:name> <maml:description> <maml:para>Name of Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>bus_location</maml:name> <maml:description> <maml:para>PCI bus location of the HBA for this Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>slot</maml:name> <maml:description> <maml:para>HBA slot number for this Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>orientation</maml:name> <maml:description> <maml:para>Orientation of FC ports on a HBA. An orientation of 'right_to_left' indicates that ports are ordered as 3,2,1,0 on the slot. Possible values: 'left_to_right', 'right_to_left'.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>HBA port number for this Fibre Channel port.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>link_info</maml:name> <maml:description> <maml:para>Information about the Fibre Channel link at which interface is operating.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>fabric_info</maml:name> <maml:description> <maml:para>Fibre Channel fabric information.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSFibreChannelSession</command:name> <maml:description> <maml:para>Retrieve information on a set of Fibre Channel sessions or a single Fibre Channel session.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSFibreChannelSession</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Retrieve information on a set of Fibre Channel sessions or a single Fibre Channel session.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSFibreChannelSession</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Unique identifier of the Fibre Channel session.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelSession</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>initiator_info</maml:name> <maml:description> <maml:para>Information about the Fibre Channel initiator.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelSession</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>target_info</maml:name> <maml:description> <maml:para>Information about the Fibre Channel target.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Unique identifier of the Fibre Channel session.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>initiator_info</maml:name> <maml:description> <maml:para>Information about the Fibre Channel initiator.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>target_info</maml:name> <maml:description> <maml:para>Information about the Fibre Channel target.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSVolumeCollection</command:name> <maml:description> <maml:para>Create a volume collection.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSVolumeCollection</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Create a volume collection.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>prottmpl_id</maml:name> <maml:description> <maml:para>Identifier of the protection template whose attributes will be used to create this volume collection. This attribute is only used for input when creating a volume collection and is not outputed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of volume collection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of volume collection used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_priority</maml:name> <maml:description> <maml:para>Replication priority for the volume collection with the following choices: {normal | high}.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pol_owner_name</maml:name> <maml:description> <maml:para>Owner group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replication_type</maml:name> <maml:description> <maml:para>Type of replication configured for the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>synchronous_replication_type</maml:name> <maml:description> <maml:para>Type of synchronous replication configured for the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>synchronous_replication_state</maml:name> <maml:description> <maml:para>State of synchronous replication on the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_sync</maml:name> <maml:description> <maml:para>Application Synchronization.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_server</maml:name> <maml:description> <maml:para>Application server hostname.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_id</maml:name> <maml:description> <maml:para>Application ID running on the server. Application ID can only be specified if application synchronization is \\"vss\\".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_cluster_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment, this is the cluster name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_service_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment then this is the instance name of the service running within the cluster environment.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vcenter_hostname</maml:name> <maml:description> <maml:para>VMware vCenter hostname. Custom port number can be specified with vCenter hostname using \\":\\".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vcenter_username</maml:name> <maml:description> <maml:para>Application VMware vCenter username.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vcenter_password</maml:name> <maml:description> <maml:para>Application VMware vCenter password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_hostname</maml:name> <maml:description> <maml:para>Generic backup agent hostname. Custom port number can be specified with agent hostname using \\":\\".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_username</maml:name> <maml:description> <maml:para>Generic backup agent username.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_password</maml:name> <maml:description> <maml:para>Generic backup agent password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this volume collection was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified_time</maml:name> <maml:description> <maml:para>Time when this volume collection was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>downstream_volume_list</maml:name> <maml:description> <maml:para>List of downstream volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>upstream_volume_list</maml:name> <maml:description> <maml:para>List of upstream volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Count of volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache_pinned_volume_list</maml:name> <maml:description> <maml:para>List of cache pinned volumes associated with volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_snapcoll</maml:name> <maml:description> <maml:para>Last snapshot collection on this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snapcoll_count</maml:name> <maml:description> <maml:para>Count of snapshot collections associated with volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>schedule_list</maml:name> <maml:description> <maml:para>List of snapshot schedules associated with volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replication_partner</maml:name> <maml:description> <maml:para>Replication partner for this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_replicated_snapcoll</maml:name> <maml:description> <maml:para>Last replicated snapshot collection on this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_replicated_snapcoll_list</maml:name> <maml:description> <maml:para>List of snapshot collection information for the last replicated snapshot collection per schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>protection_type</maml:name> <maml:description> <maml:para>Specifies if volume collection is protected with schedules. If protected, indicated whether replication is setup.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>lag_time</maml:name> <maml:description> <maml:para>Replication lag time for volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_standalone_volcoll</maml:name> <maml:description> <maml:para>Indicates whether this is a standalone volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>total_repl_bytes</maml:name> <maml:description> <maml:para>Total size of volumes to be replicated for this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_bytes_transferred</maml:name> <maml:description> <maml:para>Total size of volumes replicated for this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_handing_over</maml:name> <maml:description> <maml:para>Indicates whether a handover operation is in progress on this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>handover_replication_partner</maml:name> <maml:description> <maml:para>Replication partner to which ownership is being transferred as part of handover operation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment a volume collection's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>srep_last_sync</maml:name> <maml:description> <maml:para>Time when a synchronously replicated volume collection was last synchronized.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>srep_resync_percent</maml:name> <maml:description> <maml:para>Percentage of the resync progress for a synchronously replicated volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>prottmpl_id</maml:name> <maml:description> <maml:para>Identifier of the protection template whose attributes will be used to create this volume collection. This attribute is only used for input when creating a volume collection and is not outputed.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of volume collection.</maml:para> </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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of volume collection used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>repl_priority</maml:name> <maml:description> <maml:para>Replication priority for the volume collection with the following choices: {normal | high}.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pol_owner_name</maml:name> <maml:description> <maml:para>Owner group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>replication_type</maml:name> <maml:description> <maml:para>Type of replication configured for the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>synchronous_replication_type</maml:name> <maml:description> <maml:para>Type of synchronous replication configured for the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>synchronous_replication_state</maml:name> <maml:description> <maml:para>State of synchronous replication on the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_sync</maml:name> <maml:description> <maml:para>Application Synchronization.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_server</maml:name> <maml:description> <maml:para>Application server hostname.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_id</maml:name> <maml:description> <maml:para>Application ID running on the server. Application ID can only be specified if application synchronization is \\"vss\\".</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_cluster_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment, this is the cluster name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_service_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment then this is the instance name of the service running within the cluster environment.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vcenter_hostname</maml:name> <maml:description> <maml:para>VMware vCenter hostname. Custom port number can be specified with vCenter hostname using \\":\\".</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vcenter_username</maml:name> <maml:description> <maml:para>Application VMware vCenter username.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vcenter_password</maml:name> <maml:description> <maml:para>Application VMware vCenter password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_hostname</maml:name> <maml:description> <maml:para>Generic backup agent hostname. Custom port number can be specified with agent hostname using \\":\\".</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_username</maml:name> <maml:description> <maml:para>Generic backup agent username.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_password</maml:name> <maml:description> <maml:para>Generic backup agent password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this volume collection was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified_time</maml:name> <maml:description> <maml:para>Time when this volume collection was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>downstream_volume_list</maml:name> <maml:description> <maml:para>List of downstream volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>upstream_volume_list</maml:name> <maml:description> <maml:para>List of upstream volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Count of volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache_pinned_volume_list</maml:name> <maml:description> <maml:para>List of cache pinned volumes associated with volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_snapcoll</maml:name> <maml:description> <maml:para>Last snapshot collection on this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snapcoll_count</maml:name> <maml:description> <maml:para>Count of snapshot collections associated with volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>schedule_list</maml:name> <maml:description> <maml:para>List of snapshot schedules associated with volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>replication_partner</maml:name> <maml:description> <maml:para>Replication partner for this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>last_replicated_snapcoll</maml:name> <maml:description> <maml:para>Last replicated snapshot collection on this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_replicated_snapcoll_list</maml:name> <maml:description> <maml:para>List of snapshot collection information for the last replicated snapshot collection per schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>protection_type</maml:name> <maml:description> <maml:para>Specifies if volume collection is protected with schedules. If protected, indicated whether replication is setup.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>lag_time</maml:name> <maml:description> <maml:para>Replication lag time for volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_standalone_volcoll</maml:name> <maml:description> <maml:para>Indicates whether this is a standalone volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>total_repl_bytes</maml:name> <maml:description> <maml:para>Total size of volumes to be replicated for this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_bytes_transferred</maml:name> <maml:description> <maml:para>Total size of volumes replicated for this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_handing_over</maml:name> <maml:description> <maml:para>Indicates whether a handover operation is in progress on this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>handover_replication_partner</maml:name> <maml:description> <maml:para>Replication partner to which ownership is being transferred as part of handover operation.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment a volume collection's attributes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>srep_last_sync</maml:name> <maml:description> <maml:para>Time when a synchronously replicated volume collection was last synchronized.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>srep_resync_percent</maml:name> <maml:description> <maml:para>Percentage of the resync progress for a synchronously replicated volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> New-NSVolumeCollection -name test4 Name creation_time snapcoll_count app_sync id description ---- ------------- -------------- -------- -- ----------- test4 1533274233 0 none 0728eada7f8dd99d3b00000000000000000000009d </dev:code> <dev:remarks> <maml:para>This command will create a new volume collections using the minimal number of parameters. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 2 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> new-NSVolumeCollection -name test5 -description "My Test VolCollection" -app_sync vss -app_server MyHost.fqdn.com -app_id hyperv Name creation_time snapcoll_count app_sync id description ---- ------------- -------------- -------- -- ----------- test5 1533274233 0 vss 0728eada7f8dd99d3b00000000000000000000009e My Test VolCollection </dev:code> <dev:remarks> <maml:para>This command will create a new Volume Collection for hyper-V based storage that uses VSS enabled Snapshots. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 3 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> new-NSVolumeCollection -name test6 -description "My Test VolCollection" -app_sync vss -app_server MyHost.fqdn.com -app_id hyper-v Name creation_time snapcoll_count app_sync id description ---- ------------- -------------- -------- -- ----------- test6 1533274233 0 vmware 0728eada7f8dd99d3b00000000000000000000009f My Test VolCollection </dev:code> <dev:remarks> <maml:para>This command will create a new Volume Collection for VMWare VM based storage that uses vCenter orchestrated Snapshots. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSVolumeCollection</command:name> <maml:description> <maml:para>Read a set of volume collections or a single volume collection.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSVolumeCollection</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Read a set of volume collections or a single volume collection.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>prottmpl_id</maml:name> <maml:description> <maml:para>Identifier of the protection template whose attributes will be used to create this volume collection. This attribute is only used for input when creating a volume collection and is not outputed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of volume collection used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_priority</maml:name> <maml:description> <maml:para>Replication priority for the volume collection with the following choices: {normal | high}.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pol_owner_name</maml:name> <maml:description> <maml:para>Owner group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replication_type</maml:name> <maml:description> <maml:para>Type of replication configured for the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>synchronous_replication_type</maml:name> <maml:description> <maml:para>Type of synchronous replication configured for the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>synchronous_replication_state</maml:name> <maml:description> <maml:para>State of synchronous replication on the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_sync</maml:name> <maml:description> <maml:para>Application Synchronization.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_server</maml:name> <maml:description> <maml:para>Application server hostname.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_id</maml:name> <maml:description> <maml:para>Application ID running on the server. Application ID can only be specified if application synchronization is \\"vss\\".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_cluster_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment, this is the cluster name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_service_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment then this is the instance name of the service running within the cluster environment.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vcenter_hostname</maml:name> <maml:description> <maml:para>VMware vCenter hostname. Custom port number can be specified with vCenter hostname using \\":\\".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vcenter_username</maml:name> <maml:description> <maml:para>Application VMware vCenter username.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vcenter_password</maml:name> <maml:description> <maml:para>Application VMware vCenter password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_hostname</maml:name> <maml:description> <maml:para>Generic backup agent hostname. Custom port number can be specified with agent hostname using \\":\\".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_username</maml:name> <maml:description> <maml:para>Generic backup agent username.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_password</maml:name> <maml:description> <maml:para>Generic backup agent password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this volume collection was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified_time</maml:name> <maml:description> <maml:para>Time when this volume collection was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>downstream_volume_list</maml:name> <maml:description> <maml:para>List of downstream volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>upstream_volume_list</maml:name> <maml:description> <maml:para>List of upstream volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Count of volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache_pinned_volume_list</maml:name> <maml:description> <maml:para>List of cache pinned volumes associated with volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_snapcoll</maml:name> <maml:description> <maml:para>Last snapshot collection on this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snapcoll_count</maml:name> <maml:description> <maml:para>Count of snapshot collections associated with volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>schedule_list</maml:name> <maml:description> <maml:para>List of snapshot schedules associated with volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replication_partner</maml:name> <maml:description> <maml:para>Replication partner for this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_replicated_snapcoll</maml:name> <maml:description> <maml:para>Last replicated snapshot collection on this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_replicated_snapcoll_list</maml:name> <maml:description> <maml:para>List of snapshot collection information for the last replicated snapshot collection per schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>protection_type</maml:name> <maml:description> <maml:para>Specifies if volume collection is protected with schedules. If protected, indicated whether replication is setup.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>lag_time</maml:name> <maml:description> <maml:para>Replication lag time for volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_standalone_volcoll</maml:name> <maml:description> <maml:para>Indicates whether this is a standalone volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>total_repl_bytes</maml:name> <maml:description> <maml:para>Total size of volumes to be replicated for this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_bytes_transferred</maml:name> <maml:description> <maml:para>Total size of volumes replicated for this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_handing_over</maml:name> <maml:description> <maml:para>Indicates whether a handover operation is in progress on this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>handover_replication_partner</maml:name> <maml:description> <maml:para>Replication partner to which ownership is being transferred as part of handover operation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment a volume collection's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>srep_last_sync</maml:name> <maml:description> <maml:para>Time when a synchronously replicated volume collection was last synchronized.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>srep_resync_percent</maml:name> <maml:description> <maml:para>Percentage of the resync progress for a synchronously replicated volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>prottmpl_id</maml:name> <maml:description> <maml:para>Identifier of the protection template whose attributes will be used to create this volume collection. This attribute is only used for input when creating a volume collection and is not outputed.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of volume collection used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>repl_priority</maml:name> <maml:description> <maml:para>Replication priority for the volume collection with the following choices: {normal | high}.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pol_owner_name</maml:name> <maml:description> <maml:para>Owner group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>replication_type</maml:name> <maml:description> <maml:para>Type of replication configured for the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>synchronous_replication_type</maml:name> <maml:description> <maml:para>Type of synchronous replication configured for the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>synchronous_replication_state</maml:name> <maml:description> <maml:para>State of synchronous replication on the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_sync</maml:name> <maml:description> <maml:para>Application Synchronization.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_server</maml:name> <maml:description> <maml:para>Application server hostname.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_id</maml:name> <maml:description> <maml:para>Application ID running on the server. Application ID can only be specified if application synchronization is \\"vss\\".</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_cluster_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment, this is the cluster name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_service_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment then this is the instance name of the service running within the cluster environment.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vcenter_hostname</maml:name> <maml:description> <maml:para>VMware vCenter hostname. Custom port number can be specified with vCenter hostname using \\":\\".</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vcenter_username</maml:name> <maml:description> <maml:para>Application VMware vCenter username.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vcenter_password</maml:name> <maml:description> <maml:para>Application VMware vCenter password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_hostname</maml:name> <maml:description> <maml:para>Generic backup agent hostname. Custom port number can be specified with agent hostname using \\":\\".</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_username</maml:name> <maml:description> <maml:para>Generic backup agent username.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_password</maml:name> <maml:description> <maml:para>Generic backup agent password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this volume collection was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified_time</maml:name> <maml:description> <maml:para>Time when this volume collection was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>downstream_volume_list</maml:name> <maml:description> <maml:para>List of downstream volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>upstream_volume_list</maml:name> <maml:description> <maml:para>List of upstream volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Count of volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache_pinned_volume_list</maml:name> <maml:description> <maml:para>List of cache pinned volumes associated with volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_snapcoll</maml:name> <maml:description> <maml:para>Last snapshot collection on this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snapcoll_count</maml:name> <maml:description> <maml:para>Count of snapshot collections associated with volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>schedule_list</maml:name> <maml:description> <maml:para>List of snapshot schedules associated with volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>replication_partner</maml:name> <maml:description> <maml:para>Replication partner for this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>last_replicated_snapcoll</maml:name> <maml:description> <maml:para>Last replicated snapshot collection on this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_replicated_snapcoll_list</maml:name> <maml:description> <maml:para>List of snapshot collection information for the last replicated snapshot collection per schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>protection_type</maml:name> <maml:description> <maml:para>Specifies if volume collection is protected with schedules. If protected, indicated whether replication is setup.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>lag_time</maml:name> <maml:description> <maml:para>Replication lag time for volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_standalone_volcoll</maml:name> <maml:description> <maml:para>Indicates whether this is a standalone volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>total_repl_bytes</maml:name> <maml:description> <maml:para>Total size of volumes to be replicated for this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_bytes_transferred</maml:name> <maml:description> <maml:para>Total size of volumes replicated for this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_handing_over</maml:name> <maml:description> <maml:para>Indicates whether a handover operation is in progress on this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>handover_replication_partner</maml:name> <maml:description> <maml:para>Replication partner to which ownership is being transferred as part of handover operation.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment a volume collection's attributes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>srep_last_sync</maml:name> <maml:description> <maml:para>Time when a synchronously replicated volume collection was last synchronized.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>srep_resync_percent</maml:name> <maml:description> <maml:para>Percentage of the resync progress for a synchronously replicated volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSVolumeCollection Name creation_time snapcoll_count app_sync id description ---- ------------- -------------- -------- -- ----------- testcol1 1520878446 1 vss 0728eada7f8dd99d3b000000000000000000000005 volcoll 1526559894 0 none 0728eada7f8dd99d3b000000000000000000000006 mycol1 1531438403 25 none 0728eada7f8dd99d3b000000000000000000000007 </dev:code> <dev:remarks> <maml:para>This command will retrieve the volume collections. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 2 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSVolumeCollection -name volcoll Name creation_time snapcoll_count app_sync id description ---- ------------- -------------- -------- -- ----------- volcoll 1526559894 0 none 0728eada7f8dd99d3b000000000000000000000006 </dev:code> <dev:remarks> <maml:para>This command will retrieve the volume collections specified by name. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSVolumeCollection</command:name> <maml:description> <maml:para>Modify attributes of the specified volume collection.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSVolumeCollection</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Modify attributes of the specified volume collection.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for volume collection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>prottmpl_id</maml:name> <maml:description> <maml:para>Identifier of the protection template whose attributes will be used to create this volume collection. This attribute is only used for input when creating a volume collection and is not outputed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of volume collection used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_priority</maml:name> <maml:description> <maml:para>Replication priority for the volume collection with the following choices: {normal | high}.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pol_owner_name</maml:name> <maml:description> <maml:para>Owner group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replication_type</maml:name> <maml:description> <maml:para>Type of replication configured for the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>synchronous_replication_type</maml:name> <maml:description> <maml:para>Type of synchronous replication configured for the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>synchronous_replication_state</maml:name> <maml:description> <maml:para>State of synchronous replication on the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_sync</maml:name> <maml:description> <maml:para>Application Synchronization.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_server</maml:name> <maml:description> <maml:para>Application server hostname.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_id</maml:name> <maml:description> <maml:para>Application ID running on the server. Application ID can only be specified if application synchronization is \\"vss\\".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_cluster_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment, this is the cluster name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_service_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment then this is the instance name of the service running within the cluster environment.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vcenter_hostname</maml:name> <maml:description> <maml:para>VMware vCenter hostname. Custom port number can be specified with vCenter hostname using \\":\\".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vcenter_username</maml:name> <maml:description> <maml:para>Application VMware vCenter username.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vcenter_password</maml:name> <maml:description> <maml:para>Application VMware vCenter password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_hostname</maml:name> <maml:description> <maml:para>Generic backup agent hostname. Custom port number can be specified with agent hostname using \\":\\".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_username</maml:name> <maml:description> <maml:para>Generic backup agent username.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_password</maml:name> <maml:description> <maml:para>Generic backup agent password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this volume collection was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified_time</maml:name> <maml:description> <maml:para>Time when this volume collection was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>downstream_volume_list</maml:name> <maml:description> <maml:para>List of downstream volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>upstream_volume_list</maml:name> <maml:description> <maml:para>List of upstream volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Count of volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache_pinned_volume_list</maml:name> <maml:description> <maml:para>List of cache pinned volumes associated with volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_snapcoll</maml:name> <maml:description> <maml:para>Last snapshot collection on this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snapcoll_count</maml:name> <maml:description> <maml:para>Count of snapshot collections associated with volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>schedule_list</maml:name> <maml:description> <maml:para>List of snapshot schedules associated with volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replication_partner</maml:name> <maml:description> <maml:para>Replication partner for this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_replicated_snapcoll</maml:name> <maml:description> <maml:para>Last replicated snapshot collection on this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_replicated_snapcoll_list</maml:name> <maml:description> <maml:para>List of snapshot collection information for the last replicated snapshot collection per schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>protection_type</maml:name> <maml:description> <maml:para>Specifies if volume collection is protected with schedules. If protected, indicated whether replication is setup.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>lag_time</maml:name> <maml:description> <maml:para>Replication lag time for volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_standalone_volcoll</maml:name> <maml:description> <maml:para>Indicates whether this is a standalone volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>total_repl_bytes</maml:name> <maml:description> <maml:para>Total size of volumes to be replicated for this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_bytes_transferred</maml:name> <maml:description> <maml:para>Total size of volumes replicated for this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_handing_over</maml:name> <maml:description> <maml:para>Indicates whether a handover operation is in progress on this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>handover_replication_partner</maml:name> <maml:description> <maml:para>Replication partner to which ownership is being transferred as part of handover operation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment a volume collection's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>srep_last_sync</maml:name> <maml:description> <maml:para>Time when a synchronously replicated volume collection was last synchronized.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>srep_resync_percent</maml:name> <maml:description> <maml:para>Percentage of the resync progress for a synchronously replicated volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for volume collection.</maml:para> </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="true (ByValue)" position="named"> <maml:name>prottmpl_id</maml:name> <maml:description> <maml:para>Identifier of the protection template whose attributes will be used to create this volume collection. This attribute is only used for input when creating a volume collection and is not outputed.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of volume collection used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>repl_priority</maml:name> <maml:description> <maml:para>Replication priority for the volume collection with the following choices: {normal | high}.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pol_owner_name</maml:name> <maml:description> <maml:para>Owner group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>replication_type</maml:name> <maml:description> <maml:para>Type of replication configured for the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>synchronous_replication_type</maml:name> <maml:description> <maml:para>Type of synchronous replication configured for the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>synchronous_replication_state</maml:name> <maml:description> <maml:para>State of synchronous replication on the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_sync</maml:name> <maml:description> <maml:para>Application Synchronization.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_server</maml:name> <maml:description> <maml:para>Application server hostname.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_id</maml:name> <maml:description> <maml:para>Application ID running on the server. Application ID can only be specified if application synchronization is \\"vss\\".</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_cluster_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment, this is the cluster name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_service_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment then this is the instance name of the service running within the cluster environment.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vcenter_hostname</maml:name> <maml:description> <maml:para>VMware vCenter hostname. Custom port number can be specified with vCenter hostname using \\":\\".</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vcenter_username</maml:name> <maml:description> <maml:para>Application VMware vCenter username.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vcenter_password</maml:name> <maml:description> <maml:para>Application VMware vCenter password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_hostname</maml:name> <maml:description> <maml:para>Generic backup agent hostname. Custom port number can be specified with agent hostname using \\":\\".</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_username</maml:name> <maml:description> <maml:para>Generic backup agent username.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_password</maml:name> <maml:description> <maml:para>Generic backup agent password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this volume collection was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified_time</maml:name> <maml:description> <maml:para>Time when this volume collection was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>downstream_volume_list</maml:name> <maml:description> <maml:para>List of downstream volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>upstream_volume_list</maml:name> <maml:description> <maml:para>List of upstream volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Count of volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache_pinned_volume_list</maml:name> <maml:description> <maml:para>List of cache pinned volumes associated with volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_snapcoll</maml:name> <maml:description> <maml:para>Last snapshot collection on this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snapcoll_count</maml:name> <maml:description> <maml:para>Count of snapshot collections associated with volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>schedule_list</maml:name> <maml:description> <maml:para>List of snapshot schedules associated with volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>replication_partner</maml:name> <maml:description> <maml:para>Replication partner for this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>last_replicated_snapcoll</maml:name> <maml:description> <maml:para>Last replicated snapshot collection on this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_replicated_snapcoll_list</maml:name> <maml:description> <maml:para>List of snapshot collection information for the last replicated snapshot collection per schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>protection_type</maml:name> <maml:description> <maml:para>Specifies if volume collection is protected with schedules. If protected, indicated whether replication is setup.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>lag_time</maml:name> <maml:description> <maml:para>Replication lag time for volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_standalone_volcoll</maml:name> <maml:description> <maml:para>Indicates whether this is a standalone volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>total_repl_bytes</maml:name> <maml:description> <maml:para>Total size of volumes to be replicated for this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_bytes_transferred</maml:name> <maml:description> <maml:para>Total size of volumes replicated for this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_handing_over</maml:name> <maml:description> <maml:para>Indicates whether a handover operation is in progress on this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>handover_replication_partner</maml:name> <maml:description> <maml:para>Replication partner to which ownership is being transferred as part of handover operation.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment a volume collection's attributes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>srep_last_sync</maml:name> <maml:description> <maml:para>Time when a synchronously replicated volume collection was last synchronized.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>srep_resync_percent</maml:name> <maml:description> <maml:para>Percentage of the resync progress for a synchronously replicated volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Set-NSVolumeCollection -id 0728eada7f8dd99d3b00000000000000000000009d -description test Name creation_time snapcoll_count app_sync id description ---- ------------- -------------- -------- -- ----------- test4 1533274233 0 none 0728eada7f8dd99d3b00000000000000000000009d test </dev:code> <dev:remarks> <maml:para>This command will change the volume collections description. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSVolumeCollection</command:name> <maml:description> <maml:para>Delete a specified volume collection. A volume collection cannot be deleted if it has associated volumes.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSVolumeCollection</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Delete a specified volume collection. A volume collection cannot be deleted if it has associated volumes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>prottmpl_id</maml:name> <maml:description> <maml:para>Identifier of the protection template whose attributes will be used to create this volume collection. This attribute is only used for input when creating a volume collection and is not outputed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of volume collection used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_priority</maml:name> <maml:description> <maml:para>Replication priority for the volume collection with the following choices: {normal | high}.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pol_owner_name</maml:name> <maml:description> <maml:para>Owner group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replication_type</maml:name> <maml:description> <maml:para>Type of replication configured for the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>synchronous_replication_type</maml:name> <maml:description> <maml:para>Type of synchronous replication configured for the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>synchronous_replication_state</maml:name> <maml:description> <maml:para>State of synchronous replication on the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_sync</maml:name> <maml:description> <maml:para>Application Synchronization.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_server</maml:name> <maml:description> <maml:para>Application server hostname.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_id</maml:name> <maml:description> <maml:para>Application ID running on the server. Application ID can only be specified if application synchronization is \\"vss\\".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_cluster_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment, this is the cluster name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_service_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment then this is the instance name of the service running within the cluster environment.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vcenter_hostname</maml:name> <maml:description> <maml:para>VMware vCenter hostname. Custom port number can be specified with vCenter hostname using \\":\\".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vcenter_username</maml:name> <maml:description> <maml:para>Application VMware vCenter username.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vcenter_password</maml:name> <maml:description> <maml:para>Application VMware vCenter password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_hostname</maml:name> <maml:description> <maml:para>Generic backup agent hostname. Custom port number can be specified with agent hostname using \\":\\".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_username</maml:name> <maml:description> <maml:para>Generic backup agent username.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_password</maml:name> <maml:description> <maml:para>Generic backup agent password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this volume collection was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified_time</maml:name> <maml:description> <maml:para>Time when this volume collection was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>downstream_volume_list</maml:name> <maml:description> <maml:para>List of downstream volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>upstream_volume_list</maml:name> <maml:description> <maml:para>List of upstream volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Count of volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cache_pinned_volume_list</maml:name> <maml:description> <maml:para>List of cache pinned volumes associated with volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_snapcoll</maml:name> <maml:description> <maml:para>Last snapshot collection on this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snapcoll_count</maml:name> <maml:description> <maml:para>Count of snapshot collections associated with volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>schedule_list</maml:name> <maml:description> <maml:para>List of snapshot schedules associated with volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replication_partner</maml:name> <maml:description> <maml:para>Replication partner for this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_replicated_snapcoll</maml:name> <maml:description> <maml:para>Last replicated snapshot collection on this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_replicated_snapcoll_list</maml:name> <maml:description> <maml:para>List of snapshot collection information for the last replicated snapshot collection per schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>protection_type</maml:name> <maml:description> <maml:para>Specifies if volume collection is protected with schedules. If protected, indicated whether replication is setup.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>lag_time</maml:name> <maml:description> <maml:para>Replication lag time for volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_standalone_volcoll</maml:name> <maml:description> <maml:para>Indicates whether this is a standalone volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>total_repl_bytes</maml:name> <maml:description> <maml:para>Total size of volumes to be replicated for this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_bytes_transferred</maml:name> <maml:description> <maml:para>Total size of volumes replicated for this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_handing_over</maml:name> <maml:description> <maml:para>Indicates whether a handover operation is in progress on this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>handover_replication_partner</maml:name> <maml:description> <maml:para>Replication partner to which ownership is being transferred as part of handover operation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment a volume collection's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>srep_last_sync</maml:name> <maml:description> <maml:para>Time when a synchronously replicated volume collection was last synchronized.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSVolumeCollection</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>srep_resync_percent</maml:name> <maml:description> <maml:para>Percentage of the resync progress for a synchronously replicated volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>prottmpl_id</maml:name> <maml:description> <maml:para>Identifier of the protection template whose attributes will be used to create this volume collection. This attribute is only used for input when creating a volume collection and is not outputed.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of volume collection used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>repl_priority</maml:name> <maml:description> <maml:para>Replication priority for the volume collection with the following choices: {normal | high}.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pol_owner_name</maml:name> <maml:description> <maml:para>Owner group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>replication_type</maml:name> <maml:description> <maml:para>Type of replication configured for the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>synchronous_replication_type</maml:name> <maml:description> <maml:para>Type of synchronous replication configured for the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>synchronous_replication_state</maml:name> <maml:description> <maml:para>State of synchronous replication on the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_sync</maml:name> <maml:description> <maml:para>Application Synchronization.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_server</maml:name> <maml:description> <maml:para>Application server hostname.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_id</maml:name> <maml:description> <maml:para>Application ID running on the server. Application ID can only be specified if application synchronization is \\"vss\\".</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_cluster_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment, this is the cluster name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_service_name</maml:name> <maml:description> <maml:para>If the application is running within a Windows cluster environment then this is the instance name of the service running within the cluster environment.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vcenter_hostname</maml:name> <maml:description> <maml:para>VMware vCenter hostname. Custom port number can be specified with vCenter hostname using \\":\\".</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vcenter_username</maml:name> <maml:description> <maml:para>Application VMware vCenter username.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vcenter_password</maml:name> <maml:description> <maml:para>Application VMware vCenter password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_hostname</maml:name> <maml:description> <maml:para>Generic backup agent hostname. Custom port number can be specified with agent hostname using \\":\\".</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_username</maml:name> <maml:description> <maml:para>Generic backup agent username.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>agent_password</maml:name> <maml:description> <maml:para>Generic backup agent password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this volume collection was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified_time</maml:name> <maml:description> <maml:para>Time when this volume collection was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>downstream_volume_list</maml:name> <maml:description> <maml:para>List of downstream volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>upstream_volume_list</maml:name> <maml:description> <maml:para>List of upstream volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Count of volumes associated with the volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>cache_pinned_volume_list</maml:name> <maml:description> <maml:para>List of cache pinned volumes associated with volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_snapcoll</maml:name> <maml:description> <maml:para>Last snapshot collection on this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snapcoll_count</maml:name> <maml:description> <maml:para>Count of snapshot collections associated with volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>schedule_list</maml:name> <maml:description> <maml:para>List of snapshot schedules associated with volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>replication_partner</maml:name> <maml:description> <maml:para>Replication partner for this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>last_replicated_snapcoll</maml:name> <maml:description> <maml:para>Last replicated snapshot collection on this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_replicated_snapcoll_list</maml:name> <maml:description> <maml:para>List of snapshot collection information for the last replicated snapshot collection per schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>protection_type</maml:name> <maml:description> <maml:para>Specifies if volume collection is protected with schedules. If protected, indicated whether replication is setup.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>lag_time</maml:name> <maml:description> <maml:para>Replication lag time for volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_standalone_volcoll</maml:name> <maml:description> <maml:para>Indicates whether this is a standalone volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>total_repl_bytes</maml:name> <maml:description> <maml:para>Total size of volumes to be replicated for this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_bytes_transferred</maml:name> <maml:description> <maml:para>Total size of volumes replicated for this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_handing_over</maml:name> <maml:description> <maml:para>Indicates whether a handover operation is in progress on this volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>handover_replication_partner</maml:name> <maml:description> <maml:para>Replication partner to which ownership is being transferred as part of handover operation.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment a volume collection's attributes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>srep_last_sync</maml:name> <maml:description> <maml:para>Time when a synchronously replicated volume collection was last synchronized.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>srep_resync_percent</maml:name> <maml:description> <maml:para>Percentage of the resync progress for a synchronously replicated volume collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Remove-NSVolumeCollection -id 0728eada7f8dd99d3b00000000000000000000009d </dev:code> <dev:remarks> <maml:para>This command will remove the volume collection specified by id. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-NSVolumeCollectionPromote</command:name> <maml:description> <maml:para>Take ownership of the specified volume collection. The volumes associated with the volume collection will be set to online and be available for reading and writing. Replication will be disabled on the affected schedules and must be re-configured if desired. Snapshot retention for the affected schedules will be set to the greater of the current local or replica retention values. This operation is not supported for synchronous replication volume collections.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invok</command:verb> <command:noun>-NSVolumeCollectionPromote</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Take ownership of the specified volume collection. The volumes associated with the volume collection will be set to online and be available for reading and writing. Replication will be disabled on the affected schedules and must be re-configured if desired. Snapshot retention for the affected schedules will be set to the greater of the current local or replica retention values. This operation is not supported for synchronous replication volume collections.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-NSVolumeCollectionPromote</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the promoted volume collection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the promoted volume collection.</maml:para> </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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-NSVolumeCollectionDemote</command:name> <maml:description> <maml:para>Release ownership of the specified volume collection. The volumes associated with the volume collection will set to offline and a snapshot will be created, then full control over the volume collection will be transferred to the new owner. This option can be used following a promote to revert the volume collection back to its prior configured state. This operation does not alter the configuration on the new owner itself, but does require the new owner to be running in order to obtain its identity information. This operation is not supported for synchronous replication volume collections.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invok</command:verb> <command:noun>-NSVolumeCollectionDemote</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Release ownership of the specified volume collection. The volumes associated with the volume collection will set to offline and a snapshot will be created, then full control over the volume collection will be transferred to the new owner. This option can be used following a promote to revert the volume collection back to its prior configured state. This operation does not alter the configuration on the new owner itself, but does require the new owner to be running in order to obtain its identity information. This operation is not supported for synchronous replication volume collections.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-NSVolumeCollectionDemote</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the demoted volume collection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-NSVolumeCollectionDemote</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replication_partner_id</maml:name> <maml:description> <maml:para>ID of the new owner. If invoke_on_upstream_partner is provided, utilize the ID of the current owner i.e. upstream replication partner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-NSVolumeCollectionDemote</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>invoke_on_upstream_partner</maml:name> <maml:description> <maml:para>Invoke demote request on upstream partner. Default: 'false'. This operation is not supported for synchronous replication volume vollections.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the demoted volume collection.</maml:para> </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="true (ByValue)" position="named"> <maml:name>replication_partner_id</maml:name> <maml:description> <maml:para>ID of the new owner. If invoke_on_upstream_partner is provided, utilize the ID of the current owner i.e. upstream replication partner.</maml:para> </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="true (ByValue)" position="named"> <maml:name>invoke_on_upstream_partner</maml:name> <maml:description> <maml:para>Invoke demote request on upstream partner. Default: 'false'. This operation is not supported for synchronous replication volume vollections.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-NSVolumeCollectionHandover</command:name> <maml:description> <maml:para>Gracefully transfer ownership of the specified volume collection. This action can be used to pass control of the volume collection to the downstream replication partner. Ownership and full control over the volume collection will be given to the downstream replication partner. The volumes associated with the volume collection will be set to offline prior to the final snapshot being taken and replicated, thus ensuring full data synchronization as part of the transfer. By default, the new owner will automatically begin replicating the volume collection back to this node when the handover completes.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Start</command:verb> <command:noun>-NSVolumeCollectionHandover</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gracefully transfer ownership of the specified volume collection. This action can be used to pass control of the volume collection to the downstream replication partner. Ownership and full control over the volume collection will be given to the downstream replication partner. The volumes associated with the volume collection will be set to offline prior to the final snapshot being taken and replicated, thus ensuring full data synchronization as part of the transfer. By default, the new owner will automatically begin replicating the volume collection back to this node when the handover completes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-NSVolumeCollectionHandover</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the volume collection be handed over to the downstream replication partner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-NSVolumeCollectionHandover</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replication_partner_id</maml:name> <maml:description> <maml:para>ID of the new owner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-NSVolumeCollectionHandover</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>no_reverse</maml:name> <maml:description> <maml:para>Do not automatically reverse direction of replication. Using this argument will prevent the new owner from automatically replicating the volume collection to this node when the handover completes. The default behavior is to enable replication back to this node. Default: 'false'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-NSVolumeCollectionHandover</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>invoke_on_upstream_partner</maml:name> <maml:description> <maml:para>Invoke handover request on upstream partner. Default: 'false'. This operation is not supported for synchronous replication volume vollections.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Start-NSVolumeCollectionHandover</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>override_upstream_down</maml:name> <maml:description> <maml:para>Allow the handover request to proceed even if upstream array is down. The default behavior is to return an error when upstream is down. This option is applicable for synchronous replication only. Default: 'false'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the volume collection be handed over to the downstream replication partner.</maml:para> </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="true (ByValue)" position="named"> <maml:name>replication_partner_id</maml:name> <maml:description> <maml:para>ID of the new owner.</maml:para> </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="true (ByValue)" position="named"> <maml:name>no_reverse</maml:name> <maml:description> <maml:para>Do not automatically reverse direction of replication. Using this argument will prevent the new owner from automatically replicating the volume collection to this node when the handover completes. The default behavior is to enable replication back to this node. Default: 'false'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>invoke_on_upstream_partner</maml:name> <maml:description> <maml:para>Invoke handover request on upstream partner. Default: 'false'. This operation is not supported for synchronous replication volume vollections.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>override_upstream_down</maml:name> <maml:description> <maml:para>Allow the handover request to proceed even if upstream array is down. The default behavior is to return an error when upstream is down. This option is applicable for synchronous replication only. Default: 'false'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Stop-NSVolumeCollectionHandover</command:name> <maml:description> <maml:para>Abort in-progress handover. If for some reason a previously invoked handover request is unable to complete, this action can be used to cancel it. This operation is not supported for synchronous replication volume collections.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Stop-</command:verb> <command:noun>-NSVolumeCollectionHandover</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Abort in-progress handover. If for some reason a previously invoked handover request is unable to complete, this action can be used to cancel it. This operation is not supported for synchronous replication volume collections.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-NSVolumeCollectionHandover</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the volume collection on which to abort handover.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the volume collection on which to abort handover.</maml:para> </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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-NSVolumeCollection</command:name> <maml:description> <maml:para>Validate a volume collection with either Microsoft VSS or VMware application synchronization.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test-</command:verb> <command:noun>-NSVolumeCollection</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Validate a volume collection with either Microsoft VSS or VMware application synchronization.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-NSVolumeCollection</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the volume collection that is to be validated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the volume collection that is to be validated.</maml:para> </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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSToken</command:name> <maml:description> <maml:para>Create a user session token.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSToken</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Create a user session token.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Object identifier for the session token.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>session_token</maml:name> <maml:description> <maml:para>Token used for authentication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>User name for the session.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Password for the user. A password is required for creating a token.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_name</maml:name> <maml:description> <maml:para>Application name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sdk_name</maml:name> <maml:description> <maml:para>SDK name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>source_ip</maml:name> <maml:description> <maml:para>IP address from which the session originates.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this token was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this token was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>expiry_time</maml:name> <maml:description> <maml:para>Time when this token will expire.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>server_uuid</maml:name> <maml:description> <maml:para>Non mandatory 36 character uuid returned by the server. Currently only the witness REST server returns one.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>grant_type</maml:name> <maml:description> <maml:para>OAuth grant type, currently only support 'urn:ietf:params:oauth:grant-type:jwt-bearer'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>assertion</maml:name> <maml:description> <maml:para>OAuth assertion, currently expecting a JWT token.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Object identifier for the session token.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>session_token</maml:name> <maml:description> <maml:para>Token used for authentication.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>User name for the session.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Password for the user. A password is required for creating a token.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_name</maml:name> <maml:description> <maml:para>Application name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>sdk_name</maml:name> <maml:description> <maml:para>SDK name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>source_ip</maml:name> <maml:description> <maml:para>IP address from which the session originates.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this token was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this token was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>expiry_time</maml:name> <maml:description> <maml:para>Time when this token will expire.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>server_uuid</maml:name> <maml:description> <maml:para>Non mandatory 36 character uuid returned by the server. Currently only the witness REST server returns one.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>grant_type</maml:name> <maml:description> <maml:para>OAuth grant type, currently only support 'urn:ietf:params:oauth:grant-type:jwt-bearer'.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>assertion</maml:name> <maml:description> <maml:para>OAuth assertion, currently expecting a JWT token.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSToken</command:name> <maml:description> <maml:para>List user session tokens.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSToken</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List user session tokens.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Object identifier for the session token.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>session_token</maml:name> <maml:description> <maml:para>Token used for authentication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>User name for the session.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Password for the user. A password is required for creating a token.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_name</maml:name> <maml:description> <maml:para>Application name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sdk_name</maml:name> <maml:description> <maml:para>SDK name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>source_ip</maml:name> <maml:description> <maml:para>IP address from which the session originates.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this token was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this token was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>expiry_time</maml:name> <maml:description> <maml:para>Time when this token will expire.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>server_uuid</maml:name> <maml:description> <maml:para>Non mandatory 36 character uuid returned by the server. Currently only the witness REST server returns one.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>grant_type</maml:name> <maml:description> <maml:para>OAuth grant type, currently only support 'urn:ietf:params:oauth:grant-type:jwt-bearer'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>assertion</maml:name> <maml:description> <maml:para>OAuth assertion, currently expecting a JWT token.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Object identifier for the session token.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>session_token</maml:name> <maml:description> <maml:para>Token used for authentication.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>User name for the session.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Password for the user. A password is required for creating a token.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_name</maml:name> <maml:description> <maml:para>Application name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>sdk_name</maml:name> <maml:description> <maml:para>SDK name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>source_ip</maml:name> <maml:description> <maml:para>IP address from which the session originates.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this token was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this token was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>expiry_time</maml:name> <maml:description> <maml:para>Time when this token will expire.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>server_uuid</maml:name> <maml:description> <maml:para>Non mandatory 36 character uuid returned by the server. Currently only the witness REST server returns one.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>grant_type</maml:name> <maml:description> <maml:para>OAuth grant type, currently only support 'urn:ietf:params:oauth:grant-type:jwt-bearer'.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>assertion</maml:name> <maml:description> <maml:para>OAuth assertion, currently expecting a JWT token.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSToken</command:name> <maml:description> <maml:para>Delete a user session token.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSToken</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Delete a user session token.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Object identifier for the session token.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>session_token</maml:name> <maml:description> <maml:para>Token used for authentication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>User name for the session.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Password for the user. A password is required for creating a token.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_name</maml:name> <maml:description> <maml:para>Application name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sdk_name</maml:name> <maml:description> <maml:para>SDK name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>source_ip</maml:name> <maml:description> <maml:para>IP address from which the session originates.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this token was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this token was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>expiry_time</maml:name> <maml:description> <maml:para>Time when this token will expire.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>server_uuid</maml:name> <maml:description> <maml:para>Non mandatory 36 character uuid returned by the server. Currently only the witness REST server returns one.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>grant_type</maml:name> <maml:description> <maml:para>OAuth grant type, currently only support 'urn:ietf:params:oauth:grant-type:jwt-bearer'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSToken</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>assertion</maml:name> <maml:description> <maml:para>OAuth assertion, currently expecting a JWT token.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Object identifier for the session token.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>session_token</maml:name> <maml:description> <maml:para>Token used for authentication.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>User name for the session.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Password for the user. A password is required for creating a token.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_name</maml:name> <maml:description> <maml:para>Application name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>sdk_name</maml:name> <maml:description> <maml:para>SDK name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>source_ip</maml:name> <maml:description> <maml:para>IP address from which the session originates.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this token was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this token was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>expiry_time</maml:name> <maml:description> <maml:para>Time when this token will expire.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>server_uuid</maml:name> <maml:description> <maml:para>Non mandatory 36 character uuid returned by the server. Currently only the witness REST server returns one.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>grant_type</maml:name> <maml:description> <maml:para>OAuth grant type, currently only support 'urn:ietf:params:oauth:grant-type:jwt-bearer'.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>assertion</maml:name> <maml:description> <maml:para>OAuth assertion, currently expecting a JWT token.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSTokenUserDetails</command:name> <maml:description> <maml:para>Reports the user details for this token.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get-N</command:verb> <command:noun>-NSTokenUserDetails</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Reports the user details for this token.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSTokenUserDetails</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID for the session token.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID for the session token.</maml:para> </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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSUserGroup</command:name> <maml:description> <maml:para>Associate the ActiveDirectory group to a role on the storage array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSUserGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Associate the ActiveDirectory group to a role on the storage array.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the user group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUserGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the user group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the user group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>role_id</maml:name> <maml:description> <maml:para>Identifier for the user group's role.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>inactivity_timeout</maml:name> <maml:description> <maml:para>The amount of time that the user session is inactive before timing out. A value of 0 indicates that the timeout is taken from the group setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this user was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this user was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>disabled</maml:name> <maml:description> <maml:para>User is currently disabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>external_id</maml:name> <maml:description> <maml:para>External ID of the user group. In Active Directory, it is the group's SID (Security Identifier).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUserGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>domain_id</maml:name> <maml:description> <maml:para>Identifier of the domain this user group belongs to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>domain_name</maml:name> <maml:description> <maml:para>Role of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the user group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the user 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the user group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>role_id</maml:name> <maml:description> <maml:para>Identifier for the user group's role.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>inactivity_timeout</maml:name> <maml:description> <maml:para>The amount of time that the user session is inactive before timing out. A value of 0 indicates that the timeout is taken from the group setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this user was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this user was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>disabled</maml:name> <maml:description> <maml:para>User is currently disabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>external_id</maml:name> <maml:description> <maml:para>External ID of the user group. In Active Directory, it is the group's SID (Security Identifier).</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>domain_id</maml:name> <maml:description> <maml:para>Identifier of the domain this user group belongs to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>domain_name</maml:name> <maml:description> <maml:para>Role of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSUserGroup</command:name> <maml:description> <maml:para>List one or more user groups.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSUserGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List one or more user groups.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the user group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the user group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the user group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>role_id</maml:name> <maml:description> <maml:para>Identifier for the user group's role.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>inactivity_timeout</maml:name> <maml:description> <maml:para>The amount of time that the user session is inactive before timing out. A value of 0 indicates that the timeout is taken from the group setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this user was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this user was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>disabled</maml:name> <maml:description> <maml:para>User is currently disabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>external_id</maml:name> <maml:description> <maml:para>External ID of the user group. In Active Directory, it is the group's SID (Security Identifier).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>domain_id</maml:name> <maml:description> <maml:para>Identifier of the domain this user group belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>domain_name</maml:name> <maml:description> <maml:para>Role of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the user group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the user group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the user group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>role_id</maml:name> <maml:description> <maml:para>Identifier for the user group's role.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>inactivity_timeout</maml:name> <maml:description> <maml:para>The amount of time that the user session is inactive before timing out. A value of 0 indicates that the timeout is taken from the group setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this user was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this user was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>disabled</maml:name> <maml:description> <maml:para>User is currently disabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>external_id</maml:name> <maml:description> <maml:para>External ID of the user group. In Active Directory, it is the group's SID (Security Identifier).</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>domain_id</maml:name> <maml:description> <maml:para>Identifier of the domain this user group belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>domain_name</maml:name> <maml:description> <maml:para>Role of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSUserGroup</command:name> <maml:description> <maml:para>Modify information about a user group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSUserGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Modify information about a user group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSUserGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the user group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the user group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the user group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>role_id</maml:name> <maml:description> <maml:para>Identifier for the user group's role.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>inactivity_timeout</maml:name> <maml:description> <maml:para>The amount of time that the user session is inactive before timing out. A value of 0 indicates that the timeout is taken from the group setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this user was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this user was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>disabled</maml:name> <maml:description> <maml:para>User is currently disabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>external_id</maml:name> <maml:description> <maml:para>External ID of the user group. In Active Directory, it is the group's SID (Security Identifier).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>domain_id</maml:name> <maml:description> <maml:para>Identifier of the domain this user group belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>domain_name</maml:name> <maml:description> <maml:para>Role of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the user 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the user group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the user group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>role_id</maml:name> <maml:description> <maml:para>Identifier for the user group's role.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>inactivity_timeout</maml:name> <maml:description> <maml:para>The amount of time that the user session is inactive before timing out. A value of 0 indicates that the timeout is taken from the group setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this user was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this user was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>disabled</maml:name> <maml:description> <maml:para>User is currently disabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>external_id</maml:name> <maml:description> <maml:para>External ID of the user group. In Active Directory, it is the group's SID (Security Identifier).</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>domain_id</maml:name> <maml:description> <maml:para>Identifier of the domain this user group belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>domain_name</maml:name> <maml:description> <maml:para>Role of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSUserGroup</command:name> <maml:description> <maml:para>Delete a user group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSUserGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Delete a user group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the user group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the user group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the user group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>role_id</maml:name> <maml:description> <maml:para>Identifier for the user group's role.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>inactivity_timeout</maml:name> <maml:description> <maml:para>The amount of time that the user session is inactive before timing out. A value of 0 indicates that the timeout is taken from the group setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this user was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this user was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>disabled</maml:name> <maml:description> <maml:para>User is currently disabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>external_id</maml:name> <maml:description> <maml:para>External ID of the user group. In Active Directory, it is the group's SID (Security Identifier).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>domain_id</maml:name> <maml:description> <maml:para>Identifier of the domain this user group belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUserGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>domain_name</maml:name> <maml:description> <maml:para>Role of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the user group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the user group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the user group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>role_id</maml:name> <maml:description> <maml:para>Identifier for the user group's role.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>inactivity_timeout</maml:name> <maml:description> <maml:para>The amount of time that the user session is inactive before timing out. A value of 0 indicates that the timeout is taken from the group setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this user was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this user was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>disabled</maml:name> <maml:description> <maml:para>User is currently disabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>external_id</maml:name> <maml:description> <maml:para>External ID of the user group. In Active Directory, it is the group's SID (Security Identifier).</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>domain_id</maml:name> <maml:description> <maml:para>Identifier of the domain this user group belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>domain_name</maml:name> <maml:description> <maml:para>Role of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSWitness</command:name> <maml:description> <maml:para>Create a new witness configuration.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSWitness</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Create a new witness configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSWitness</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier of the witness configuration.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSWitness</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>Username of witness. This has to be a non-root that can login to the witness host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSWitness</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Password of witness.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSWitness</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>host</maml:name> <maml:description> <maml:para>Hostname or ip addresses of witness.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSWitness</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>Port of witness.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSWitness</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>secure_mode</maml:name> <maml:description> <maml:para>To verify the witness host against CA cert and to apply possible security modes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSWitness</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>auto_switchover_messages</maml:name> <maml:description> <maml:para>List of validation messages for automatic switchover of Group Management. This will be empty when there are no conflicts found.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier of the witness configuration.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>Username of witness. This has to be a non-root that can login to the witness host.</maml:para> </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="true (ByValue)" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Password of witness.</maml:para> </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="true (ByValue)" position="named"> <maml:name>host</maml:name> <maml:description> <maml:para>Hostname or ip addresses of witness.</maml:para> </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="true (ByValue)" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>Port of witness.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>secure_mode</maml:name> <maml:description> <maml:para>To verify the witness host against CA cert and to apply possible security modes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>auto_switchover_messages</maml:name> <maml:description> <maml:para>List of validation messages for automatic switchover of Group Management. This will be empty when there are no conflicts found.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSWitness</command:name> <maml:description> <maml:para>List all witness configuration.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSWitness</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List all witness configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSWitness</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier of the witness configuration.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSWitness</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>Username of witness. This has to be a non-root that can login to the witness host.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSWitness</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Password of witness.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSWitness</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>host</maml:name> <maml:description> <maml:para>Hostname or ip addresses of witness.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSWitness</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>Port of witness.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSWitness</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>secure_mode</maml:name> <maml:description> <maml:para>To verify the witness host against CA cert and to apply possible security modes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSWitness</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>auto_switchover_messages</maml:name> <maml:description> <maml:para>List of validation messages for automatic switchover of Group Management. This will be empty when there are no conflicts found.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier of the witness configuration.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>Username of witness. This has to be a non-root that can login to the witness host.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Password of witness.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>host</maml:name> <maml:description> <maml:para>Hostname or ip addresses of witness.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>Port of witness.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>secure_mode</maml:name> <maml:description> <maml:para>To verify the witness host against CA cert and to apply possible security modes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>auto_switchover_messages</maml:name> <maml:description> <maml:para>List of validation messages for automatic switchover of Group Management. This will be empty when there are no conflicts found.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSWitness</command:name> <maml:description> <maml:para>Delete the specified witness configuration.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSWitness</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Delete the specified witness configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSWitness</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier of the witness configuration.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSWitness</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>Username of witness. This has to be a non-root that can login to the witness host.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSWitness</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Password of witness.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSWitness</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>host</maml:name> <maml:description> <maml:para>Hostname or ip addresses of witness.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSWitness</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>Port of witness.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSWitness</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>secure_mode</maml:name> <maml:description> <maml:para>To verify the witness host against CA cert and to apply possible security modes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSWitness</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>auto_switchover_messages</maml:name> <maml:description> <maml:para>List of validation messages for automatic switchover of Group Management. This will be empty when there are no conflicts found.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier of the witness configuration.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>username</maml:name> <maml:description> <maml:para>Username of witness. This has to be a non-root that can login to the witness host.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Password of witness.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>host</maml:name> <maml:description> <maml:para>Hostname or ip addresses of witness.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>Port of witness.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>secure_mode</maml:name> <maml:description> <maml:para>To verify the witness host against CA cert and to apply possible security modes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>auto_switchover_messages</maml:name> <maml:description> <maml:para>List of validation messages for automatic switchover of Group Management. This will be empty when there are no conflicts found.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-NSWitness</command:name> <maml:description> <maml:para>Tests and validates witness configuration between the array and the witness.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test-</command:verb> <command:noun>-NSWitness</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Tests and validates witness configuration between the array and the witness.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-NSWitness</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the witness.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the witness.</maml:para> </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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSSubscription</command:name> <maml:description> <maml:para>Create a subscription.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSSubscription</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Create a subscription.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for subscription.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSubscription</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>subscriber_id</maml:name> <maml:description> <maml:para>Identifier for subscriber (notification client) that this subscription belongs to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSubscription</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>notification_type</maml:name> <maml:description> <maml:para>This indicates the type of notification being subscribed for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>object_type</maml:name> <maml:description> <maml:para>The object type that the notification subscriber is interested in. This is relevant for and required only for audit log based notifications.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>object_id</maml:name> <maml:description> <maml:para>The object that the notification subscriber is interested in. Applies only to audit log based notifications.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>operation</maml:name> <maml:description> <maml:para>The operation that the notification subscriber is interested in. Applies only to audit log based notifications.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>event_target_type</maml:name> <maml:description> <maml:para>The kind of events or alerts that the notification subscriber is interested in. Applies only to events based notifications.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>event_severity</maml:name> <maml:description> <maml:para>The severity of events that the notification subscriber is interested in. Applies only to events based notifications.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for subscription.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>subscriber_id</maml:name> <maml:description> <maml:para>Identifier for subscriber (notification client) that this subscription belongs to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>notification_type</maml:name> <maml:description> <maml:para>This indicates the type of notification being subscribed for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>object_type</maml:name> <maml:description> <maml:para>The object type that the notification subscriber is interested in. This is relevant for and required only for audit log based notifications.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>object_id</maml:name> <maml:description> <maml:para>The object that the notification subscriber is interested in. Applies only to audit log based notifications.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>operation</maml:name> <maml:description> <maml:para>The operation that the notification subscriber is interested in. Applies only to audit log based notifications.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>event_target_type</maml:name> <maml:description> <maml:para>The kind of events or alerts that the notification subscriber is interested in. Applies only to events based notifications.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>event_severity</maml:name> <maml:description> <maml:para>The severity of events that the notification subscriber is interested in. Applies only to events based notifications.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSSubscription</command:name> <maml:description> <maml:para>Retrieve information about a single subscription or all subscriptions.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSSubscription</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Retrieve information about a single subscription or all subscriptions.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for subscription.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>subscriber_id</maml:name> <maml:description> <maml:para>Identifier for subscriber (notification client) that this subscription belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>notification_type</maml:name> <maml:description> <maml:para>This indicates the type of notification being subscribed for.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>object_type</maml:name> <maml:description> <maml:para>The object type that the notification subscriber is interested in. This is relevant for and required only for audit log based notifications.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>object_id</maml:name> <maml:description> <maml:para>The object that the notification subscriber is interested in. Applies only to audit log based notifications.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>operation</maml:name> <maml:description> <maml:para>The operation that the notification subscriber is interested in. Applies only to audit log based notifications.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>event_target_type</maml:name> <maml:description> <maml:para>The kind of events or alerts that the notification subscriber is interested in. Applies only to events based notifications.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>event_severity</maml:name> <maml:description> <maml:para>The severity of events that the notification subscriber is interested in. Applies only to events based notifications.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for subscription.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>subscriber_id</maml:name> <maml:description> <maml:para>Identifier for subscriber (notification client) that this subscription belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>notification_type</maml:name> <maml:description> <maml:para>This indicates the type of notification being subscribed for.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>object_type</maml:name> <maml:description> <maml:para>The object type that the notification subscriber is interested in. This is relevant for and required only for audit log based notifications.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>object_id</maml:name> <maml:description> <maml:para>The object that the notification subscriber is interested in. Applies only to audit log based notifications.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>operation</maml:name> <maml:description> <maml:para>The operation that the notification subscriber is interested in. Applies only to audit log based notifications.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>event_target_type</maml:name> <maml:description> <maml:para>The kind of events or alerts that the notification subscriber is interested in. Applies only to events based notifications.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>event_severity</maml:name> <maml:description> <maml:para>The severity of events that the notification subscriber is interested in. Applies only to events based notifications.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSSubscription</command:name> <maml:description> <maml:para>Modify subscription attributes.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSSubscription</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Modify subscription attributes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for subscription.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>subscriber_id</maml:name> <maml:description> <maml:para>Identifier for subscriber (notification client) that this subscription belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>notification_type</maml:name> <maml:description> <maml:para>This indicates the type of notification being subscribed for.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>object_type</maml:name> <maml:description> <maml:para>The object type that the notification subscriber is interested in. This is relevant for and required only for audit log based notifications.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>object_id</maml:name> <maml:description> <maml:para>The object that the notification subscriber is interested in. Applies only to audit log based notifications.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>operation</maml:name> <maml:description> <maml:para>The operation that the notification subscriber is interested in. Applies only to audit log based notifications.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>event_target_type</maml:name> <maml:description> <maml:para>The kind of events or alerts that the notification subscriber is interested in. Applies only to events based notifications.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>event_severity</maml:name> <maml:description> <maml:para>The severity of events that the notification subscriber is interested in. Applies only to events based notifications.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for subscription.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>subscriber_id</maml:name> <maml:description> <maml:para>Identifier for subscriber (notification client) that this subscription belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>notification_type</maml:name> <maml:description> <maml:para>This indicates the type of notification being subscribed for.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>object_type</maml:name> <maml:description> <maml:para>The object type that the notification subscriber is interested in. This is relevant for and required only for audit log based notifications.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>object_id</maml:name> <maml:description> <maml:para>The object that the notification subscriber is interested in. Applies only to audit log based notifications.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>operation</maml:name> <maml:description> <maml:para>The operation that the notification subscriber is interested in. Applies only to audit log based notifications.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>event_target_type</maml:name> <maml:description> <maml:para>The kind of events or alerts that the notification subscriber is interested in. Applies only to events based notifications.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>event_severity</maml:name> <maml:description> <maml:para>The severity of events that the notification subscriber is interested in. Applies only to events based notifications.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSSubscription</command:name> <maml:description> <maml:para>Delete a subscription. Deleting a subscription will cause notifications for this object type to stop for the client that owns this subscription.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSSubscription</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Delete a subscription. Deleting a subscription will cause notifications for this object type to stop for the client that owns this subscription.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for subscription.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>subscriber_id</maml:name> <maml:description> <maml:para>Identifier for subscriber (notification client) that this subscription belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>notification_type</maml:name> <maml:description> <maml:para>This indicates the type of notification being subscribed for.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>object_type</maml:name> <maml:description> <maml:para>The object type that the notification subscriber is interested in. This is relevant for and required only for audit log based notifications.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>object_id</maml:name> <maml:description> <maml:para>The object that the notification subscriber is interested in. Applies only to audit log based notifications.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>operation</maml:name> <maml:description> <maml:para>The operation that the notification subscriber is interested in. Applies only to audit log based notifications.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>event_target_type</maml:name> <maml:description> <maml:para>The kind of events or alerts that the notification subscriber is interested in. Applies only to events based notifications.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSubscription</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>event_severity</maml:name> <maml:description> <maml:para>The severity of events that the notification subscriber is interested in. Applies only to events based notifications.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for subscription.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>subscriber_id</maml:name> <maml:description> <maml:para>Identifier for subscriber (notification client) that this subscription belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>notification_type</maml:name> <maml:description> <maml:para>This indicates the type of notification being subscribed for.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>object_type</maml:name> <maml:description> <maml:para>The object type that the notification subscriber is interested in. This is relevant for and required only for audit log based notifications.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>object_id</maml:name> <maml:description> <maml:para>The object that the notification subscriber is interested in. Applies only to audit log based notifications.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>operation</maml:name> <maml:description> <maml:para>The operation that the notification subscriber is interested in. Applies only to audit log based notifications.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>event_target_type</maml:name> <maml:description> <maml:para>The kind of events or alerts that the notification subscriber is interested in. Applies only to events based notifications.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>event_severity</maml:name> <maml:description> <maml:para>The severity of events that the notification subscriber is interested in. Applies only to events based notifications.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSFibreChannelInitiatorAlias</command:name> <maml:description> <maml:para>Retrieve information on a set of Fibre Channel initiator aliases or a single Fibre Channel initiator alias.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSFibreChannelInitiatorAlias</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Retrieve information on a set of Fibre Channel initiator aliases or a single Fibre Channel initiator alias.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSFibreChannelInitiatorAlias</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Unique identifier for the Fibre Channel initiator alias.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelInitiatorAlias</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>alias</maml:name> <maml:description> <maml:para>Alias of the Fibre Channel initiator.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelInitiatorAlias</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>wwpn</maml:name> <maml:description> <maml:para>WWPN (World Wide Port Name) of the Fibre Channel initiator.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelInitiatorAlias</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>source</maml:name> <maml:description> <maml:para>Source of the Fibre Channel initiator alias.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Unique identifier for the Fibre Channel initiator alias.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>alias</maml:name> <maml:description> <maml:para>Alias of the Fibre Channel initiator.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>wwpn</maml:name> <maml:description> <maml:para>WWPN (World Wide Port Name) of the Fibre Channel initiator.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>source</maml:name> <maml:description> <maml:para>Source of the Fibre Channel initiator alias.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSInitiatorGroup</command:name> <maml:description> <maml:para>Create an initiator group used for authentication.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSInitiatorGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Create an initiator group used for authentication.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiatorGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of initiator group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Initiator group's full name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Initiator group name used for search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiatorGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Initiator group access protocol.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>host_type</maml:name> <maml:description> <maml:para>Initiator group host type. Available options are auto and hpux. The default option is auto. This attribute will be applied to all the initiators in the initiator group. Initiators with different host OSes should not be kept in the same initiator group having a non-default host type attribute.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fc_tdz_ports</maml:name> <maml:description> <maml:para>List of target Fibre Channel ports with Target Driven Zoning configured on this initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>target_subnets</maml:name> <maml:description> <maml:para>List of target subnet labels. If specified, discovery and access to volumes will be restricted to the specified subnets.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_initiators</maml:name> <maml:description> <maml:para>List of iSCSI initiators. When create/update iscsi_initiators, either iqn or ip_address is always required with label.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fc_initiators</maml:name> <maml:description> <maml:para>List of FC initiators. When create/update fc_initiators, wwpn is required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this initiator group was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this initiator group was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vp_override</maml:name> <maml:description> <maml:para>Flag to allow modifying VP created initiator groups. When set to true, user can add this initiator to a VP created initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Number of volumes that are accessible by the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes that are accessible by the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_connections</maml:name> <maml:description> <maml:para>Total number of connections from initiators in the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment an initiator group's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of initiator 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Initiator group's full name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Initiator group name used for search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Initiator group access protocol.</maml:para> </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="true (ByValue)" position="named"> <maml:name>host_type</maml:name> <maml:description> <maml:para>Initiator group host type. Available options are auto and hpux. The default option is auto. This attribute will be applied to all the initiators in the initiator group. Initiators with different host OSes should not be kept in the same initiator group having a non-default host type attribute.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>fc_tdz_ports</maml:name> <maml:description> <maml:para>List of target Fibre Channel ports with Target Driven Zoning configured on this initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>target_subnets</maml:name> <maml:description> <maml:para>List of target subnet labels. If specified, discovery and access to volumes will be restricted to the specified subnets.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>iscsi_initiators</maml:name> <maml:description> <maml:para>List of iSCSI initiators. When create/update iscsi_initiators, either iqn or ip_address is always required with label.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>fc_initiators</maml:name> <maml:description> <maml:para>List of FC initiators. When create/update fc_initiators, wwpn is required.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this initiator group was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this initiator group was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vp_override</maml:name> <maml:description> <maml:para>Flag to allow modifying VP created initiator groups. When set to true, user can add this initiator to a VP created initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Number of volumes that are accessible by the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes that are accessible by the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_connections</maml:name> <maml:description> <maml:para>Total number of connections from initiators in the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment an initiator group's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> New-NSInitiatorGroup -name Testfolder-503 -access_protocol iscsi Name Access_Protocol Description id ---- --------------- ----------- -- Testfolder-503 iscsi 0228eada7f8dd99d3b000000000000000000000059 </dev:code> <dev:remarks> <maml:para>This command create a new initiator group. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSInitiatorGroup</command:name> <maml:description> <maml:para>List a set of initiator groups used for authentication.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSInitiatorGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List a set of initiator groups used for authentication.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Initiator group's full name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Initiator group name used for search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Initiator group access protocol.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>host_type</maml:name> <maml:description> <maml:para>Initiator group host type. Available options are auto and hpux. The default option is auto. This attribute will be applied to all the initiators in the initiator group. Initiators with different host OSes should not be kept in the same initiator group having a non-default host type attribute.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fc_tdz_ports</maml:name> <maml:description> <maml:para>List of target Fibre Channel ports with Target Driven Zoning configured on this initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>target_subnets</maml:name> <maml:description> <maml:para>List of target subnet labels. If specified, discovery and access to volumes will be restricted to the specified subnets.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_initiators</maml:name> <maml:description> <maml:para>List of iSCSI initiators. When create/update iscsi_initiators, either iqn or ip_address is always required with label.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fc_initiators</maml:name> <maml:description> <maml:para>List of FC initiators. When create/update fc_initiators, wwpn is required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this initiator group was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this initiator group was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vp_override</maml:name> <maml:description> <maml:para>Flag to allow modifying VP created initiator groups. When set to true, user can add this initiator to a VP created initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Number of volumes that are accessible by the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes that are accessible by the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_connections</maml:name> <maml:description> <maml:para>Total number of connections from initiators in the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment an initiator group's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Initiator group's full name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Initiator group name used for search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Initiator group access protocol.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>host_type</maml:name> <maml:description> <maml:para>Initiator group host type. Available options are auto and hpux. The default option is auto. This attribute will be applied to all the initiators in the initiator group. Initiators with different host OSes should not be kept in the same initiator group having a non-default host type attribute.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>fc_tdz_ports</maml:name> <maml:description> <maml:para>List of target Fibre Channel ports with Target Driven Zoning configured on this initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>target_subnets</maml:name> <maml:description> <maml:para>List of target subnet labels. If specified, discovery and access to volumes will be restricted to the specified subnets.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>iscsi_initiators</maml:name> <maml:description> <maml:para>List of iSCSI initiators. When create/update iscsi_initiators, either iqn or ip_address is always required with label.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>fc_initiators</maml:name> <maml:description> <maml:para>List of FC initiators. When create/update fc_initiators, wwpn is required.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this initiator group was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this initiator group was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vp_override</maml:name> <maml:description> <maml:para>Flag to allow modifying VP created initiator groups. When set to true, user can add this initiator to a VP created initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Number of volumes that are accessible by the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes that are accessible by the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_connections</maml:name> <maml:description> <maml:para>Total number of connections from initiators in the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment an initiator group's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSInitiatorGroup Name Access_Protocol Description id ---- --------------- ----------- -- test2 iscsi 0228eada7f8dd99d3b000000000000000000000001 test1 iscsi 0228eada7f8dd99d3b000000000000000000000002 test iscsi 0228eada7f8dd99d3b000000000000000000000003 TestInit-981 iscsi Test 0228eada7f8dd99d3b000000000000000000000019 </dev:code> <dev:remarks> <maml:para>This command will retrieve the initiator groups from the array. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 2 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSInitiatorGroup -name test2 Name Access_Protocol Description id ---- --------------- ----------- -- test2 iscsi 0228eada7f8dd99d3b000000000000000000000001 </dev:code> <dev:remarks> <maml:para>This command will retrieve a specific initiator group from the array by name. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSInitiatorGroup</command:name> <maml:description> <maml:para>Modify the specified initiator group attributes.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSInitiatorGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Modify the specified initiator group attributes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSInitiatorGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for initiator group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Initiator group's full name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Initiator group name used for search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Initiator group access protocol.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>host_type</maml:name> <maml:description> <maml:para>Initiator group host type. Available options are auto and hpux. The default option is auto. This attribute will be applied to all the initiators in the initiator group. Initiators with different host OSes should not be kept in the same initiator group having a non-default host type attribute.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fc_tdz_ports</maml:name> <maml:description> <maml:para>List of target Fibre Channel ports with Target Driven Zoning configured on this initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>target_subnets</maml:name> <maml:description> <maml:para>List of target subnet labels. If specified, discovery and access to volumes will be restricted to the specified subnets.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_initiators</maml:name> <maml:description> <maml:para>List of iSCSI initiators. When create/update iscsi_initiators, either iqn or ip_address is always required with label.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fc_initiators</maml:name> <maml:description> <maml:para>List of FC initiators. When create/update fc_initiators, wwpn is required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this initiator group was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this initiator group was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vp_override</maml:name> <maml:description> <maml:para>Flag to allow modifying VP created initiator groups. When set to true, user can add this initiator to a VP created initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Number of volumes that are accessible by the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes that are accessible by the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_connections</maml:name> <maml:description> <maml:para>Total number of connections from initiators in the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment an initiator group's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for initiator 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Initiator group's full name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Initiator group name used for search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Initiator group access protocol.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>host_type</maml:name> <maml:description> <maml:para>Initiator group host type. Available options are auto and hpux. The default option is auto. This attribute will be applied to all the initiators in the initiator group. Initiators with different host OSes should not be kept in the same initiator group having a non-default host type attribute.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>fc_tdz_ports</maml:name> <maml:description> <maml:para>List of target Fibre Channel ports with Target Driven Zoning configured on this initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>target_subnets</maml:name> <maml:description> <maml:para>List of target subnet labels. If specified, discovery and access to volumes will be restricted to the specified subnets.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>iscsi_initiators</maml:name> <maml:description> <maml:para>List of iSCSI initiators. When create/update iscsi_initiators, either iqn or ip_address is always required with label.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>fc_initiators</maml:name> <maml:description> <maml:para>List of FC initiators. When create/update fc_initiators, wwpn is required.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this initiator group was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this initiator group was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vp_override</maml:name> <maml:description> <maml:para>Flag to allow modifying VP created initiator groups. When set to true, user can add this initiator to a VP created initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Number of volumes that are accessible by the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes that are accessible by the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_connections</maml:name> <maml:description> <maml:para>Total number of connections from initiators in the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment an initiator group's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSInitiatorGroup</command:name> <maml:description> <maml:para>Delete the specified initiator group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSInitiatorGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Delete the specified initiator group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Initiator group's full name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Initiator group name used for search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Initiator group access protocol.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>host_type</maml:name> <maml:description> <maml:para>Initiator group host type. Available options are auto and hpux. The default option is auto. This attribute will be applied to all the initiators in the initiator group. Initiators with different host OSes should not be kept in the same initiator group having a non-default host type attribute.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fc_tdz_ports</maml:name> <maml:description> <maml:para>List of target Fibre Channel ports with Target Driven Zoning configured on this initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>target_subnets</maml:name> <maml:description> <maml:para>List of target subnet labels. If specified, discovery and access to volumes will be restricted to the specified subnets.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_initiators</maml:name> <maml:description> <maml:para>List of iSCSI initiators. When create/update iscsi_initiators, either iqn or ip_address is always required with label.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fc_initiators</maml:name> <maml:description> <maml:para>List of FC initiators. When create/update fc_initiators, wwpn is required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this initiator group was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this initiator group was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vp_override</maml:name> <maml:description> <maml:para>Flag to allow modifying VP created initiator groups. When set to true, user can add this initiator to a VP created initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Number of volumes that are accessible by the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes that are accessible by the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_connections</maml:name> <maml:description> <maml:para>Total number of connections from initiators in the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSInitiatorGroup</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment an initiator group's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Initiator group's full name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Initiator group name used for search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Initiator group access protocol.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>host_type</maml:name> <maml:description> <maml:para>Initiator group host type. Available options are auto and hpux. The default option is auto. This attribute will be applied to all the initiators in the initiator group. Initiators with different host OSes should not be kept in the same initiator group having a non-default host type attribute.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>fc_tdz_ports</maml:name> <maml:description> <maml:para>List of target Fibre Channel ports with Target Driven Zoning configured on this initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>target_subnets</maml:name> <maml:description> <maml:para>List of target subnet labels. If specified, discovery and access to volumes will be restricted to the specified subnets.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>iscsi_initiators</maml:name> <maml:description> <maml:para>List of iSCSI initiators. When create/update iscsi_initiators, either iqn or ip_address is always required with label.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>fc_initiators</maml:name> <maml:description> <maml:para>List of FC initiators. When create/update fc_initiators, wwpn is required.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this initiator group was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this initiator group was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vp_override</maml:name> <maml:description> <maml:para>Flag to allow modifying VP created initiator groups. When set to true, user can add this initiator to a VP created initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volume_count</maml:name> <maml:description> <maml:para>Number of volumes that are accessible by the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes that are accessible by the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_connections</maml:name> <maml:description> <maml:para>Total number of connections from initiators in the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment an initiator group's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Remove-NSInitiatorGroup -id 0228eada7f8dd99d3b00000000000000000000005a </dev:code> <dev:remarks> <maml:para>This command will remove an initiator group specified by its ID. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Resolve-NSInitiatorGroupMerge</command:name> <maml:description> <maml:para>Suggest an LU number for the volume and initiator group combination.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Resol</command:verb> <command:noun>-NSInitiatorGroupMerge</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Suggest an LU number for the volume and initiator group combination.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Resolve-NSInitiatorGroupMerge</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the initiator group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Resolve-NSInitiatorGroupMerge</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_id</maml:name> <maml:description> <maml:para>ID of the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the initiator 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="true (ByValue)" position="named"> <maml:name>vol_id</maml:name> <maml:description> <maml:para>ID of the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-NSInitiatorGroupLunAvailability</command:name> <maml:description> <maml:para>Validate an LU number for the volume and initiator group combination.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test-</command:verb> <command:noun>-NSInitiatorGroupLunAvailability</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Validate an LU number for the volume and initiator group combination.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-NSInitiatorGroupLunAvailability</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the initiator group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-NSInitiatorGroupLunAvailability</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_id</maml:name> <maml:description> <maml:para>ID of the volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-NSInitiatorGroupLunAvailability</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>lun</maml:name> <maml:description> <maml:para>LU number to validate in decimal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the initiator 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="true (ByValue)" position="named"> <maml:name>vol_id</maml:name> <maml:description> <maml:para>ID of the volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>lun</maml:name> <maml:description> <maml:para>LU number to validate in decimal.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSSnapshot</command:name> <maml:description> <maml:para>Create a snapshot with the given attributes. VSS application-synchronized snapshot must specify the 'writable' parameter and set it to 'true'.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSSnapshot</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Create a snapshot with the given attributes. VSS application-synchronized snapshot must specify the 'writable' parameter and set it to 'true'.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the snapshot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of snapshot.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of snapshot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>size</maml:name> <maml:description> <maml:para>Size of volume at time of snapshot (in bytes).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_name</maml:name> <maml:description> <maml:para>Name of the parent volume in which the snapshot belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool in which the parent volume belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_id</maml:name> <maml:description> <maml:para>Parent volume ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_collection_name</maml:name> <maml:description> <maml:para>Name of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_collection_id</maml:name> <maml:description> <maml:para>Identifier of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>online</maml:name> <maml:description> <maml:para>Online state for a snapshot means it could be mounted for data restore.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>writable</maml:name> <maml:description> <maml:para>Allow snapshot to be writable. Mandatory and must be set to 'true' for VSS application synchronized snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>offline_reason</maml:name> <maml:description> <maml:para>Snapshot offline reason - possible entries: one of 'user', 'recovery', 'replica', 'over_volume_limit', 'over_snapshot_limit', 'over_volume_reserve', 'nvram_loss_recovery', 'pool_free_space_exhausted' .</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>expiry_time</maml:name> <maml:description> <maml:para>Unix timestamp indicating that the snapshot is considered expired by Snapshot Time-to-live(TTL). A value of 0 indicates that snapshot never expires.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>expiry_after</maml:name> <maml:description> <maml:para>Number of seconds after which this snapshot is considered expired by snapshot TTL. A value of 0 indicates that snapshot never expires, 1 indicates that snapshot uses group-level configured TTL value and any other value indicates number of seconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>origin_name</maml:name> <maml:description> <maml:para>Origination group name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_replica</maml:name> <maml:description> <maml:para>Snapshot is a replica from upstream replication partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_unmanaged</maml:name> <maml:description> <maml:para>Indicates whether the snapshot is unmanaged. The snapshot will not be deleted automatically unless the unmanaged cleanup feature is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_manually_managed</maml:name> <maml:description> <maml:para>Is snapshot manually managed, i.e., snapshot is manually or third party created or created by system at the time of volume restore or resize.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replication_status</maml:name> <maml:description> <maml:para>Replication status.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_control_records</maml:name> <maml:description> <maml:para>List of access control records that apply to this snapshot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>serial_number</maml:name> <maml:description> <maml:para>Identifier for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>target_name</maml:name> <maml:description> <maml:para>The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target snapshot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this snapshot was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this snapshort was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>schedule_name</maml:name> <maml:description> <maml:para>Name of protection schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>schedule_id</maml:name> <maml:description> <maml:para>Identifier of protection schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment a snapshot's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>new_data_valid</maml:name> <maml:description> <maml:para>Indicate the usage infomation is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>new_data_compressed_bytes</maml:name> <maml:description> <maml:para>The bytes of compressed new data.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>new_data_uncompressed_bytes</maml:name> <maml:description> <maml:para>The bytes of uncompressed new data.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vpd_t10</maml:name> <maml:description> <maml:para>The snapshot's T10 Vendor ID-based identifier.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vpd_ieee0</maml:name> <maml:description> <maml:para>The first 64 bits of the snapshots's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vpd_ieee1</maml:name> <maml:description> <maml:para>The last 64 bits of the snapshots's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified snapshot even if it is the last replicated collection. Doing so could lead to full re-seeding at the next replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the snapshot.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of snapshot.</maml:para> </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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of snapshot.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>size</maml:name> <maml:description> <maml:para>Size of volume at time of snapshot (in bytes).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_name</maml:name> <maml:description> <maml:para>Name of the parent volume in which the snapshot belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool in which the parent volume belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vol_id</maml:name> <maml:description> <maml:para>Parent volume ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_collection_name</maml:name> <maml:description> <maml:para>Name of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>snap_collection_id</maml:name> <maml:description> <maml:para>Identifier of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>online</maml:name> <maml:description> <maml:para>Online state for a snapshot means it could be mounted for data restore.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>writable</maml:name> <maml:description> <maml:para>Allow snapshot to be writable. Mandatory and must be set to 'true' for VSS application synchronized snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>offline_reason</maml:name> <maml:description> <maml:para>Snapshot offline reason - possible entries: one of 'user', 'recovery', 'replica', 'over_volume_limit', 'over_snapshot_limit', 'over_volume_reserve', 'nvram_loss_recovery', 'pool_free_space_exhausted' .</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>expiry_time</maml:name> <maml:description> <maml:para>Unix timestamp indicating that the snapshot is considered expired by Snapshot Time-to-live(TTL). A value of 0 indicates that snapshot never expires.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>expiry_after</maml:name> <maml:description> <maml:para>Number of seconds after which this snapshot is considered expired by snapshot TTL. A value of 0 indicates that snapshot never expires, 1 indicates that snapshot uses group-level configured TTL value and any other value indicates number of seconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>origin_name</maml:name> <maml:description> <maml:para>Origination group name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>is_replica</maml:name> <maml:description> <maml:para>Snapshot is a replica from upstream replication partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_unmanaged</maml:name> <maml:description> <maml:para>Indicates whether the snapshot is unmanaged. The snapshot will not be deleted automatically unless the unmanaged cleanup feature is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_manually_managed</maml:name> <maml:description> <maml:para>Is snapshot manually managed, i.e., snapshot is manually or third party created or created by system at the time of volume restore or resize.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>replication_status</maml:name> <maml:description> <maml:para>Replication status.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>access_control_records</maml:name> <maml:description> <maml:para>List of access control records that apply to this snapshot.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>serial_number</maml:name> <maml:description> <maml:para>Identifier for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>target_name</maml:name> <maml:description> <maml:para>The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target snapshot.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this snapshot was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this snapshort was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>schedule_name</maml:name> <maml:description> <maml:para>Name of protection schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>schedule_id</maml:name> <maml:description> <maml:para>Identifier of protection schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of snapshots.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment a snapshot's attributes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>new_data_valid</maml:name> <maml:description> <maml:para>Indicate the usage infomation is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>new_data_compressed_bytes</maml:name> <maml:description> <maml:para>The bytes of compressed new data.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>new_data_uncompressed_bytes</maml:name> <maml:description> <maml:para>The bytes of uncompressed new data.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vpd_t10</maml:name> <maml:description> <maml:para>The snapshot's T10 Vendor ID-based identifier.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vpd_ieee0</maml:name> <maml:description> <maml:para>The first 64 bits of the snapshots's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vpd_ieee1</maml:name> <maml:description> <maml:para>The last 64 bits of the snapshots's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified snapshot even if it is the last replicated collection. Doing so could lead to full re-seeding at the next replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> PS:> New-nsSnapshot -name TestSnap-896 -vol_id 0628eada7f8dd99d3b000000000000000000000006 name id vol_name schedule_name online description ---- -- -------- ------------- ------ ----------- TestSnap-896 0428eada7f8dd99d3b0000000000000007000000b6 TestVol4 False </dev:code> <dev:remarks> <maml:para>This command will create a new Snapshot using the minimal number of parameters. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSSnapshot</command:name> <maml:description> <maml:para>Retrieve attributes from a single snapshot or a list of snapshots for a given volume. When asking for a list of snapshots, at least one filter criteria must be specified(e.g. vol_id, vol_name, serial_number). Multiple filters are supported.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSSnapshot</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Retrieve attributes from a single snapshot or a list of snapshots for a given volume. When asking for a list of snapshots, at least one filter criteria must be specified(e.g. vol_id, vol_name, serial_number). Multiple filters are supported.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the snapshot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of snapshot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of snapshot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>size</maml:name> <maml:description> <maml:para>Size of volume at time of snapshot (in bytes).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_name</maml:name> <maml:description> <maml:para>Name of the parent volume in which the snapshot belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool in which the parent volume belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_id</maml:name> <maml:description> <maml:para>Parent volume ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_collection_name</maml:name> <maml:description> <maml:para>Name of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_collection_id</maml:name> <maml:description> <maml:para>Identifier of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>online</maml:name> <maml:description> <maml:para>Online state for a snapshot means it could be mounted for data restore.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>writable</maml:name> <maml:description> <maml:para>Allow snapshot to be writable. Mandatory and must be set to 'true' for VSS application synchronized snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>offline_reason</maml:name> <maml:description> <maml:para>Snapshot offline reason - possible entries: one of 'user', 'recovery', 'replica', 'over_volume_limit', 'over_snapshot_limit', 'over_volume_reserve', 'nvram_loss_recovery', 'pool_free_space_exhausted' .</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>expiry_time</maml:name> <maml:description> <maml:para>Unix timestamp indicating that the snapshot is considered expired by Snapshot Time-to-live(TTL). A value of 0 indicates that snapshot never expires.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>expiry_after</maml:name> <maml:description> <maml:para>Number of seconds after which this snapshot is considered expired by snapshot TTL. A value of 0 indicates that snapshot never expires, 1 indicates that snapshot uses group-level configured TTL value and any other value indicates number of seconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>origin_name</maml:name> <maml:description> <maml:para>Origination group name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_replica</maml:name> <maml:description> <maml:para>Snapshot is a replica from upstream replication partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_unmanaged</maml:name> <maml:description> <maml:para>Indicates whether the snapshot is unmanaged. The snapshot will not be deleted automatically unless the unmanaged cleanup feature is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_manually_managed</maml:name> <maml:description> <maml:para>Is snapshot manually managed, i.e., snapshot is manually or third party created or created by system at the time of volume restore or resize.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replication_status</maml:name> <maml:description> <maml:para>Replication status.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_control_records</maml:name> <maml:description> <maml:para>List of access control records that apply to this snapshot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>serial_number</maml:name> <maml:description> <maml:para>Identifier for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>target_name</maml:name> <maml:description> <maml:para>The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target snapshot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this snapshot was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this snapshort was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>schedule_name</maml:name> <maml:description> <maml:para>Name of protection schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>schedule_id</maml:name> <maml:description> <maml:para>Identifier of protection schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment a snapshot's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>new_data_valid</maml:name> <maml:description> <maml:para>Indicate the usage infomation is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>new_data_compressed_bytes</maml:name> <maml:description> <maml:para>The bytes of compressed new data.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>new_data_uncompressed_bytes</maml:name> <maml:description> <maml:para>The bytes of uncompressed new data.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vpd_t10</maml:name> <maml:description> <maml:para>The snapshot's T10 Vendor ID-based identifier.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vpd_ieee0</maml:name> <maml:description> <maml:para>The first 64 bits of the snapshots's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vpd_ieee1</maml:name> <maml:description> <maml:para>The last 64 bits of the snapshots's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified snapshot even if it is the last replicated collection. Doing so could lead to full re-seeding at the next replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the snapshot.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of snapshot.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of snapshot.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>size</maml:name> <maml:description> <maml:para>Size of volume at time of snapshot (in bytes).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_name</maml:name> <maml:description> <maml:para>Name of the parent volume in which the snapshot belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool in which the parent volume belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vol_id</maml:name> <maml:description> <maml:para>Parent volume ID.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>snap_collection_name</maml:name> <maml:description> <maml:para>Name of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>snap_collection_id</maml:name> <maml:description> <maml:para>Identifier of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>online</maml:name> <maml:description> <maml:para>Online state for a snapshot means it could be mounted for data restore.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>writable</maml:name> <maml:description> <maml:para>Allow snapshot to be writable. Mandatory and must be set to 'true' for VSS application synchronized snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>offline_reason</maml:name> <maml:description> <maml:para>Snapshot offline reason - possible entries: one of 'user', 'recovery', 'replica', 'over_volume_limit', 'over_snapshot_limit', 'over_volume_reserve', 'nvram_loss_recovery', 'pool_free_space_exhausted' .</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>expiry_time</maml:name> <maml:description> <maml:para>Unix timestamp indicating that the snapshot is considered expired by Snapshot Time-to-live(TTL). A value of 0 indicates that snapshot never expires.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>expiry_after</maml:name> <maml:description> <maml:para>Number of seconds after which this snapshot is considered expired by snapshot TTL. A value of 0 indicates that snapshot never expires, 1 indicates that snapshot uses group-level configured TTL value and any other value indicates number of seconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>origin_name</maml:name> <maml:description> <maml:para>Origination group name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>is_replica</maml:name> <maml:description> <maml:para>Snapshot is a replica from upstream replication partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_unmanaged</maml:name> <maml:description> <maml:para>Indicates whether the snapshot is unmanaged. The snapshot will not be deleted automatically unless the unmanaged cleanup feature is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_manually_managed</maml:name> <maml:description> <maml:para>Is snapshot manually managed, i.e., snapshot is manually or third party created or created by system at the time of volume restore or resize.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>replication_status</maml:name> <maml:description> <maml:para>Replication status.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>access_control_records</maml:name> <maml:description> <maml:para>List of access control records that apply to this snapshot.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>serial_number</maml:name> <maml:description> <maml:para>Identifier for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>target_name</maml:name> <maml:description> <maml:para>The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target snapshot.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this snapshot was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this snapshort was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>schedule_name</maml:name> <maml:description> <maml:para>Name of protection schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>schedule_id</maml:name> <maml:description> <maml:para>Identifier of protection schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of snapshots.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment a snapshot's attributes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>new_data_valid</maml:name> <maml:description> <maml:para>Indicate the usage infomation is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>new_data_compressed_bytes</maml:name> <maml:description> <maml:para>The bytes of compressed new data.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>new_data_uncompressed_bytes</maml:name> <maml:description> <maml:para>The bytes of uncompressed new data.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vpd_t10</maml:name> <maml:description> <maml:para>The snapshot's T10 Vendor ID-based identifier.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vpd_ieee0</maml:name> <maml:description> <maml:para>The first 64 bits of the snapshots's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vpd_ieee1</maml:name> <maml:description> <maml:para>The last 64 bits of the snapshots's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified snapshot even if it is the last replicated collection. Doing so could lead to full re-seeding at the next replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSSnapshot -vol_name 'TestVol4' name id vol_name schedule_name online description ---- -- -------- ------------- ------ ----------- Testsnap1 0428eada7f8dd99d3b000000000000000700000005 TestVol4 False TestSnap2 0428eada7f8dd99d3b000000000000000700000006 TestVol4 False TestSnap6 0428eada7f8dd99d3b000000000000000700000014 TestVol4 False TestSnap-803 0428eada7f8dd99d3b000000000000000700000017 TestVol4 False TestSnap-553 0428eada7f8dd99d3b000000000000000700000019 TestVol4 False TestSnap-449 0428eada7f8dd99d3b000000000000000700000016 TestVol4 False TestSnap-31 0428eada7f8dd99d3b00000000000000070000001c TestVol4 False TestSnap-792 0428eada7f8dd99d3b00000000000000070000001e TestVol4 False </dev:code> <dev:remarks> <maml:para>This command will retrieve the Snapshots. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 2 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-nsSnapshot -vol_name 'TestVol4' -name Testsnap1 name id vol_name schedule_name online description ---- -- -------- ------------- ------ ----------- Testsnap1 0428eada7f8dd99d3b000000000000000700000005 TestVol4 False </dev:code> <dev:remarks> <maml:para>This command will retrieve the Snapshot specified by name. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSSnapshot</command:name> <maml:description> <maml:para>Modify snapshot attributes.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSSnapshot</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Modify snapshot attributes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the snapshot.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of snapshot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of snapshot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>size</maml:name> <maml:description> <maml:para>Size of volume at time of snapshot (in bytes).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_name</maml:name> <maml:description> <maml:para>Name of the parent volume in which the snapshot belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool in which the parent volume belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_id</maml:name> <maml:description> <maml:para>Parent volume ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_collection_name</maml:name> <maml:description> <maml:para>Name of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_collection_id</maml:name> <maml:description> <maml:para>Identifier of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>online</maml:name> <maml:description> <maml:para>Online state for a snapshot means it could be mounted for data restore.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>writable</maml:name> <maml:description> <maml:para>Allow snapshot to be writable. Mandatory and must be set to 'true' for VSS application synchronized snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>offline_reason</maml:name> <maml:description> <maml:para>Snapshot offline reason - possible entries: one of 'user', 'recovery', 'replica', 'over_volume_limit', 'over_snapshot_limit', 'over_volume_reserve', 'nvram_loss_recovery', 'pool_free_space_exhausted' .</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>expiry_time</maml:name> <maml:description> <maml:para>Unix timestamp indicating that the snapshot is considered expired by Snapshot Time-to-live(TTL). A value of 0 indicates that snapshot never expires.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>expiry_after</maml:name> <maml:description> <maml:para>Number of seconds after which this snapshot is considered expired by snapshot TTL. A value of 0 indicates that snapshot never expires, 1 indicates that snapshot uses group-level configured TTL value and any other value indicates number of seconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>origin_name</maml:name> <maml:description> <maml:para>Origination group name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_replica</maml:name> <maml:description> <maml:para>Snapshot is a replica from upstream replication partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_unmanaged</maml:name> <maml:description> <maml:para>Indicates whether the snapshot is unmanaged. The snapshot will not be deleted automatically unless the unmanaged cleanup feature is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_manually_managed</maml:name> <maml:description> <maml:para>Is snapshot manually managed, i.e., snapshot is manually or third party created or created by system at the time of volume restore or resize.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replication_status</maml:name> <maml:description> <maml:para>Replication status.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_control_records</maml:name> <maml:description> <maml:para>List of access control records that apply to this snapshot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>serial_number</maml:name> <maml:description> <maml:para>Identifier for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>target_name</maml:name> <maml:description> <maml:para>The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target snapshot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this snapshot was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this snapshort was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>schedule_name</maml:name> <maml:description> <maml:para>Name of protection schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>schedule_id</maml:name> <maml:description> <maml:para>Identifier of protection schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment a snapshot's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>new_data_valid</maml:name> <maml:description> <maml:para>Indicate the usage infomation is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>new_data_compressed_bytes</maml:name> <maml:description> <maml:para>The bytes of compressed new data.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>new_data_uncompressed_bytes</maml:name> <maml:description> <maml:para>The bytes of uncompressed new data.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vpd_t10</maml:name> <maml:description> <maml:para>The snapshot's T10 Vendor ID-based identifier.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vpd_ieee0</maml:name> <maml:description> <maml:para>The first 64 bits of the snapshots's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vpd_ieee1</maml:name> <maml:description> <maml:para>The last 64 bits of the snapshots's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified snapshot even if it is the last replicated collection. Doing so could lead to full re-seeding at the next replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the snapshot.</maml:para> </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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of snapshot.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of snapshot.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>size</maml:name> <maml:description> <maml:para>Size of volume at time of snapshot (in bytes).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_name</maml:name> <maml:description> <maml:para>Name of the parent volume in which the snapshot belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool in which the parent volume belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vol_id</maml:name> <maml:description> <maml:para>Parent volume ID.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>snap_collection_name</maml:name> <maml:description> <maml:para>Name of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>snap_collection_id</maml:name> <maml:description> <maml:para>Identifier of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>online</maml:name> <maml:description> <maml:para>Online state for a snapshot means it could be mounted for data restore.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>writable</maml:name> <maml:description> <maml:para>Allow snapshot to be writable. Mandatory and must be set to 'true' for VSS application synchronized snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>offline_reason</maml:name> <maml:description> <maml:para>Snapshot offline reason - possible entries: one of 'user', 'recovery', 'replica', 'over_volume_limit', 'over_snapshot_limit', 'over_volume_reserve', 'nvram_loss_recovery', 'pool_free_space_exhausted' .</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>expiry_time</maml:name> <maml:description> <maml:para>Unix timestamp indicating that the snapshot is considered expired by Snapshot Time-to-live(TTL). A value of 0 indicates that snapshot never expires.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>expiry_after</maml:name> <maml:description> <maml:para>Number of seconds after which this snapshot is considered expired by snapshot TTL. A value of 0 indicates that snapshot never expires, 1 indicates that snapshot uses group-level configured TTL value and any other value indicates number of seconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>origin_name</maml:name> <maml:description> <maml:para>Origination group name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>is_replica</maml:name> <maml:description> <maml:para>Snapshot is a replica from upstream replication partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_unmanaged</maml:name> <maml:description> <maml:para>Indicates whether the snapshot is unmanaged. The snapshot will not be deleted automatically unless the unmanaged cleanup feature is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_manually_managed</maml:name> <maml:description> <maml:para>Is snapshot manually managed, i.e., snapshot is manually or third party created or created by system at the time of volume restore or resize.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>replication_status</maml:name> <maml:description> <maml:para>Replication status.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>access_control_records</maml:name> <maml:description> <maml:para>List of access control records that apply to this snapshot.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>serial_number</maml:name> <maml:description> <maml:para>Identifier for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>target_name</maml:name> <maml:description> <maml:para>The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target snapshot.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this snapshot was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this snapshort was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>schedule_name</maml:name> <maml:description> <maml:para>Name of protection schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>schedule_id</maml:name> <maml:description> <maml:para>Identifier of protection schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of snapshots.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment a snapshot's attributes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>new_data_valid</maml:name> <maml:description> <maml:para>Indicate the usage infomation is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>new_data_compressed_bytes</maml:name> <maml:description> <maml:para>The bytes of compressed new data.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>new_data_uncompressed_bytes</maml:name> <maml:description> <maml:para>The bytes of uncompressed new data.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vpd_t10</maml:name> <maml:description> <maml:para>The snapshot's T10 Vendor ID-based identifier.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vpd_ieee0</maml:name> <maml:description> <maml:para>The first 64 bits of the snapshots's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vpd_ieee1</maml:name> <maml:description> <maml:para>The last 64 bits of the snapshots's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified snapshot even if it is the last replicated collection. Doing so could lead to full re-seeding at the next replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Set-NSSnapshot -id 0428eada7f8dd99d3b0000000000000007000000b7 -online $False name id vol_name schedule_name online description ---- -- -------- ------------- ------ ----------- TestSnap-491 0428eada7f8dd99d3b0000000000000007000000b7 TestVol4 False </dev:code> <dev:remarks> <maml:para>This command will set the value of offline for the Snapshot specified by id. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSSnapshot</command:name> <maml:description> <maml:para>Delete a snapshot with the given name or identifier. Snapshots cannot be deleted if they are in use by replication on the affected volume. Replication must be paused or unconfigured in order for the deletion to proceed.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSSnapshot</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Delete a snapshot with the given name or identifier. Snapshots cannot be deleted if they are in use by replication on the affected volume. Replication must be paused or unconfigured in order for the deletion to proceed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the snapshot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of snapshot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of snapshot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>size</maml:name> <maml:description> <maml:para>Size of volume at time of snapshot (in bytes).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_name</maml:name> <maml:description> <maml:para>Name of the parent volume in which the snapshot belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool in which the parent volume belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_id</maml:name> <maml:description> <maml:para>Parent volume ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_collection_name</maml:name> <maml:description> <maml:para>Name of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_collection_id</maml:name> <maml:description> <maml:para>Identifier of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>online</maml:name> <maml:description> <maml:para>Online state for a snapshot means it could be mounted for data restore.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>writable</maml:name> <maml:description> <maml:para>Allow snapshot to be writable. Mandatory and must be set to 'true' for VSS application synchronized snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>offline_reason</maml:name> <maml:description> <maml:para>Snapshot offline reason - possible entries: one of 'user', 'recovery', 'replica', 'over_volume_limit', 'over_snapshot_limit', 'over_volume_reserve', 'nvram_loss_recovery', 'pool_free_space_exhausted' .</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>expiry_time</maml:name> <maml:description> <maml:para>Unix timestamp indicating that the snapshot is considered expired by Snapshot Time-to-live(TTL). A value of 0 indicates that snapshot never expires.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>expiry_after</maml:name> <maml:description> <maml:para>Number of seconds after which this snapshot is considered expired by snapshot TTL. A value of 0 indicates that snapshot never expires, 1 indicates that snapshot uses group-level configured TTL value and any other value indicates number of seconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>origin_name</maml:name> <maml:description> <maml:para>Origination group name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_replica</maml:name> <maml:description> <maml:para>Snapshot is a replica from upstream replication partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_unmanaged</maml:name> <maml:description> <maml:para>Indicates whether the snapshot is unmanaged. The snapshot will not be deleted automatically unless the unmanaged cleanup feature is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_manually_managed</maml:name> <maml:description> <maml:para>Is snapshot manually managed, i.e., snapshot is manually or third party created or created by system at the time of volume restore or resize.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replication_status</maml:name> <maml:description> <maml:para>Replication status.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_control_records</maml:name> <maml:description> <maml:para>List of access control records that apply to this snapshot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>serial_number</maml:name> <maml:description> <maml:para>Identifier for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>target_name</maml:name> <maml:description> <maml:para>The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target snapshot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this snapshot was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this snapshort was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>schedule_name</maml:name> <maml:description> <maml:para>Name of protection schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>schedule_id</maml:name> <maml:description> <maml:para>Identifier of protection schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment a snapshot's attributes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>new_data_valid</maml:name> <maml:description> <maml:para>Indicate the usage infomation is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>new_data_compressed_bytes</maml:name> <maml:description> <maml:para>The bytes of compressed new data.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>new_data_uncompressed_bytes</maml:name> <maml:description> <maml:para>The bytes of uncompressed new data.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vpd_t10</maml:name> <maml:description> <maml:para>The snapshot's T10 Vendor ID-based identifier.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vpd_ieee0</maml:name> <maml:description> <maml:para>The first 64 bits of the snapshots's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vpd_ieee1</maml:name> <maml:description> <maml:para>The last 64 bits of the snapshots's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSSnapshot</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified snapshot even if it is the last replicated collection. Doing so could lead to full re-seeding at the next replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the snapshot.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of snapshot.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of snapshot.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>size</maml:name> <maml:description> <maml:para>Size of volume at time of snapshot (in bytes).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_name</maml:name> <maml:description> <maml:para>Name of the parent volume in which the snapshot belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool in which the parent volume belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vol_id</maml:name> <maml:description> <maml:para>Parent volume ID.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>snap_collection_name</maml:name> <maml:description> <maml:para>Name of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>snap_collection_id</maml:name> <maml:description> <maml:para>Identifier of snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>online</maml:name> <maml:description> <maml:para>Online state for a snapshot means it could be mounted for data restore.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>writable</maml:name> <maml:description> <maml:para>Allow snapshot to be writable. Mandatory and must be set to 'true' for VSS application synchronized snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>offline_reason</maml:name> <maml:description> <maml:para>Snapshot offline reason - possible entries: one of 'user', 'recovery', 'replica', 'over_volume_limit', 'over_snapshot_limit', 'over_volume_reserve', 'nvram_loss_recovery', 'pool_free_space_exhausted' .</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>expiry_time</maml:name> <maml:description> <maml:para>Unix timestamp indicating that the snapshot is considered expired by Snapshot Time-to-live(TTL). A value of 0 indicates that snapshot never expires.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>expiry_after</maml:name> <maml:description> <maml:para>Number of seconds after which this snapshot is considered expired by snapshot TTL. A value of 0 indicates that snapshot never expires, 1 indicates that snapshot uses group-level configured TTL value and any other value indicates number of seconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>origin_name</maml:name> <maml:description> <maml:para>Origination group name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>is_replica</maml:name> <maml:description> <maml:para>Snapshot is a replica from upstream replication partner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_unmanaged</maml:name> <maml:description> <maml:para>Indicates whether the snapshot is unmanaged. The snapshot will not be deleted automatically unless the unmanaged cleanup feature is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_manually_managed</maml:name> <maml:description> <maml:para>Is snapshot manually managed, i.e., snapshot is manually or third party created or created by system at the time of volume restore or resize.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>replication_status</maml:name> <maml:description> <maml:para>Replication status.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>access_control_records</maml:name> <maml:description> <maml:para>List of access control records that apply to this snapshot.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>serial_number</maml:name> <maml:description> <maml:para>Identifier for the SCSI protocol.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>target_name</maml:name> <maml:description> <maml:para>The iSCSI Qualified Name (IQN) or the Fibre Channel World Wide Node Name (WWNN) of the target snapshot.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this snapshot was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this snapshort was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>schedule_name</maml:name> <maml:description> <maml:para>Name of protection schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>schedule_id</maml:name> <maml:description> <maml:para>Identifier of protection schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of snapshots.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>metadata</maml:name> <maml:description> <maml:para>Key-value pairs that augment a snapshot's attributes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>new_data_valid</maml:name> <maml:description> <maml:para>Indicate the usage infomation is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>new_data_compressed_bytes</maml:name> <maml:description> <maml:para>The bytes of compressed new data.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>new_data_uncompressed_bytes</maml:name> <maml:description> <maml:para>The bytes of uncompressed new data.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vpd_t10</maml:name> <maml:description> <maml:para>The snapshot's T10 Vendor ID-based identifier.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vpd_ieee0</maml:name> <maml:description> <maml:para>The first 64 bits of the snapshots's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vpd_ieee1</maml:name> <maml:description> <maml:para>The last 64 bits of the snapshots's EUI-64 identifier, encoded as a hexadecimal string.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified snapshot even if it is the last replicated collection. Doing so could lead to full re-seeding at the next replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Remove-NSSnapshot -id 0428eada7f8dd99d3b0000000000000007000000b8 </dev:code> <dev:remarks> <maml:para>This command will remove the Snapshot specified by id. Note that the Snapshot must be offline for this to succeed. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSSnapshotBulk</command:name> <maml:description> <maml:para>Create snapshots on the given set of volumes.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New-N</command:verb> <command:noun>-NSSnapshotBulk</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Create snapshots on the given set of volumes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSSnapshotBulk</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_vol_list</maml:name> <maml:description> <maml:para>List of volumes to snapshot and corresponding snapshot creation attributes. VSS application-synchronized snapshot must specify the 'writable' parameter and set it to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotBulk</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replicate</maml:name> <maml:description> <maml:para>Allow snapshot to be replicated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSSnapshotBulk</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vss_snap</maml:name> <maml:description> <maml:para>VSS app-synchronized snapshot; we don't support creation of non app-synchronized sanpshots through this interface; must be set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_vol_list</maml:name> <maml:description> <maml:para>List of volumes to snapshot and corresponding snapshot creation attributes. VSS application-synchronized snapshot must specify the 'writable' parameter and set it to true.</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="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>replicate</maml:name> <maml:description> <maml:para>Allow snapshot to be replicated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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>vss_snap</maml:name> <maml:description> <maml:para>VSS app-synchronized snapshot; we don't support creation of non app-synchronized sanpshots through this interface; must be set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSActiveDirectoryMembership</command:name> <maml:description> <maml:para>Joins with the Active Directory domain.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSActiveDirectoryMembership</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Joins with the Active Directory domain.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the Active Directory Domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description for the Active Directory Domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Identifier for the Active Directory domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>netbios</maml:name> <maml:description> <maml:para>Netbios name for the Active Directory domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>server_list</maml:name> <maml:description> <maml:para>List of IP addresses or names for the backup domain controller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>computer_name</maml:name> <maml:description> <maml:para>The name of the computer account in the domain controller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>organizational_unit</maml:name> <maml:description> <maml:para>The location for the computer account.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSActiveDirectoryMembership</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user</maml:name> <maml:description> <maml:para>Name of the Activer Directory user with Administrator's privilege.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSActiveDirectoryMembership</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Password for the Active Directory user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>enabled</maml:name> <maml:description> <maml:para>Active Directory authentication is currently enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the Active Directory Domain.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description for the Active Directory Domain.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Identifier for the Active Directory domain.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>netbios</maml:name> <maml:description> <maml:para>Netbios name for the Active Directory domain.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>server_list</maml:name> <maml:description> <maml:para>List of IP addresses or names for the backup domain controller.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>computer_name</maml:name> <maml:description> <maml:para>The name of the computer account in the domain controller.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>organizational_unit</maml:name> <maml:description> <maml:para>The location for the computer account.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>user</maml:name> <maml:description> <maml:para>Name of the Activer Directory user with Administrator's privilege.</maml:para> </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="true (ByValue)" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Password for the Active Directory user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>enabled</maml:name> <maml:description> <maml:para>Active Directory authentication is currently enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSActiveDirectoryMembership</command:name> <maml:description> <maml:para>List the Active Directory Information.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSActiveDirectoryMembership</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List the Active Directory Information.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the Active Directory Domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description for the Active Directory Domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Identifier for the Active Directory domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>netbios</maml:name> <maml:description> <maml:para>Netbios name for the Active Directory domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>server_list</maml:name> <maml:description> <maml:para>List of IP addresses or names for the backup domain controller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>computer_name</maml:name> <maml:description> <maml:para>The name of the computer account in the domain controller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>organizational_unit</maml:name> <maml:description> <maml:para>The location for the computer account.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user</maml:name> <maml:description> <maml:para>Name of the Activer Directory user with Administrator's privilege.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Password for the Active Directory user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>enabled</maml:name> <maml:description> <maml:para>Active Directory authentication is currently enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the Active Directory Domain.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description for the Active Directory Domain.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Identifier for the Active Directory domain.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>netbios</maml:name> <maml:description> <maml:para>Netbios name for the Active Directory domain.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>server_list</maml:name> <maml:description> <maml:para>List of IP addresses or names for the backup domain controller.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>computer_name</maml:name> <maml:description> <maml:para>The name of the computer account in the domain controller.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>organizational_unit</maml:name> <maml:description> <maml:para>The location for the computer account.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>user</maml:name> <maml:description> <maml:para>Name of the Activer Directory user with Administrator's privilege.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Password for the Active Directory user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>enabled</maml:name> <maml:description> <maml:para>Active Directory authentication is currently enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSActiveDirectoryMembership</command:name> <maml:description> <maml:para>Updates the Active Directory configuration.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSActiveDirectoryMembership</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Updates the Active Directory configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the Active Directory Domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description for the Active Directory Domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Identifier for the Active Directory domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>netbios</maml:name> <maml:description> <maml:para>Netbios name for the Active Directory domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>server_list</maml:name> <maml:description> <maml:para>List of IP addresses or names for the backup domain controller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>computer_name</maml:name> <maml:description> <maml:para>The name of the computer account in the domain controller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>organizational_unit</maml:name> <maml:description> <maml:para>The location for the computer account.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user</maml:name> <maml:description> <maml:para>Name of the Activer Directory user with Administrator's privilege.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Password for the Active Directory user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>enabled</maml:name> <maml:description> <maml:para>Active Directory authentication is currently enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the Active Directory Domain.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description for the Active Directory Domain.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Identifier for the Active Directory domain.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>netbios</maml:name> <maml:description> <maml:para>Netbios name for the Active Directory domain.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>server_list</maml:name> <maml:description> <maml:para>List of IP addresses or names for the backup domain controller.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>computer_name</maml:name> <maml:description> <maml:para>The name of the computer account in the domain controller.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>organizational_unit</maml:name> <maml:description> <maml:para>The location for the computer account.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>user</maml:name> <maml:description> <maml:para>Name of the Activer Directory user with Administrator's privilege.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Password for the Active Directory user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>enabled</maml:name> <maml:description> <maml:para>Active Directory authentication is currently enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSActiveDirectoryMembership</command:name> <maml:description> <maml:para>Leaves the Active Directory domain.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remov</command:verb> <command:noun>-NSActiveDirectoryMembership</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Leaves the Active Directory domain.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSActiveDirectoryMembership</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the active directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSActiveDirectoryMembership</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user</maml:name> <maml:description> <maml:para>Name of the Activer Directory user with the privilege to leave the domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSActiveDirectoryMembership</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Password for the Active Directory user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSActiveDirectoryMembership</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Use this option when there is an error when leaving the domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the active directory.</maml:para> </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="true (ByValue)" position="named"> <maml:name>user</maml:name> <maml:description> <maml:para>Name of the Activer Directory user with the privilege to leave the 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="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>Password for the Active Directory user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Use this option when there is an error when leaving the domain.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-NSActiveDirectoryMembership</command:name> <maml:description> <maml:para>Reports the detail status of the Active Directory domain.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test-</command:verb> <command:noun>-NSActiveDirectoryMembership</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Reports the detail status of the Active Directory domain.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-NSActiveDirectoryMembership</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the active directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the active directory.</maml:para> </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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-NSActiveDirectoryMembershipUser</command:name> <maml:description> <maml:para>Tests whether the user exist in the Active Directory. If the user is present, then the user's group and role information is reported.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test-</command:verb> <command:noun>-NSActiveDirectoryMembershipUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Tests whether the user exist in the Active Directory. If the user is present, then the user's group and role information is reported.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-NSActiveDirectoryMembershipUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the Active Directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-NSActiveDirectoryMembershipUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the Active Directory user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the Active Directory.</maml:para> </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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the Active Directory user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-NSActiveDirectoryMembershipGroup</command:name> <maml:description> <maml:para>Tests whether the user group exist in the Active Directory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test-</command:verb> <command:noun>-NSActiveDirectoryMembershipGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Tests whether the user group exist in the Active Directory.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-NSActiveDirectoryMembershipGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the Active Directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-NSActiveDirectoryMembershipGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the Active Directory group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the Active Directory.</maml:para> </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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the Active Directory 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSSubnet</command:name> <maml:description> <maml:para>Lists subnets.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSSubnet</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Lists subnets.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSSubnet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubnet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of subnet configuration.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubnet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>network</maml:name> <maml:description> <maml:para>Subnet network address.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubnet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>netmask</maml:name> <maml:description> <maml:para>Subnet netmask address.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubnet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>Subnet type. Options include 'mgmt', 'data', and 'mgmt,data'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubnet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>allow_iscsi</maml:name> <maml:description> <maml:para>Subnet type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubnet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>allow_group</maml:name> <maml:description> <maml:para>Subnet type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubnet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>discovery_ip</maml:name> <maml:description> <maml:para>Subnet network address.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubnet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>mtu</maml:name> <maml:description> <maml:para>MTU for specified subnet. Valid MTU's are in the 512-16000 range.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubnet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>netzone_type</maml:name> <maml:description> <maml:para>Specify Network Affinity Zone type for iSCSI enabled subnets. Valid types are Single, Bisect, and EvenOdd for iSCSI subnets.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubnet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vlan_id</maml:name> <maml:description> <maml:para>VLAN ID for specified subnet. Valid ID's are in the 1-4094 range.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubnet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this subnet configuration was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubnet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this subnet configuration was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubnet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>failover</maml:name> <maml:description> <maml:para>Failover setting of the subnet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSubnet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>failover_enable_time</maml:name> <maml:description> <maml:para>Failover for this subnet will be enabled again at the time specified by failover_enable_time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the initiator group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of subnet configuration.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>network</maml:name> <maml:description> <maml:para>Subnet network address.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>netmask</maml:name> <maml:description> <maml:para>Subnet netmask address.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>Subnet type. Options include 'mgmt', 'data', and 'mgmt,data'.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>allow_iscsi</maml:name> <maml:description> <maml:para>Subnet type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>allow_group</maml:name> <maml:description> <maml:para>Subnet type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>discovery_ip</maml:name> <maml:description> <maml:para>Subnet network address.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>mtu</maml:name> <maml:description> <maml:para>MTU for specified subnet. Valid MTU's are in the 512-16000 range.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>netzone_type</maml:name> <maml:description> <maml:para>Specify Network Affinity Zone type for iSCSI enabled subnets. Valid types are Single, Bisect, and EvenOdd for iSCSI subnets.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vlan_id</maml:name> <maml:description> <maml:para>VLAN ID for specified subnet. Valid ID's are in the 1-4094 range.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this subnet configuration was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this subnet configuration was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>failover</maml:name> <maml:description> <maml:para>Failover setting of the subnet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>failover_enable_time</maml:name> <maml:description> <maml:para>Failover for this subnet will be enabled again at the time specified by failover_enable_time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSFolder</command:name> <maml:description> <maml:para>Create a new folder.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSFolder</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Create a new folder.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fqn</maml:name> <maml:description> <maml:para>Fully qualified name of folder in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of folder in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of folder used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool where the folder resides.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>ID of the pool where the folder resides.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_bytes_specified</maml:name> <maml:description> <maml:para>Indicates whether the folder has a limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_bytes</maml:name> <maml:description> <maml:para>Folder limit size in bytes. By default, a folder (except SMIS and VVol types) does not have a limit. If limit_bytes is not specified when a folder is created, or if limit_bytes is set to the largest possible 64-bit signed integer (9223372036854775807), then the folder has no limit. Otherwise, a limit smaller than the capacity of the pool can be set. On output, if the folder has a limit, the limit_bytes_specified attribute will be true and limit_bytes will be the limit. If the folder does not have a limit, the limit_bytes_specified attribute will be false and limit_bytes will be interpreted based on the value of the usage_valid attribute. If the usage_valid attribute is true, limits_byte will be the capacity of the pool. Otherwise, limits_bytes is not meaningful and can be null. SMIS and VVol folders require a size limit. This attribute is superseded by limit_size_bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_size_bytes</maml:name> <maml:description> <maml:para>Folder size limit in bytes. If limit_size_bytes is not specified when a folder is created, or if limit_size_bytes is set to -1, then the folder has no limit. Otherwise, a limit smaller than the capacity of the pool can be set. Folders with an agent_type of 'smis' or 'vvol' must have a size limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>provisioned_limit_size_bytes</maml:name> <maml:description> <maml:para>Limit on the provisioned size of volumes in a folder. If provisioned_limit_size_bytes is not specified when a folder is created, or if provisioned_limit_size_bytes is set to -1, then the folder has no provisioned size limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>overdraft_limit_pct</maml:name> <maml:description> <maml:para>Amount of space to consider as overdraft range for this folder as a percentage of folder used limit. Valid values are from 0% - 200%. This is the limit above the folder usage limit beyond which enforcement action(volume offline/non-writable) is issued.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>capacity_bytes</maml:name> <maml:description> <maml:para>Capacity of the folder in bytes. If the folder's size has a usage limit, capacity_bytes will be the folder's usage limit. If the folder's size does not have a usage limit, capacity_bytes will be the pool's capacity. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>free_space_bytes</maml:name> <maml:description> <maml:para>Free space in the folder in bytes. If the folder has a usage limit, free_space_bytes will be the folder's free space (the folder's usage limit minus the folder's space usage). If the folder does not have a usage limit, free_space_bytes will be the pool's free space. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>provisioned_bytes</maml:name> <maml:description> <maml:para>Sum of provisioned size of volumes in the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage_bytes</maml:name> <maml:description> <maml:para>Sum of mapped usage and snapshot uncompressed usage of volumes in the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_mapped_bytes</maml:name> <maml:description> <maml:para>Sum of mapped usage of volumes in the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicate whether the space usage attributes of folder are valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>inherited_vol_perfpol_id</maml:name> <maml:description> <maml:para>Identifier of the default performance policy for a newly created volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>inherited_vol_perfpol_name</maml:name> <maml:description> <maml:para>Name of the default performance policy for a newly created volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>unused_reserve_bytes</maml:name> <maml:description> <maml:para>Unused reserve of volumes in the folder in bytes. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>unused_snap_reserve_bytes</maml:name> <maml:description> <maml:para>Unused reserve of snapshots of volumes in the folder in bytes. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of volumes in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>uncompressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of volumes in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>uncompressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_compression_ratio</maml:name> <maml:description> <maml:para>Compression ratio of volumes in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_compression_ratio</maml:name> <maml:description> <maml:para>Compression ratio of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compression_ratio</maml:name> <maml:description> <maml:para>Compression savings for the folder expressed as ratio. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this folder was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this folder was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Number of snapshots inside the folder. This attribute is deprecated and has no meaningful value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_snapcolls</maml:name> <maml:description> <maml:para>Number of snapshot collections inside the folder. This attribute is deprecated and has no meaningful value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes contained by the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>appserver_id</maml:name> <maml:description> <maml:para>Identifier of the application server associated with the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>appserver_name</maml:name> <maml:description> <maml:para>Name of the application server associated with the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folset_id</maml:name> <maml:description> <maml:para>Identifier of the folder set associated with the folder. Only VVol folder can be associated with the folder set. The folder and the containing folder set must be associated with the same application server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folset_name</maml:name> <maml:description> <maml:para>Name of the folder set associated with the folder. Only VVol folder can be associated with the folder set. The folder and the containing folder set must be associated with the same application server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_iops</maml:name> <maml:description> <maml:para>IOPS limit for this folder. If limit_iops is not specified when a folder is created, or if limit_iops is set to -1, then the folder has no IOPS limit. IOPS limit should be in range [256, 4294967294] or -1 for unlimited.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_mbps</maml:name> <maml:description> <maml:para>Throughput limit for this folder in MB/s. If limit_mbps is not specified when a folder is created, or if limit_mbps is set to -1, then the folder has no throughput limit. MBPS limit should be in range [1, 4294967294] or -1 for unlimited.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Access protocol of the folder. This attribute is used by the VASA Provider to determine the access protocol of the bind request. If not specified in the creation request, it will be the access protocol supported by the group. If the group supports multiple protocols, the default will be Fibre Channel. This field is meaningful only to VVol folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Tenant ID of the folder. This is used to determine what tenant context the folder belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>fqn</maml:name> <maml:description> <maml:para>Fully qualified name of folder in the pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of folder in the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of folder used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool where the folder resides.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>ID of the pool where the folder resides.</maml:para> </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="true (ByValue)" position="named"> <maml:name>limit_bytes_specified</maml:name> <maml:description> <maml:para>Indicates whether the folder has a limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>limit_bytes</maml:name> <maml:description> <maml:para>Folder limit size in bytes. By default, a folder (except SMIS and VVol types) does not have a limit. If limit_bytes is not specified when a folder is created, or if limit_bytes is set to the largest possible 64-bit signed integer (9223372036854775807), then the folder has no limit. Otherwise, a limit smaller than the capacity of the pool can be set. On output, if the folder has a limit, the limit_bytes_specified attribute will be true and limit_bytes will be the limit. If the folder does not have a limit, the limit_bytes_specified attribute will be false and limit_bytes will be interpreted based on the value of the usage_valid attribute. If the usage_valid attribute is true, limits_byte will be the capacity of the pool. Otherwise, limits_bytes is not meaningful and can be null. SMIS and VVol folders require a size limit. This attribute is superseded by limit_size_bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>limit_size_bytes</maml:name> <maml:description> <maml:para>Folder size limit in bytes. If limit_size_bytes is not specified when a folder is created, or if limit_size_bytes is set to -1, then the folder has no limit. Otherwise, a limit smaller than the capacity of the pool can be set. Folders with an agent_type of 'smis' or 'vvol' must have a size limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>provisioned_limit_size_bytes</maml:name> <maml:description> <maml:para>Limit on the provisioned size of volumes in a folder. If provisioned_limit_size_bytes is not specified when a folder is created, or if provisioned_limit_size_bytes is set to -1, then the folder has no provisioned size limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>overdraft_limit_pct</maml:name> <maml:description> <maml:para>Amount of space to consider as overdraft range for this folder as a percentage of folder used limit. Valid values are from 0% - 200%. This is the limit above the folder usage limit beyond which enforcement action(volume offline/non-writable) is issued.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>capacity_bytes</maml:name> <maml:description> <maml:para>Capacity of the folder in bytes. If the folder's size has a usage limit, capacity_bytes will be the folder's usage limit. If the folder's size does not have a usage limit, capacity_bytes will be the pool's capacity. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>free_space_bytes</maml:name> <maml:description> <maml:para>Free space in the folder in bytes. If the folder has a usage limit, free_space_bytes will be the folder's free space (the folder's usage limit minus the folder's space usage). If the folder does not have a usage limit, free_space_bytes will be the pool's free space. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>provisioned_bytes</maml:name> <maml:description> <maml:para>Sum of provisioned size of volumes in the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage_bytes</maml:name> <maml:description> <maml:para>Sum of mapped usage and snapshot uncompressed usage of volumes in the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_mapped_bytes</maml:name> <maml:description> <maml:para>Sum of mapped usage of volumes in the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicate whether the space usage attributes of folder are valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>inherited_vol_perfpol_id</maml:name> <maml:description> <maml:para>Identifier of the default performance policy for a newly created volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>inherited_vol_perfpol_name</maml:name> <maml:description> <maml:para>Name of the default performance policy for a newly created volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>unused_reserve_bytes</maml:name> <maml:description> <maml:para>Unused reserve of volumes in the folder in bytes. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>unused_snap_reserve_bytes</maml:name> <maml:description> <maml:para>Unused reserve of snapshots of volumes in the folder in bytes. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of volumes in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>uncompressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of volumes in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>uncompressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_compression_ratio</maml:name> <maml:description> <maml:para>Compression ratio of volumes in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_compression_ratio</maml:name> <maml:description> <maml:para>Compression ratio of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compression_ratio</maml:name> <maml:description> <maml:para>Compression savings for the folder expressed as ratio. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this folder was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this folder was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Number of snapshots inside the folder. This attribute is deprecated and has no meaningful value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_snapcolls</maml:name> <maml:description> <maml:para>Number of snapshot collections inside the folder. This attribute is deprecated and has no meaningful value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of the folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes contained by the folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>appserver_id</maml:name> <maml:description> <maml:para>Identifier of the application server associated with the folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>appserver_name</maml:name> <maml:description> <maml:para>Name of the application server associated with the folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>folset_id</maml:name> <maml:description> <maml:para>Identifier of the folder set associated with the folder. Only VVol folder can be associated with the folder set. The folder and the containing folder set must be associated with the same application server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>folset_name</maml:name> <maml:description> <maml:para>Name of the folder set associated with the folder. Only VVol folder can be associated with the folder set. The folder and the containing folder set must be associated with the same application server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>limit_iops</maml:name> <maml:description> <maml:para>IOPS limit for this folder. If limit_iops is not specified when a folder is created, or if limit_iops is set to -1, then the folder has no IOPS limit. IOPS limit should be in range [256, 4294967294] or -1 for unlimited.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>limit_mbps</maml:name> <maml:description> <maml:para>Throughput limit for this folder in MB/s. If limit_mbps is not specified when a folder is created, or if limit_mbps is set to -1, then the folder has no throughput limit. MBPS limit should be in range [1, 4294967294] or -1 for unlimited.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Access protocol of the folder. This attribute is used by the VASA Provider to determine the access protocol of the bind request. If not specified in the creation request, it will be the access protocol supported by the group. If the group supports multiple protocols, the default will be Fibre Channel. This field is meaningful only to VVol folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Tenant ID of the folder. This is used to determine what tenant context the folder belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> New-NSFolder -name Testfolder-937 -description "Test Folder" -pool_id 0a28eada7f8dd99d3b000000000000000000000001 name id full_name agent_type limit_bytes appserver_name description ---- -- --------- ---------- ----------- -------------- ----------- Testfolder-937 2f28eada7f8dd99d3b0000000000000000000000c3 default:/Testfolder-937 none 23478977434 test folder </dev:code> <dev:remarks> <maml:para>This command create a new folder in the specified pool. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 2 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> New-NSFolder -name Testfolder-478453 -pool_id 0a28eada7f8dd99d3b000000000000000000000001 -agent_type smis -limit_size_bytes 102400 name id full_name agent_type limit_bytes appserver_name description ---- -- --------- ---------- ----------- -------------- ----------- Testfolder-478453 2f28eada7f8dd99d3b0000000000000000000000c4 default:/Testfolder-478453 smis 102400 </dev:code> <dev:remarks> <maml:para>This command create a new folder in the specified pool for exclusive use as an SMI-S Target folder. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSFolder</command:name> <maml:description> <maml:para>List a set of folders.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSFolder</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List a set of folders.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fqn</maml:name> <maml:description> <maml:para>Fully qualified name of folder in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of folder in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of folder used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool where the folder resides.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>ID of the pool where the folder resides.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_bytes_specified</maml:name> <maml:description> <maml:para>Indicates whether the folder has a limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_bytes</maml:name> <maml:description> <maml:para>Folder limit size in bytes. By default, a folder (except SMIS and VVol types) does not have a limit. If limit_bytes is not specified when a folder is created, or if limit_bytes is set to the largest possible 64-bit signed integer (9223372036854775807), then the folder has no limit. Otherwise, a limit smaller than the capacity of the pool can be set. On output, if the folder has a limit, the limit_bytes_specified attribute will be true and limit_bytes will be the limit. If the folder does not have a limit, the limit_bytes_specified attribute will be false and limit_bytes will be interpreted based on the value of the usage_valid attribute. If the usage_valid attribute is true, limits_byte will be the capacity of the pool. Otherwise, limits_bytes is not meaningful and can be null. SMIS and VVol folders require a size limit. This attribute is superseded by limit_size_bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_size_bytes</maml:name> <maml:description> <maml:para>Folder size limit in bytes. If limit_size_bytes is not specified when a folder is created, or if limit_size_bytes is set to -1, then the folder has no limit. Otherwise, a limit smaller than the capacity of the pool can be set. Folders with an agent_type of 'smis' or 'vvol' must have a size limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>provisioned_limit_size_bytes</maml:name> <maml:description> <maml:para>Limit on the provisioned size of volumes in a folder. If provisioned_limit_size_bytes is not specified when a folder is created, or if provisioned_limit_size_bytes is set to -1, then the folder has no provisioned size limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>overdraft_limit_pct</maml:name> <maml:description> <maml:para>Amount of space to consider as overdraft range for this folder as a percentage of folder used limit. Valid values are from 0% - 200%. This is the limit above the folder usage limit beyond which enforcement action(volume offline/non-writable) is issued.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>capacity_bytes</maml:name> <maml:description> <maml:para>Capacity of the folder in bytes. If the folder's size has a usage limit, capacity_bytes will be the folder's usage limit. If the folder's size does not have a usage limit, capacity_bytes will be the pool's capacity. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>free_space_bytes</maml:name> <maml:description> <maml:para>Free space in the folder in bytes. If the folder has a usage limit, free_space_bytes will be the folder's free space (the folder's usage limit minus the folder's space usage). If the folder does not have a usage limit, free_space_bytes will be the pool's free space. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>provisioned_bytes</maml:name> <maml:description> <maml:para>Sum of provisioned size of volumes in the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage_bytes</maml:name> <maml:description> <maml:para>Sum of mapped usage and snapshot uncompressed usage of volumes in the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_mapped_bytes</maml:name> <maml:description> <maml:para>Sum of mapped usage of volumes in the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicate whether the space usage attributes of folder are valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>inherited_vol_perfpol_id</maml:name> <maml:description> <maml:para>Identifier of the default performance policy for a newly created volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>inherited_vol_perfpol_name</maml:name> <maml:description> <maml:para>Name of the default performance policy for a newly created volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>unused_reserve_bytes</maml:name> <maml:description> <maml:para>Unused reserve of volumes in the folder in bytes. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>unused_snap_reserve_bytes</maml:name> <maml:description> <maml:para>Unused reserve of snapshots of volumes in the folder in bytes. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of volumes in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>uncompressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of volumes in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>uncompressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_compression_ratio</maml:name> <maml:description> <maml:para>Compression ratio of volumes in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_compression_ratio</maml:name> <maml:description> <maml:para>Compression ratio of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compression_ratio</maml:name> <maml:description> <maml:para>Compression savings for the folder expressed as ratio. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this folder was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this folder was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Number of snapshots inside the folder. This attribute is deprecated and has no meaningful value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_snapcolls</maml:name> <maml:description> <maml:para>Number of snapshot collections inside the folder. This attribute is deprecated and has no meaningful value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes contained by the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>appserver_id</maml:name> <maml:description> <maml:para>Identifier of the application server associated with the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>appserver_name</maml:name> <maml:description> <maml:para>Name of the application server associated with the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folset_id</maml:name> <maml:description> <maml:para>Identifier of the folder set associated with the folder. Only VVol folder can be associated with the folder set. The folder and the containing folder set must be associated with the same application server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folset_name</maml:name> <maml:description> <maml:para>Name of the folder set associated with the folder. Only VVol folder can be associated with the folder set. The folder and the containing folder set must be associated with the same application server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_iops</maml:name> <maml:description> <maml:para>IOPS limit for this folder. If limit_iops is not specified when a folder is created, or if limit_iops is set to -1, then the folder has no IOPS limit. IOPS limit should be in range [256, 4294967294] or -1 for unlimited.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_mbps</maml:name> <maml:description> <maml:para>Throughput limit for this folder in MB/s. If limit_mbps is not specified when a folder is created, or if limit_mbps is set to -1, then the folder has no throughput limit. MBPS limit should be in range [1, 4294967294] or -1 for unlimited.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Access protocol of the folder. This attribute is used by the VASA Provider to determine the access protocol of the bind request. If not specified in the creation request, it will be the access protocol supported by the group. If the group supports multiple protocols, the default will be Fibre Channel. This field is meaningful only to VVol folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Tenant ID of the folder. This is used to determine what tenant context the folder belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>fqn</maml:name> <maml:description> <maml:para>Fully qualified name of folder in the pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of folder in the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of folder used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool where the folder resides.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>ID of the pool where the folder resides.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>limit_bytes_specified</maml:name> <maml:description> <maml:para>Indicates whether the folder has a limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>limit_bytes</maml:name> <maml:description> <maml:para>Folder limit size in bytes. By default, a folder (except SMIS and VVol types) does not have a limit. If limit_bytes is not specified when a folder is created, or if limit_bytes is set to the largest possible 64-bit signed integer (9223372036854775807), then the folder has no limit. Otherwise, a limit smaller than the capacity of the pool can be set. On output, if the folder has a limit, the limit_bytes_specified attribute will be true and limit_bytes will be the limit. If the folder does not have a limit, the limit_bytes_specified attribute will be false and limit_bytes will be interpreted based on the value of the usage_valid attribute. If the usage_valid attribute is true, limits_byte will be the capacity of the pool. Otherwise, limits_bytes is not meaningful and can be null. SMIS and VVol folders require a size limit. This attribute is superseded by limit_size_bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>limit_size_bytes</maml:name> <maml:description> <maml:para>Folder size limit in bytes. If limit_size_bytes is not specified when a folder is created, or if limit_size_bytes is set to -1, then the folder has no limit. Otherwise, a limit smaller than the capacity of the pool can be set. Folders with an agent_type of 'smis' or 'vvol' must have a size limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>provisioned_limit_size_bytes</maml:name> <maml:description> <maml:para>Limit on the provisioned size of volumes in a folder. If provisioned_limit_size_bytes is not specified when a folder is created, or if provisioned_limit_size_bytes is set to -1, then the folder has no provisioned size limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>overdraft_limit_pct</maml:name> <maml:description> <maml:para>Amount of space to consider as overdraft range for this folder as a percentage of folder used limit. Valid values are from 0% - 200%. This is the limit above the folder usage limit beyond which enforcement action(volume offline/non-writable) is issued.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>capacity_bytes</maml:name> <maml:description> <maml:para>Capacity of the folder in bytes. If the folder's size has a usage limit, capacity_bytes will be the folder's usage limit. If the folder's size does not have a usage limit, capacity_bytes will be the pool's capacity. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>free_space_bytes</maml:name> <maml:description> <maml:para>Free space in the folder in bytes. If the folder has a usage limit, free_space_bytes will be the folder's free space (the folder's usage limit minus the folder's space usage). If the folder does not have a usage limit, free_space_bytes will be the pool's free space. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>provisioned_bytes</maml:name> <maml:description> <maml:para>Sum of provisioned size of volumes in the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage_bytes</maml:name> <maml:description> <maml:para>Sum of mapped usage and snapshot uncompressed usage of volumes in the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_mapped_bytes</maml:name> <maml:description> <maml:para>Sum of mapped usage of volumes in the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicate whether the space usage attributes of folder are valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>inherited_vol_perfpol_id</maml:name> <maml:description> <maml:para>Identifier of the default performance policy for a newly created volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>inherited_vol_perfpol_name</maml:name> <maml:description> <maml:para>Name of the default performance policy for a newly created volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>unused_reserve_bytes</maml:name> <maml:description> <maml:para>Unused reserve of volumes in the folder in bytes. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>unused_snap_reserve_bytes</maml:name> <maml:description> <maml:para>Unused reserve of snapshots of volumes in the folder in bytes. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of volumes in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>uncompressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of volumes in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>uncompressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_compression_ratio</maml:name> <maml:description> <maml:para>Compression ratio of volumes in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_compression_ratio</maml:name> <maml:description> <maml:para>Compression ratio of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compression_ratio</maml:name> <maml:description> <maml:para>Compression savings for the folder expressed as ratio. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this folder was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this folder was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Number of snapshots inside the folder. This attribute is deprecated and has no meaningful value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_snapcolls</maml:name> <maml:description> <maml:para>Number of snapshot collections inside the folder. This attribute is deprecated and has no meaningful value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of the folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes contained by the folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>appserver_id</maml:name> <maml:description> <maml:para>Identifier of the application server associated with the folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>appserver_name</maml:name> <maml:description> <maml:para>Name of the application server associated with the folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>folset_id</maml:name> <maml:description> <maml:para>Identifier of the folder set associated with the folder. Only VVol folder can be associated with the folder set. The folder and the containing folder set must be associated with the same application server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>folset_name</maml:name> <maml:description> <maml:para>Name of the folder set associated with the folder. Only VVol folder can be associated with the folder set. The folder and the containing folder set must be associated with the same application server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>limit_iops</maml:name> <maml:description> <maml:para>IOPS limit for this folder. If limit_iops is not specified when a folder is created, or if limit_iops is set to -1, then the folder has no IOPS limit. IOPS limit should be in range [256, 4294967294] or -1 for unlimited.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>limit_mbps</maml:name> <maml:description> <maml:para>Throughput limit for this folder in MB/s. If limit_mbps is not specified when a folder is created, or if limit_mbps is set to -1, then the folder has no throughput limit. MBPS limit should be in range [1, 4294967294] or -1 for unlimited.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Access protocol of the folder. This attribute is used by the VASA Provider to determine the access protocol of the bind request. If not specified in the creation request, it will be the access protocol supported by the group. If the group supports multiple protocols, the default will be Fibre Channel. This field is meaningful only to VVol folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Tenant ID of the folder. This is used to determine what tenant context the folder belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSFolder name id full_name agent_type limit_bytes appserver_name description ---- -- --------- ---------- ----------- -------------- ----------- Testfolder-461372 2f28eada7f8dd99d3b00000000000000000000004e default:/Testfolder-461372 smis 102400 Testfolder-551725 2f28eada7f8dd99d3b000000000000000000000049 default:/Testfolder-551725 smis 102400 Testfolder-959 2f28eada7f8dd99d3b000000000000000000000044 default:/Testfolder-959 smis 102400 Testfolder-811415 2f28eada7f8dd99d3b000000000000000000000062 default:/Testfolder-811415 smis 102400 Testfolder-799 2f28eada7f8dd99d3b000000000000000000000039 default:/Testfolder-799 smis 102400 </dev:code> <dev:remarks> <maml:para>This command will retrieve the Folders from the array. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 2 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSFolder -name Testfolder-576 name id full_name agent_type limit_bytes appserver_name description ---- -- --------- ---------- ----------- -------------- ----------- Testfolder-576 2f28eada7f8dd99d3b0000000000000000000000c2 default:/Testfolder-576 none 23478977434 test folder </dev:code> <dev:remarks> <maml:para>This command will retrieve only the folder that matches the folder named. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSFolder</command:name> <maml:description> <maml:para>Modify attributes of specified folder.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSFolder</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Modify attributes of specified folder.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fqn</maml:name> <maml:description> <maml:para>Fully qualified name of folder in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of folder in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of folder used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool where the folder resides.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>ID of the pool where the folder resides.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_bytes_specified</maml:name> <maml:description> <maml:para>Indicates whether the folder has a limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_bytes</maml:name> <maml:description> <maml:para>Folder limit size in bytes. By default, a folder (except SMIS and VVol types) does not have a limit. If limit_bytes is not specified when a folder is created, or if limit_bytes is set to the largest possible 64-bit signed integer (9223372036854775807), then the folder has no limit. Otherwise, a limit smaller than the capacity of the pool can be set. On output, if the folder has a limit, the limit_bytes_specified attribute will be true and limit_bytes will be the limit. If the folder does not have a limit, the limit_bytes_specified attribute will be false and limit_bytes will be interpreted based on the value of the usage_valid attribute. If the usage_valid attribute is true, limits_byte will be the capacity of the pool. Otherwise, limits_bytes is not meaningful and can be null. SMIS and VVol folders require a size limit. This attribute is superseded by limit_size_bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_size_bytes</maml:name> <maml:description> <maml:para>Folder size limit in bytes. If limit_size_bytes is not specified when a folder is created, or if limit_size_bytes is set to -1, then the folder has no limit. Otherwise, a limit smaller than the capacity of the pool can be set. Folders with an agent_type of 'smis' or 'vvol' must have a size limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>provisioned_limit_size_bytes</maml:name> <maml:description> <maml:para>Limit on the provisioned size of volumes in a folder. If provisioned_limit_size_bytes is not specified when a folder is created, or if provisioned_limit_size_bytes is set to -1, then the folder has no provisioned size limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>overdraft_limit_pct</maml:name> <maml:description> <maml:para>Amount of space to consider as overdraft range for this folder as a percentage of folder used limit. Valid values are from 0% - 200%. This is the limit above the folder usage limit beyond which enforcement action(volume offline/non-writable) is issued.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>capacity_bytes</maml:name> <maml:description> <maml:para>Capacity of the folder in bytes. If the folder's size has a usage limit, capacity_bytes will be the folder's usage limit. If the folder's size does not have a usage limit, capacity_bytes will be the pool's capacity. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>free_space_bytes</maml:name> <maml:description> <maml:para>Free space in the folder in bytes. If the folder has a usage limit, free_space_bytes will be the folder's free space (the folder's usage limit minus the folder's space usage). If the folder does not have a usage limit, free_space_bytes will be the pool's free space. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>provisioned_bytes</maml:name> <maml:description> <maml:para>Sum of provisioned size of volumes in the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage_bytes</maml:name> <maml:description> <maml:para>Sum of mapped usage and snapshot uncompressed usage of volumes in the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_mapped_bytes</maml:name> <maml:description> <maml:para>Sum of mapped usage of volumes in the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicate whether the space usage attributes of folder are valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>inherited_vol_perfpol_id</maml:name> <maml:description> <maml:para>Identifier of the default performance policy for a newly created volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>inherited_vol_perfpol_name</maml:name> <maml:description> <maml:para>Name of the default performance policy for a newly created volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>unused_reserve_bytes</maml:name> <maml:description> <maml:para>Unused reserve of volumes in the folder in bytes. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>unused_snap_reserve_bytes</maml:name> <maml:description> <maml:para>Unused reserve of snapshots of volumes in the folder in bytes. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of volumes in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>uncompressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of volumes in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>uncompressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_compression_ratio</maml:name> <maml:description> <maml:para>Compression ratio of volumes in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_compression_ratio</maml:name> <maml:description> <maml:para>Compression ratio of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compression_ratio</maml:name> <maml:description> <maml:para>Compression savings for the folder expressed as ratio. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this folder was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this folder was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Number of snapshots inside the folder. This attribute is deprecated and has no meaningful value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_snapcolls</maml:name> <maml:description> <maml:para>Number of snapshot collections inside the folder. This attribute is deprecated and has no meaningful value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes contained by the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>appserver_id</maml:name> <maml:description> <maml:para>Identifier of the application server associated with the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>appserver_name</maml:name> <maml:description> <maml:para>Name of the application server associated with the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folset_id</maml:name> <maml:description> <maml:para>Identifier of the folder set associated with the folder. Only VVol folder can be associated with the folder set. The folder and the containing folder set must be associated with the same application server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folset_name</maml:name> <maml:description> <maml:para>Name of the folder set associated with the folder. Only VVol folder can be associated with the folder set. The folder and the containing folder set must be associated with the same application server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_iops</maml:name> <maml:description> <maml:para>IOPS limit for this folder. If limit_iops is not specified when a folder is created, or if limit_iops is set to -1, then the folder has no IOPS limit. IOPS limit should be in range [256, 4294967294] or -1 for unlimited.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_mbps</maml:name> <maml:description> <maml:para>Throughput limit for this folder in MB/s. If limit_mbps is not specified when a folder is created, or if limit_mbps is set to -1, then the folder has no throughput limit. MBPS limit should be in range [1, 4294967294] or -1 for unlimited.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Access protocol of the folder. This attribute is used by the VASA Provider to determine the access protocol of the bind request. If not specified in the creation request, it will be the access protocol supported by the group. If the group supports multiple protocols, the default will be Fibre Channel. This field is meaningful only to VVol folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Tenant ID of the folder. This is used to determine what tenant context the folder belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>fqn</maml:name> <maml:description> <maml:para>Fully qualified name of folder in the pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of folder in the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of folder used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool where the folder resides.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>ID of the pool where the folder resides.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>limit_bytes_specified</maml:name> <maml:description> <maml:para>Indicates whether the folder has a limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>limit_bytes</maml:name> <maml:description> <maml:para>Folder limit size in bytes. By default, a folder (except SMIS and VVol types) does not have a limit. If limit_bytes is not specified when a folder is created, or if limit_bytes is set to the largest possible 64-bit signed integer (9223372036854775807), then the folder has no limit. Otherwise, a limit smaller than the capacity of the pool can be set. On output, if the folder has a limit, the limit_bytes_specified attribute will be true and limit_bytes will be the limit. If the folder does not have a limit, the limit_bytes_specified attribute will be false and limit_bytes will be interpreted based on the value of the usage_valid attribute. If the usage_valid attribute is true, limits_byte will be the capacity of the pool. Otherwise, limits_bytes is not meaningful and can be null. SMIS and VVol folders require a size limit. This attribute is superseded by limit_size_bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>limit_size_bytes</maml:name> <maml:description> <maml:para>Folder size limit in bytes. If limit_size_bytes is not specified when a folder is created, or if limit_size_bytes is set to -1, then the folder has no limit. Otherwise, a limit smaller than the capacity of the pool can be set. Folders with an agent_type of 'smis' or 'vvol' must have a size limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>provisioned_limit_size_bytes</maml:name> <maml:description> <maml:para>Limit on the provisioned size of volumes in a folder. If provisioned_limit_size_bytes is not specified when a folder is created, or if provisioned_limit_size_bytes is set to -1, then the folder has no provisioned size limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>overdraft_limit_pct</maml:name> <maml:description> <maml:para>Amount of space to consider as overdraft range for this folder as a percentage of folder used limit. Valid values are from 0% - 200%. This is the limit above the folder usage limit beyond which enforcement action(volume offline/non-writable) is issued.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>capacity_bytes</maml:name> <maml:description> <maml:para>Capacity of the folder in bytes. If the folder's size has a usage limit, capacity_bytes will be the folder's usage limit. If the folder's size does not have a usage limit, capacity_bytes will be the pool's capacity. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>free_space_bytes</maml:name> <maml:description> <maml:para>Free space in the folder in bytes. If the folder has a usage limit, free_space_bytes will be the folder's free space (the folder's usage limit minus the folder's space usage). If the folder does not have a usage limit, free_space_bytes will be the pool's free space. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>provisioned_bytes</maml:name> <maml:description> <maml:para>Sum of provisioned size of volumes in the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage_bytes</maml:name> <maml:description> <maml:para>Sum of mapped usage and snapshot uncompressed usage of volumes in the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_mapped_bytes</maml:name> <maml:description> <maml:para>Sum of mapped usage of volumes in the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicate whether the space usage attributes of folder are valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>inherited_vol_perfpol_id</maml:name> <maml:description> <maml:para>Identifier of the default performance policy for a newly created volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>inherited_vol_perfpol_name</maml:name> <maml:description> <maml:para>Name of the default performance policy for a newly created volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>unused_reserve_bytes</maml:name> <maml:description> <maml:para>Unused reserve of volumes in the folder in bytes. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>unused_snap_reserve_bytes</maml:name> <maml:description> <maml:para>Unused reserve of snapshots of volumes in the folder in bytes. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of volumes in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>uncompressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of volumes in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>uncompressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_compression_ratio</maml:name> <maml:description> <maml:para>Compression ratio of volumes in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_compression_ratio</maml:name> <maml:description> <maml:para>Compression ratio of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compression_ratio</maml:name> <maml:description> <maml:para>Compression savings for the folder expressed as ratio. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this folder was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this folder was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Number of snapshots inside the folder. This attribute is deprecated and has no meaningful value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_snapcolls</maml:name> <maml:description> <maml:para>Number of snapshot collections inside the folder. This attribute is deprecated and has no meaningful value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of the folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes contained by the folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>appserver_id</maml:name> <maml:description> <maml:para>Identifier of the application server associated with the folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>appserver_name</maml:name> <maml:description> <maml:para>Name of the application server associated with the folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>folset_id</maml:name> <maml:description> <maml:para>Identifier of the folder set associated with the folder. Only VVol folder can be associated with the folder set. The folder and the containing folder set must be associated with the same application server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>folset_name</maml:name> <maml:description> <maml:para>Name of the folder set associated with the folder. Only VVol folder can be associated with the folder set. The folder and the containing folder set must be associated with the same application server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>limit_iops</maml:name> <maml:description> <maml:para>IOPS limit for this folder. If limit_iops is not specified when a folder is created, or if limit_iops is set to -1, then the folder has no IOPS limit. IOPS limit should be in range [256, 4294967294] or -1 for unlimited.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>limit_mbps</maml:name> <maml:description> <maml:para>Throughput limit for this folder in MB/s. If limit_mbps is not specified when a folder is created, or if limit_mbps is set to -1, then the folder has no throughput limit. MBPS limit should be in range [1, 4294967294] or -1 for unlimited.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Access protocol of the folder. This attribute is used by the VASA Provider to determine the access protocol of the bind request. If not specified in the creation request, it will be the access protocol supported by the group. If the group supports multiple protocols, the default will be Fibre Channel. This field is meaningful only to VVol folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Tenant ID of the folder. This is used to determine what tenant context the folder belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Set-NSFolder -id 2f28eada7f8dd99d3b0000000000000000000000c5 -description "New Test Description" name id full_name agent_type limit_bytes appserver_name description ---- -- --------- ---------- ----------- -------------- ----------- Testfolder-579 2f28eada7f8dd99d3b0000000000000000000000c5 default:/Testfolder-579 none 23478977434 New Test Description </dev:code> <dev:remarks> <maml:para>This command will modify a setting on the folder specified by ID. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSFolder</command:name> <maml:description> <maml:para>Delete specified folder.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSFolder</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Delete specified folder.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fqn</maml:name> <maml:description> <maml:para>Fully qualified name of folder in the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of folder in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of folder used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool where the folder resides.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>ID of the pool where the folder resides.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_bytes_specified</maml:name> <maml:description> <maml:para>Indicates whether the folder has a limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_bytes</maml:name> <maml:description> <maml:para>Folder limit size in bytes. By default, a folder (except SMIS and VVol types) does not have a limit. If limit_bytes is not specified when a folder is created, or if limit_bytes is set to the largest possible 64-bit signed integer (9223372036854775807), then the folder has no limit. Otherwise, a limit smaller than the capacity of the pool can be set. On output, if the folder has a limit, the limit_bytes_specified attribute will be true and limit_bytes will be the limit. If the folder does not have a limit, the limit_bytes_specified attribute will be false and limit_bytes will be interpreted based on the value of the usage_valid attribute. If the usage_valid attribute is true, limits_byte will be the capacity of the pool. Otherwise, limits_bytes is not meaningful and can be null. SMIS and VVol folders require a size limit. This attribute is superseded by limit_size_bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_size_bytes</maml:name> <maml:description> <maml:para>Folder size limit in bytes. If limit_size_bytes is not specified when a folder is created, or if limit_size_bytes is set to -1, then the folder has no limit. Otherwise, a limit smaller than the capacity of the pool can be set. Folders with an agent_type of 'smis' or 'vvol' must have a size limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>provisioned_limit_size_bytes</maml:name> <maml:description> <maml:para>Limit on the provisioned size of volumes in a folder. If provisioned_limit_size_bytes is not specified when a folder is created, or if provisioned_limit_size_bytes is set to -1, then the folder has no provisioned size limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>overdraft_limit_pct</maml:name> <maml:description> <maml:para>Amount of space to consider as overdraft range for this folder as a percentage of folder used limit. Valid values are from 0% - 200%. This is the limit above the folder usage limit beyond which enforcement action(volume offline/non-writable) is issued.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>capacity_bytes</maml:name> <maml:description> <maml:para>Capacity of the folder in bytes. If the folder's size has a usage limit, capacity_bytes will be the folder's usage limit. If the folder's size does not have a usage limit, capacity_bytes will be the pool's capacity. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>free_space_bytes</maml:name> <maml:description> <maml:para>Free space in the folder in bytes. If the folder has a usage limit, free_space_bytes will be the folder's free space (the folder's usage limit minus the folder's space usage). If the folder does not have a usage limit, free_space_bytes will be the pool's free space. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>provisioned_bytes</maml:name> <maml:description> <maml:para>Sum of provisioned size of volumes in the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage_bytes</maml:name> <maml:description> <maml:para>Sum of mapped usage and snapshot uncompressed usage of volumes in the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_mapped_bytes</maml:name> <maml:description> <maml:para>Sum of mapped usage of volumes in the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicate whether the space usage attributes of folder are valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>inherited_vol_perfpol_id</maml:name> <maml:description> <maml:para>Identifier of the default performance policy for a newly created volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>inherited_vol_perfpol_name</maml:name> <maml:description> <maml:para>Name of the default performance policy for a newly created volume.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>unused_reserve_bytes</maml:name> <maml:description> <maml:para>Unused reserve of volumes in the folder in bytes. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>unused_snap_reserve_bytes</maml:name> <maml:description> <maml:para>Unused reserve of snapshots of volumes in the folder in bytes. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of volumes in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>uncompressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of volumes in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>uncompressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_compression_ratio</maml:name> <maml:description> <maml:para>Compression ratio of volumes in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_compression_ratio</maml:name> <maml:description> <maml:para>Compression ratio of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>compression_ratio</maml:name> <maml:description> <maml:para>Compression savings for the folder expressed as ratio. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this folder was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this folder was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Number of snapshots inside the folder. This attribute is deprecated and has no meaningful value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_snapcolls</maml:name> <maml:description> <maml:para>Number of snapshot collections inside the folder. This attribute is deprecated and has no meaningful value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes contained by the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>appserver_id</maml:name> <maml:description> <maml:para>Identifier of the application server associated with the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>appserver_name</maml:name> <maml:description> <maml:para>Name of the application server associated with the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folset_id</maml:name> <maml:description> <maml:para>Identifier of the folder set associated with the folder. Only VVol folder can be associated with the folder set. The folder and the containing folder set must be associated with the same application server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>folset_name</maml:name> <maml:description> <maml:para>Name of the folder set associated with the folder. Only VVol folder can be associated with the folder set. The folder and the containing folder set must be associated with the same application server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_iops</maml:name> <maml:description> <maml:para>IOPS limit for this folder. If limit_iops is not specified when a folder is created, or if limit_iops is set to -1, then the folder has no IOPS limit. IOPS limit should be in range [256, 4294967294] or -1 for unlimited.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>limit_mbps</maml:name> <maml:description> <maml:para>Throughput limit for this folder in MB/s. If limit_mbps is not specified when a folder is created, or if limit_mbps is set to -1, then the folder has no throughput limit. MBPS limit should be in range [1, 4294967294] or -1 for unlimited.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Access protocol of the folder. This attribute is used by the VASA Provider to determine the access protocol of the bind request. If not specified in the creation request, it will be the access protocol supported by the group. If the group supports multiple protocols, the default will be Fibre Channel. This field is meaningful only to VVol folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSFolder</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Tenant ID of the folder. This is used to determine what tenant context the folder belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>fqn</maml:name> <maml:description> <maml:para>Fully qualified name of folder in the pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of folder in the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of folder used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Text description of folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of the pool where the folder resides.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>ID of the pool where the folder resides.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>limit_bytes_specified</maml:name> <maml:description> <maml:para>Indicates whether the folder has a limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>limit_bytes</maml:name> <maml:description> <maml:para>Folder limit size in bytes. By default, a folder (except SMIS and VVol types) does not have a limit. If limit_bytes is not specified when a folder is created, or if limit_bytes is set to the largest possible 64-bit signed integer (9223372036854775807), then the folder has no limit. Otherwise, a limit smaller than the capacity of the pool can be set. On output, if the folder has a limit, the limit_bytes_specified attribute will be true and limit_bytes will be the limit. If the folder does not have a limit, the limit_bytes_specified attribute will be false and limit_bytes will be interpreted based on the value of the usage_valid attribute. If the usage_valid attribute is true, limits_byte will be the capacity of the pool. Otherwise, limits_bytes is not meaningful and can be null. SMIS and VVol folders require a size limit. This attribute is superseded by limit_size_bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>limit_size_bytes</maml:name> <maml:description> <maml:para>Folder size limit in bytes. If limit_size_bytes is not specified when a folder is created, or if limit_size_bytes is set to -1, then the folder has no limit. Otherwise, a limit smaller than the capacity of the pool can be set. Folders with an agent_type of 'smis' or 'vvol' must have a size limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>provisioned_limit_size_bytes</maml:name> <maml:description> <maml:para>Limit on the provisioned size of volumes in a folder. If provisioned_limit_size_bytes is not specified when a folder is created, or if provisioned_limit_size_bytes is set to -1, then the folder has no provisioned size limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>overdraft_limit_pct</maml:name> <maml:description> <maml:para>Amount of space to consider as overdraft range for this folder as a percentage of folder used limit. Valid values are from 0% - 200%. This is the limit above the folder usage limit beyond which enforcement action(volume offline/non-writable) is issued.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>capacity_bytes</maml:name> <maml:description> <maml:para>Capacity of the folder in bytes. If the folder's size has a usage limit, capacity_bytes will be the folder's usage limit. If the folder's size does not have a usage limit, capacity_bytes will be the pool's capacity. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>free_space_bytes</maml:name> <maml:description> <maml:para>Free space in the folder in bytes. If the folder has a usage limit, free_space_bytes will be the folder's free space (the folder's usage limit minus the folder's space usage). If the folder does not have a usage limit, free_space_bytes will be the pool's free space. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>provisioned_bytes</maml:name> <maml:description> <maml:para>Sum of provisioned size of volumes in the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage_bytes</maml:name> <maml:description> <maml:para>Sum of mapped usage and snapshot uncompressed usage of volumes in the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>volume_mapped_bytes</maml:name> <maml:description> <maml:para>Sum of mapped usage of volumes in the folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicate whether the space usage attributes of folder are valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>agent_type</maml:name> <maml:description> <maml:para>External management agent type.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>inherited_vol_perfpol_id</maml:name> <maml:description> <maml:para>Identifier of the default performance policy for a newly created volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>inherited_vol_perfpol_name</maml:name> <maml:description> <maml:para>Name of the default performance policy for a newly created volume.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>unused_reserve_bytes</maml:name> <maml:description> <maml:para>Unused reserve of volumes in the folder in bytes. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>unused_snap_reserve_bytes</maml:name> <maml:description> <maml:para>Unused reserve of snapshots of volumes in the folder in bytes. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of volumes in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Compressed usage of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>uncompressed_vol_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of volumes in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>uncompressed_snap_usage_bytes</maml:name> <maml:description> <maml:para>Uncompressed usage of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_compression_ratio</maml:name> <maml:description> <maml:para>Compression ratio of volumes in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_compression_ratio</maml:name> <maml:description> <maml:para>Compression ratio of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>compression_ratio</maml:name> <maml:description> <maml:para>Compression savings for the folder expressed as ratio. This field is meaningful only when the usage_valid attribute is true.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this folder was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this folder was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_snaps</maml:name> <maml:description> <maml:para>Number of snapshots inside the folder. This attribute is deprecated and has no meaningful value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_snapcolls</maml:name> <maml:description> <maml:para>Number of snapshot collections inside the folder. This attribute is deprecated and has no meaningful value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>app_uuid</maml:name> <maml:description> <maml:para>Application identifier of the folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volume_list</maml:name> <maml:description> <maml:para>List of volumes contained by the folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>appserver_id</maml:name> <maml:description> <maml:para>Identifier of the application server associated with the folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>appserver_name</maml:name> <maml:description> <maml:para>Name of the application server associated with the folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>folset_id</maml:name> <maml:description> <maml:para>Identifier of the folder set associated with the folder. Only VVol folder can be associated with the folder set. The folder and the containing folder set must be associated with the same application server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>folset_name</maml:name> <maml:description> <maml:para>Name of the folder set associated with the folder. Only VVol folder can be associated with the folder set. The folder and the containing folder set must be associated with the same application server.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>limit_iops</maml:name> <maml:description> <maml:para>IOPS limit for this folder. If limit_iops is not specified when a folder is created, or if limit_iops is set to -1, then the folder has no IOPS limit. IOPS limit should be in range [256, 4294967294] or -1 for unlimited.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>limit_mbps</maml:name> <maml:description> <maml:para>Throughput limit for this folder in MB/s. If limit_mbps is not specified when a folder is created, or if limit_mbps is set to -1, then the folder has no throughput limit. MBPS limit should be in range [1, 4294967294] or -1 for unlimited.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>access_protocol</maml:name> <maml:description> <maml:para>Access protocol of the folder. This attribute is used by the VASA Provider to determine the access protocol of the bind request. If not specified in the creation request, it will be the access protocol supported by the group. If the group supports multiple protocols, the default will be Fibre Channel. This field is meaningful only to VVol folder.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Tenant ID of the folder. This is used to determine what tenant context the folder belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 2 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Remove-NSFolder -id 2f28eada7f8dd99d3b0000000000000000000000c6 </dev:code> <dev:remarks> <maml:para>This command will remove a folder specified by ID. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-NSFolderDeDupe</command:name> <maml:description> <maml:para>Set dedupe enabled/disabled for all applicable volumes inside a folder.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invok</command:verb> <command:noun>-NSFolderDeDupe</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Set dedupe enabled/disabled for all applicable volumes inside a folder.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-NSFolderDeDupe</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_enabled</maml:name> <maml:description> <maml:para>Enable/disable dedupe.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-NSFolderDeDupe</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Folder containing the volumes to enable/disable dedupe on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_enabled</maml:name> <maml:description> <maml:para>Enable/disable dedupe.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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>id</maml:name> <maml:description> <maml:para>Folder containing the volumes to enable/disable dedupe on.</maml:para> </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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSNetworkConfig</command:name> <maml:description> <maml:para>Creates a network configuration whose role is 'draft'. Modify the draft configuration in stages until it is ready to be validated and activated.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSNetworkConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Creates a network configuration whose role is 'draft'. Modify the draft configuration in stages until it is ready to be validated and activated.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for network configuration.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSNetworkConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the network configuration. Use the name 'draft' when creating a draft configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSNetworkConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>mgmt_ip</maml:name> <maml:description> <maml:para>Management IP address for the Group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>secondary_mgmt_ip</maml:name> <maml:description> <maml:para>Secondary management IP address for the Group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of network configuration.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSNetworkConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_automatic_connection_method</maml:name> <maml:description> <maml:para>Whether automatic connection method is enabled. Enabling this means means redirecting connections from the specified iSCSI discovery IP address to the best data IP address based on connection counts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSNetworkConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_connection_rebalancing</maml:name> <maml:description> <maml:para>Whether rebalancing is enabled. Enabling this means rebalancing iSCSI connections by periodically breaking existing connections that are out-of-balance, allowing the host to reconnect to a more appropriate data IP address.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSNetworkConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>route_list</maml:name> <maml:description> <maml:para>List of static routes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSNetworkConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>subnet_list</maml:name> <maml:description> <maml:para>List of subnet configs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSNetworkConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_list</maml:name> <maml:description> <maml:para>List of array network configs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group_leader_array</maml:name> <maml:description> <maml:para>Name of the group leader array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this net configuration was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this network configuration was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>active_since</maml:name> <maml:description> <maml:para>Start time of activity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_active</maml:name> <maml:description> <maml:para>Time of last activity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ignore_validation_mask</maml:name> <maml:description> <maml:para>Indicates whether to ignore the validation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for network configuration.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the network configuration. Use the name 'draft' when creating a draft configuration.</maml:para> </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="true (ByValue)" position="named"> <maml:name>mgmt_ip</maml:name> <maml:description> <maml:para>Management IP address for 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="true (ByValue)" position="named"> <maml:name>secondary_mgmt_ip</maml:name> <maml:description> <maml:para>Secondary management IP address for the Group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of network configuration.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>iscsi_automatic_connection_method</maml:name> <maml:description> <maml:para>Whether automatic connection method is enabled. Enabling this means means redirecting connections from the specified iSCSI discovery IP address to the best data IP address based on connection counts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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>iscsi_connection_rebalancing</maml:name> <maml:description> <maml:para>Whether rebalancing is enabled. Enabling this means rebalancing iSCSI connections by periodically breaking existing connections that are out-of-balance, allowing the host to reconnect to a more appropriate data IP address.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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>route_list</maml:name> <maml:description> <maml:para>List of static routes.</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="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>subnet_list</maml:name> <maml:description> <maml:para>List of subnet configs.</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="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>array_list</maml:name> <maml:description> <maml:para>List of array network configs.</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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>group_leader_array</maml:name> <maml:description> <maml:para>Name of the group leader array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this net configuration was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this network configuration was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>active_since</maml:name> <maml:description> <maml:para>Start time of activity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_active</maml:name> <maml:description> <maml:para>Time of last activity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ignore_validation_mask</maml:name> <maml:description> <maml:para>Indicates whether to ignore the validation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSNetworkConfig</command:name> <maml:description> <maml:para>List a set of network configurations or a single network configuration.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSNetworkConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List a set of network configurations or a single network configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for network configuration.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the network configuration. Use the name 'draft' when creating a draft configuration.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>mgmt_ip</maml:name> <maml:description> <maml:para>Management IP address for the Group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>secondary_mgmt_ip</maml:name> <maml:description> <maml:para>Secondary management IP address for the Group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of network configuration.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_automatic_connection_method</maml:name> <maml:description> <maml:para>Whether automatic connection method is enabled. Enabling this means means redirecting connections from the specified iSCSI discovery IP address to the best data IP address based on connection counts.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_connection_rebalancing</maml:name> <maml:description> <maml:para>Whether rebalancing is enabled. Enabling this means rebalancing iSCSI connections by periodically breaking existing connections that are out-of-balance, allowing the host to reconnect to a more appropriate data IP address.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>route_list</maml:name> <maml:description> <maml:para>List of static routes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>subnet_list</maml:name> <maml:description> <maml:para>List of subnet configs.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_list</maml:name> <maml:description> <maml:para>List of array network configs.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group_leader_array</maml:name> <maml:description> <maml:para>Name of the group leader array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this net configuration was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this network configuration was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>active_since</maml:name> <maml:description> <maml:para>Start time of activity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_active</maml:name> <maml:description> <maml:para>Time of last activity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ignore_validation_mask</maml:name> <maml:description> <maml:para>Indicates whether to ignore the validation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for network configuration.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the network configuration. Use the name 'draft' when creating a draft configuration.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>mgmt_ip</maml:name> <maml:description> <maml:para>Management IP address for the Group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>secondary_mgmt_ip</maml:name> <maml:description> <maml:para>Secondary management IP address for the Group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of network configuration.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>iscsi_automatic_connection_method</maml:name> <maml:description> <maml:para>Whether automatic connection method is enabled. Enabling this means means redirecting connections from the specified iSCSI discovery IP address to the best data IP address based on connection counts.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>iscsi_connection_rebalancing</maml:name> <maml:description> <maml:para>Whether rebalancing is enabled. Enabling this means rebalancing iSCSI connections by periodically breaking existing connections that are out-of-balance, allowing the host to reconnect to a more appropriate data IP address.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>route_list</maml:name> <maml:description> <maml:para>List of static routes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>subnet_list</maml:name> <maml:description> <maml:para>List of subnet configs.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>array_list</maml:name> <maml:description> <maml:para>List of array network configs.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>group_leader_array</maml:name> <maml:description> <maml:para>Name of the group leader array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this net configuration was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this network configuration was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>active_since</maml:name> <maml:description> <maml:para>Start time of activity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_active</maml:name> <maml:description> <maml:para>Time of last activity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ignore_validation_mask</maml:name> <maml:description> <maml:para>Indicates whether to ignore the validation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSNetworkConfig</command:name> <maml:description> <maml:para>Modify attributes of a network configuration.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSNetworkConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Modify attributes of a network configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSNetworkConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for network configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSNetworkConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the network configuration. Use the name 'draft' when creating a draft configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSNetworkConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>mgmt_ip</maml:name> <maml:description> <maml:para>Management IP address for the Group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>secondary_mgmt_ip</maml:name> <maml:description> <maml:para>Secondary management IP address for the Group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of network configuration.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSNetworkConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_automatic_connection_method</maml:name> <maml:description> <maml:para>Whether automatic connection method is enabled. Enabling this means means redirecting connections from the specified iSCSI discovery IP address to the best data IP address based on connection counts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSNetworkConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_connection_rebalancing</maml:name> <maml:description> <maml:para>Whether rebalancing is enabled. Enabling this means rebalancing iSCSI connections by periodically breaking existing connections that are out-of-balance, allowing the host to reconnect to a more appropriate data IP address.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSNetworkConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>route_list</maml:name> <maml:description> <maml:para>List of static routes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSNetworkConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>subnet_list</maml:name> <maml:description> <maml:para>List of subnet configs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSNetworkConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_list</maml:name> <maml:description> <maml:para>List of array network configs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group_leader_array</maml:name> <maml:description> <maml:para>Name of the group leader array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this net configuration was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this network configuration was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>active_since</maml:name> <maml:description> <maml:para>Start time of activity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_active</maml:name> <maml:description> <maml:para>Time of last activity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ignore_validation_mask</maml:name> <maml:description> <maml:para>Indicates whether to ignore the validation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for network configuration.</maml:para> </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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the network configuration. Use the name 'draft' when creating a draft configuration.</maml:para> </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="true (ByValue)" position="named"> <maml:name>mgmt_ip</maml:name> <maml:description> <maml:para>Management IP address for 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="true (ByValue)" position="named"> <maml:name>secondary_mgmt_ip</maml:name> <maml:description> <maml:para>Secondary management IP address for the Group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of network configuration.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>iscsi_automatic_connection_method</maml:name> <maml:description> <maml:para>Whether automatic connection method is enabled. Enabling this means means redirecting connections from the specified iSCSI discovery IP address to the best data IP address based on connection counts.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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>iscsi_connection_rebalancing</maml:name> <maml:description> <maml:para>Whether rebalancing is enabled. Enabling this means rebalancing iSCSI connections by periodically breaking existing connections that are out-of-balance, allowing the host to reconnect to a more appropriate data IP address.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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>route_list</maml:name> <maml:description> <maml:para>List of static routes.</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="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>subnet_list</maml:name> <maml:description> <maml:para>List of subnet configs.</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="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>array_list</maml:name> <maml:description> <maml:para>List of array network configs.</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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>group_leader_array</maml:name> <maml:description> <maml:para>Name of the group leader array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this net configuration was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this network configuration was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>active_since</maml:name> <maml:description> <maml:para>Start time of activity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_active</maml:name> <maml:description> <maml:para>Time of last activity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ignore_validation_mask</maml:name> <maml:description> <maml:para>Indicates whether to ignore the validation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSNetworkConfig</command:name> <maml:description> <maml:para>Delete a network configuration. This operation is only valid for network configurations whose role is 'draft'.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSNetworkConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Delete a network configuration. This operation is only valid for network configurations whose role is 'draft'.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for network configuration.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the network configuration. Use the name 'draft' when creating a draft configuration.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>mgmt_ip</maml:name> <maml:description> <maml:para>Management IP address for the Group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>secondary_mgmt_ip</maml:name> <maml:description> <maml:para>Secondary management IP address for the Group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of network configuration.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_automatic_connection_method</maml:name> <maml:description> <maml:para>Whether automatic connection method is enabled. Enabling this means means redirecting connections from the specified iSCSI discovery IP address to the best data IP address based on connection counts.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>iscsi_connection_rebalancing</maml:name> <maml:description> <maml:para>Whether rebalancing is enabled. Enabling this means rebalancing iSCSI connections by periodically breaking existing connections that are out-of-balance, allowing the host to reconnect to a more appropriate data IP address.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>route_list</maml:name> <maml:description> <maml:para>List of static routes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>subnet_list</maml:name> <maml:description> <maml:para>List of subnet configs.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_list</maml:name> <maml:description> <maml:para>List of array network configs.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group_leader_array</maml:name> <maml:description> <maml:para>Name of the group leader array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this net configuration was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this network configuration was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>active_since</maml:name> <maml:description> <maml:para>Start time of activity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_active</maml:name> <maml:description> <maml:para>Time of last activity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSNetworkConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ignore_validation_mask</maml:name> <maml:description> <maml:para>Indicates whether to ignore the validation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for network configuration.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the network configuration. Use the name 'draft' when creating a draft configuration.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>mgmt_ip</maml:name> <maml:description> <maml:para>Management IP address for the Group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>secondary_mgmt_ip</maml:name> <maml:description> <maml:para>Secondary management IP address for the Group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of network configuration.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>iscsi_automatic_connection_method</maml:name> <maml:description> <maml:para>Whether automatic connection method is enabled. Enabling this means means redirecting connections from the specified iSCSI discovery IP address to the best data IP address based on connection counts.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>iscsi_connection_rebalancing</maml:name> <maml:description> <maml:para>Whether rebalancing is enabled. Enabling this means rebalancing iSCSI connections by periodically breaking existing connections that are out-of-balance, allowing the host to reconnect to a more appropriate data IP address.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>route_list</maml:name> <maml:description> <maml:para>List of static routes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>subnet_list</maml:name> <maml:description> <maml:para>List of subnet configs.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>array_list</maml:name> <maml:description> <maml:para>List of array network configs.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>group_leader_array</maml:name> <maml:description> <maml:para>Name of the group leader array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this net configuration was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this network configuration was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>active_since</maml:name> <maml:description> <maml:para>Start time of activity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_active</maml:name> <maml:description> <maml:para>Time of last activity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ignore_validation_mask</maml:name> <maml:description> <maml:para>Indicates whether to ignore the validation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Initialize-NSNetworkConfig</command:name> <maml:description> <maml:para>Activate a network configuration.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Initi</command:verb> <command:noun>-NSNetworkConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Activate a network configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-NSNetworkConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the netconfig to activate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Initialize-NSNetworkConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ignore_validation_mask</maml:name> <maml:description> <maml:para>Whether to ignore validation or not.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the netconfig to activate.</maml:para> </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="true (ByValue)" position="named"> <maml:name>ignore_validation_mask</maml:name> <maml:description> <maml:para>Whether to ignore validation or not.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-NSNetworkConfig</command:name> <maml:description> <maml:para>Validate a network configuration.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test-</command:verb> <command:noun>-NSNetworkConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Validate a network configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-NSNetworkConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the netconfig to validate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-NSNetworkConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ignore_validation_mask</maml:name> <maml:description> <maml:para>Whether to ignore validation or not.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the netconfig to validate.</maml:para> </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="true (ByValue)" position="named"> <maml:name>ignore_validation_mask</maml:name> <maml:description> <maml:para>Whether to ignore validation or not.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSController</command:name> <maml:description> <maml:para>List of controllers or controller attributes.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSController</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List of controllers or controller attributes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSController</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier of the controller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSController</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the controller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSController</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_name</maml:name> <maml:description> <maml:para>Name of the array containing this controller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSController</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_id</maml:name> <maml:description> <maml:para>Rest ID of the array containing this controller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSController</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>partial_response_ok</maml:name> <maml:description> <maml:para>Indicate that it is ok to provide partially available response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSController</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>serial</maml:name> <maml:description> <maml:para>Serial number for this controller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSController</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>model</maml:name> <maml:description> <maml:para>Model of this controller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSController</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>hostname</maml:name> <maml:description> <maml:para>Host name for the controller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSController</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>support_address</maml:name> <maml:description> <maml:para>IP address used for support.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSController</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>support_netmask</maml:name> <maml:description> <maml:para>IP netmask used for support.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSController</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>support_nic</maml:name> <maml:description> <maml:para>Network card used for support.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSController</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>power_status</maml:name> <maml:description> <maml:para>Overall power supply status for the controller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSController</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fan_status</maml:name> <maml:description> <maml:para>Overall fan status for the controller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSController</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>temperature_status</maml:name> <maml:description> <maml:para>Overall temperature status for the controller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSController</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>power_supplies</maml:name> <maml:description> <maml:para>Status for each power supply in the controller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSController</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fans</maml:name> <maml:description> <maml:para>Status for each fan in the controller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSController</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>temperature_sensors</maml:name> <maml:description> <maml:para>Status for temperature sensor in the controller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSController</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>partition_status</maml:name> <maml:description> <maml:para>Status of the system's raid partitions.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSController</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ctrlr_side</maml:name> <maml:description> <maml:para>Identifies which controller this is on its array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSController</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>state</maml:name> <maml:description> <maml:para>Indicates whether this controller is active or not.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSController</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>nvme_cards_enabled</maml:name> <maml:description> <maml:para>Indicates if the NVMe accelerator card is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSController</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>nvme_cards</maml:name> <maml:description> <maml:para>List of NVMe accelerator cards.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSController</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>asup_time</maml:name> <maml:description> <maml:para>Time of the last autosupport by the controller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier of the controller.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the controller.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>array_name</maml:name> <maml:description> <maml:para>Name of the array containing this controller.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>array_id</maml:name> <maml:description> <maml:para>Rest ID of the array containing this controller.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>partial_response_ok</maml:name> <maml:description> <maml:para>Indicate that it is ok to provide partially available response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>serial</maml:name> <maml:description> <maml:para>Serial number for this controller.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>model</maml:name> <maml:description> <maml:para>Model of this controller.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>hostname</maml:name> <maml:description> <maml:para>Host name for the controller.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>support_address</maml:name> <maml:description> <maml:para>IP address used for support.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>support_netmask</maml:name> <maml:description> <maml:para>IP netmask used for support.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>support_nic</maml:name> <maml:description> <maml:para>Network card used for support.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>power_status</maml:name> <maml:description> <maml:para>Overall power supply status for the controller.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>fan_status</maml:name> <maml:description> <maml:para>Overall fan status for the controller.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>temperature_status</maml:name> <maml:description> <maml:para>Overall temperature status for the controller.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>power_supplies</maml:name> <maml:description> <maml:para>Status for each power supply in the controller.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>fans</maml:name> <maml:description> <maml:para>Status for each fan in the controller.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>temperature_sensors</maml:name> <maml:description> <maml:para>Status for temperature sensor in the controller.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>partition_status</maml:name> <maml:description> <maml:para>Status of the system's raid partitions.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ctrlr_side</maml:name> <maml:description> <maml:para>Identifies which controller this is on its array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>state</maml:name> <maml:description> <maml:para>Indicates whether this controller is active or not.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>nvme_cards_enabled</maml:name> <maml:description> <maml:para>Indicates if the NVMe accelerator card is enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>nvme_cards</maml:name> <maml:description> <maml:para>List of NVMe accelerator cards.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>asup_time</maml:name> <maml:description> <maml:para>Time of the last autosupport by the controller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSController id name array_name array_id -- ---- ---------- -------- c328eada7f8dd99d3b000000000000000100000000 A chapi-afa-a1 0928eada7f8dd99d3b000000000000000000000001 c328eada7f8dd99d3b000000000000000100000001 B chapi-afa-a1 0928eada7f8dd99d3b000000000000000000000001 </dev:code> <dev:remarks> <maml:para>This command will retrieve the controller status. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Stop-NSController</command:name> <maml:description> <maml:para>Halt the specified controller. Restarting the controller will require physically powering it back on.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Stop-</command:verb> <command:noun>-NSController</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Halt the specified controller. Restarting the controller will require physically powering it back on.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-NSController</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the controller to halt.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the controller to halt.</maml:para> </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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Reset-NSController</command:name> <maml:description> <maml:para>Reboot the specified controller.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Reset</command:verb> <command:noun>-NSController</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Reboot the specified controller.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Reset-NSController</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the controller to reboot.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the controller to reboot.</maml:para> </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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSProtectionSchedule</command:name> <maml:description> <maml:para>Create a protection schedule and add to specified protection template.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSProtectionSchedule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Create a protection schedule and add to specified protection template.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for protection schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of snapshot schedule to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volcoll_or_prottmpl_type</maml:name> <maml:description> <maml:para>Type of the protection policy this schedule is attached to. Valid values are protection_template and volume_collection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volcoll_or_prottmpl_id</maml:name> <maml:description> <maml:para>Identifier of the protection policy (protection_template or volume_collection) in which this protection schedule is attached to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>period</maml:name> <maml:description> <maml:para>Repeat interval for snapshots with respect to the period_unit. For example, a value of 2 with the 'period_unit' of 'hours' results in one snapshot every 2 hours.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>period_unit</maml:name> <maml:description> <maml:para>Time unit over which to take the number of snapshots specified in 'period'. For example, a value of 'days' with a 'period' of '1' results in one snapshot every day.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>at_time</maml:name> <maml:description> <maml:para>Time of day when snapshot should be taken. In case repeat frequency specifies more than one snapshot in a day then the until_time option specifies until what time of day to take snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>until_time</maml:name> <maml:description> <maml:para>Time of day to stop taking snapshots. Applicable only when repeat frequency specifies more than one snapshot in a day.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>days</maml:name> <maml:description> <maml:para>Specifies which days snapshots should be taken.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_retain</maml:name> <maml:description> <maml:para>Number of snapshots to retain. If replication is enabled on this schedule the array will always retain the latest replicated snapshot, which may exceed the specified retention value. This is necessary to ensure efficient replication performance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>downstream_partner</maml:name> <maml:description> <maml:para>Specifies the partner name if snapshots created by this schedule should be replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>downstream_partner_name</maml:name> <maml:description> <maml:para>Specifies the partner name if snapshots created by this schedule should be replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>downstream_partner_id</maml:name> <maml:description> <maml:para>Specifies the partner ID if snapshots created by this schedule should be replicated. In an update operation, if snapshots should be replicated, set this attribute to the ID of the replication partner. If snapshots should not be replicated, set this attribute to the empty string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>upstream_partner_name</maml:name> <maml:description> <maml:para>Specifies the partner name from which snapshots created by this schedule are replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>upstream_partner_id</maml:name> <maml:description> <maml:para>Specifies the partner ID from which snapshots created by this schedule are replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replicate_every</maml:name> <maml:description> <maml:para>Specifies which snapshots should be replicated. If snapshots are replicated and this option is not specified, every snapshot is replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_retain_replica</maml:name> <maml:description> <maml:para>Number of snapshots to retain on the replica.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_alert_thres</maml:name> <maml:description> <maml:para>Replication alert threshold in seconds. If the replication of a snapshot takes more than this amount of time to complete an alert will be generated. Enter 0 to disable this alert.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_verify</maml:name> <maml:description> <maml:para>Run verification tool on snapshot created by this schedule. This option can only be used with snapshot schedules of a protection template that has application synchronization. The tool used to verify snapshot depends on the type of application. For example, if application synchronization is VSS and the application ID is Exchange, eseutil tool is run on the snapshots. If verification fails, the logs are not truncated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>skip_db_consistency_check</maml:name> <maml:description> <maml:para>Skip consistency check for database files on snapshots created by this schedule. This option only applies to snapshot schedules of a protection template with application synchronization set to VSS, application ID set to MS Exchange 2010 or later w/DAG, this schedule's snap_verify option set to yes, and its disable_appsync option set to false. Skipping consistency checks is only recommended if each database in a DAG has multiple copies.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>disable_appsync</maml:name> <maml:description> <maml:para>Disables application synchronized snapshots and creates crash consistent snapshots instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>schedule_type</maml:name> <maml:description> <maml:para>Normal schedules have internal timers which drive snapshot creation. An externally driven schedule has no internal timers. All snapshot activity is driven by an external trigger. In other words, these schedules are used only for externally driven manual snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>active</maml:name> <maml:description> <maml:para>A schedule is active only if it is owned by the same owner as the volume collection. Only active schedules of a volume collection participate in the creation of snapshots and replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this protection schedule was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this protection schedule was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_mod_sched_time</maml:name> <maml:description> <maml:para>Time when the timing of the protection schedule was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_replicated_snapcoll_name</maml:name> <maml:description> <maml:para>Specifies the name of last replicated snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_replicated_snapcoll_id</maml:name> <maml:description> <maml:para>Specifies the snapshot collection ID of last replicated snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_replicated_at_time</maml:name> <maml:description> <maml:para>Time when last snapshot collection was replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_snap_time</maml:name> <maml:description> <maml:para>Time when last snapshot was taken.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>next_snap_time</maml:name> <maml:description> <maml:para>Time when next snapshot will be taken.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>next_repl_snap_time</maml:name> <maml:description> <maml:para>Time when next snapshot will be replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_counter</maml:name> <maml:description> <maml:para>This is only used by custom read handler for internal calculations.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sched_owner_id</maml:name> <maml:description> <maml:para>Identifier of the group that owns this schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sched_owner_name</maml:name> <maml:description> <maml:para>Name of the group that owns this schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_config_change_time</maml:name> <maml:description> <maml:para>The last timing configutation changed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>currently_replicating_snapcoll_name</maml:name> <maml:description> <maml:para>The name of the currently replicating snapshot collection if one exists, the empty string otherwise.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_status_list</maml:name> <maml:description> <maml:para>The list of the replication status of volumes undergoing replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sync_repl_vol_status_list</maml:name> <maml:description> <maml:para>A list of the replication status of volumes undergoing synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>use_downstream_for_DR</maml:name> <maml:description> <maml:para>Break synchronous replication for the specified volume collection and present downstream volumes to host(s). Downstream volumes in the volume collection will be set to online and presented to the host(s) using new serial and LUN numbers. No changes will be made to the upstream volumes, their serial and LUN numbers, and their online state. The existing ACLs on the upstream volumes will be copied to the downstream volumes. Use this in conjunction with an empty downstream_partner_id. This unconfigures synchronous replication when the partner is removed from the last replicating schedule in the specified volume collection and presents the downstream volumes to host(s). Host(s) will need to be configured to access the new volumes with the newly assigned serial and LUN numbers. Use this option to expose downstream volumes in a synchronously replicated volume collection to host(s) only when the upstream partner is confirmed to be down and there is no communication between partners. Do not execute this operation if a previous Group Management Service takeover has been performed on a different array. Do not perform a subsequent Group Management Service takeover on a different array as it will lead to irreconcilable conflicts. This limitation is cleared once the Group management service backup array has successfully synchronized after reconnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for protection schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of snapshot schedule to create.</maml:para> </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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volcoll_or_prottmpl_type</maml:name> <maml:description> <maml:para>Type of the protection policy this schedule is attached to. Valid values are protection_template and volume_collection.</maml:para> </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="true (ByValue)" position="named"> <maml:name>volcoll_or_prottmpl_id</maml:name> <maml:description> <maml:para>Identifier of the protection policy (protection_template or volume_collection) in which this protection schedule is attached to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>period</maml:name> <maml:description> <maml:para>Repeat interval for snapshots with respect to the period_unit. For example, a value of 2 with the 'period_unit' of 'hours' results in one snapshot every 2 hours.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>period_unit</maml:name> <maml:description> <maml:para>Time unit over which to take the number of snapshots specified in 'period'. For example, a value of 'days' with a 'period' of '1' results in one snapshot every day.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>at_time</maml:name> <maml:description> <maml:para>Time of day when snapshot should be taken. In case repeat frequency specifies more than one snapshot in a day then the until_time option specifies until what time of day to take snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>until_time</maml:name> <maml:description> <maml:para>Time of day to stop taking snapshots. Applicable only when repeat frequency specifies more than one snapshot in a day.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>days</maml:name> <maml:description> <maml:para>Specifies which days snapshots should be taken.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>num_retain</maml:name> <maml:description> <maml:para>Number of snapshots to retain. If replication is enabled on this schedule the array will always retain the latest replicated snapshot, which may exceed the specified retention value. This is necessary to ensure efficient replication performance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>downstream_partner</maml:name> <maml:description> <maml:para>Specifies the partner name if snapshots created by this schedule should be replicated.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>downstream_partner_name</maml:name> <maml:description> <maml:para>Specifies the partner name if snapshots created by this schedule should be replicated.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>downstream_partner_id</maml:name> <maml:description> <maml:para>Specifies the partner ID if snapshots created by this schedule should be replicated. In an update operation, if snapshots should be replicated, set this attribute to the ID of the replication partner. If snapshots should not be replicated, set this attribute to the empty string.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>upstream_partner_name</maml:name> <maml:description> <maml:para>Specifies the partner name from which snapshots created by this schedule are replicated.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>upstream_partner_id</maml:name> <maml:description> <maml:para>Specifies the partner ID from which snapshots created by this schedule are replicated.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>replicate_every</maml:name> <maml:description> <maml:para>Specifies which snapshots should be replicated. If snapshots are replicated and this option is not specified, every snapshot is replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_retain_replica</maml:name> <maml:description> <maml:para>Number of snapshots to retain on the replica.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_alert_thres</maml:name> <maml:description> <maml:para>Replication alert threshold in seconds. If the replication of a snapshot takes more than this amount of time to complete an alert will be generated. Enter 0 to disable this alert.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_verify</maml:name> <maml:description> <maml:para>Run verification tool on snapshot created by this schedule. This option can only be used with snapshot schedules of a protection template that has application synchronization. The tool used to verify snapshot depends on the type of application. For example, if application synchronization is VSS and the application ID is Exchange, eseutil tool is run on the snapshots. If verification fails, the logs are not truncated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>skip_db_consistency_check</maml:name> <maml:description> <maml:para>Skip consistency check for database files on snapshots created by this schedule. This option only applies to snapshot schedules of a protection template with application synchronization set to VSS, application ID set to MS Exchange 2010 or later w/DAG, this schedule's snap_verify option set to yes, and its disable_appsync option set to false. Skipping consistency checks is only recommended if each database in a DAG has multiple copies.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>disable_appsync</maml:name> <maml:description> <maml:para>Disables application synchronized snapshots and creates crash consistent snapshots instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>schedule_type</maml:name> <maml:description> <maml:para>Normal schedules have internal timers which drive snapshot creation. An externally driven schedule has no internal timers. All snapshot activity is driven by an external trigger. In other words, these schedules are used only for externally driven manual snapshots.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>active</maml:name> <maml:description> <maml:para>A schedule is active only if it is owned by the same owner as the volume collection. Only active schedules of a volume collection participate in the creation of snapshots and replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this protection schedule was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this protection schedule was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_mod_sched_time</maml:name> <maml:description> <maml:para>Time when the timing of the protection schedule was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_replicated_snapcoll_name</maml:name> <maml:description> <maml:para>Specifies the name of last replicated snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>last_replicated_snapcoll_id</maml:name> <maml:description> <maml:para>Specifies the snapshot collection ID of last replicated snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>last_replicated_at_time</maml:name> <maml:description> <maml:para>Time when last snapshot collection was replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_snap_time</maml:name> <maml:description> <maml:para>Time when last snapshot was taken.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>next_snap_time</maml:name> <maml:description> <maml:para>Time when next snapshot will be taken.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>next_repl_snap_time</maml:name> <maml:description> <maml:para>Time when next snapshot will be replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_counter</maml:name> <maml:description> <maml:para>This is only used by custom read handler for internal calculations.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>sched_owner_id</maml:name> <maml:description> <maml:para>Identifier of the group that owns this schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>sched_owner_name</maml:name> <maml:description> <maml:para>Name of the group that owns this schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>last_config_change_time</maml:name> <maml:description> <maml:para>The last timing configutation changed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>currently_replicating_snapcoll_name</maml:name> <maml:description> <maml:para>The name of the currently replicating snapshot collection if one exists, the empty string otherwise.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vol_status_list</maml:name> <maml:description> <maml:para>The list of the replication status of volumes undergoing replication.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>sync_repl_vol_status_list</maml:name> <maml:description> <maml:para>A list of the replication status of volumes undergoing synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>use_downstream_for_DR</maml:name> <maml:description> <maml:para>Break synchronous replication for the specified volume collection and present downstream volumes to host(s). Downstream volumes in the volume collection will be set to online and presented to the host(s) using new serial and LUN numbers. No changes will be made to the upstream volumes, their serial and LUN numbers, and their online state. The existing ACLs on the upstream volumes will be copied to the downstream volumes. Use this in conjunction with an empty downstream_partner_id. This unconfigures synchronous replication when the partner is removed from the last replicating schedule in the specified volume collection and presents the downstream volumes to host(s). Host(s) will need to be configured to access the new volumes with the newly assigned serial and LUN numbers. Use this option to expose downstream volumes in a synchronously replicated volume collection to host(s) only when the upstream partner is confirmed to be down and there is no communication between partners. Do not execute this operation if a previous Group Management Service takeover has been performed on a different array. Do not perform a subsequent Group Management Service takeover on a different array as it will lead to irreconcilable conflicts. This limitation is cleared once the Group management service backup array has successfully synchronized after reconnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSProtectionSchedule</command:name> <maml:description> <maml:para>List one or more protection schedules.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSProtectionSchedule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List one or more protection schedules.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for protection schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of snapshot schedule to create.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volcoll_or_prottmpl_type</maml:name> <maml:description> <maml:para>Type of the protection policy this schedule is attached to. Valid values are protection_template and volume_collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volcoll_or_prottmpl_id</maml:name> <maml:description> <maml:para>Identifier of the protection policy (protection_template or volume_collection) in which this protection schedule is attached to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>period</maml:name> <maml:description> <maml:para>Repeat interval for snapshots with respect to the period_unit. For example, a value of 2 with the 'period_unit' of 'hours' results in one snapshot every 2 hours.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>period_unit</maml:name> <maml:description> <maml:para>Time unit over which to take the number of snapshots specified in 'period'. For example, a value of 'days' with a 'period' of '1' results in one snapshot every day.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>at_time</maml:name> <maml:description> <maml:para>Time of day when snapshot should be taken. In case repeat frequency specifies more than one snapshot in a day then the until_time option specifies until what time of day to take snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>until_time</maml:name> <maml:description> <maml:para>Time of day to stop taking snapshots. Applicable only when repeat frequency specifies more than one snapshot in a day.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>days</maml:name> <maml:description> <maml:para>Specifies which days snapshots should be taken.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_retain</maml:name> <maml:description> <maml:para>Number of snapshots to retain. If replication is enabled on this schedule the array will always retain the latest replicated snapshot, which may exceed the specified retention value. This is necessary to ensure efficient replication performance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>downstream_partner</maml:name> <maml:description> <maml:para>Specifies the partner name if snapshots created by this schedule should be replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>downstream_partner_name</maml:name> <maml:description> <maml:para>Specifies the partner name if snapshots created by this schedule should be replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>downstream_partner_id</maml:name> <maml:description> <maml:para>Specifies the partner ID if snapshots created by this schedule should be replicated. In an update operation, if snapshots should be replicated, set this attribute to the ID of the replication partner. If snapshots should not be replicated, set this attribute to the empty string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>upstream_partner_name</maml:name> <maml:description> <maml:para>Specifies the partner name from which snapshots created by this schedule are replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>upstream_partner_id</maml:name> <maml:description> <maml:para>Specifies the partner ID from which snapshots created by this schedule are replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replicate_every</maml:name> <maml:description> <maml:para>Specifies which snapshots should be replicated. If snapshots are replicated and this option is not specified, every snapshot is replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_retain_replica</maml:name> <maml:description> <maml:para>Number of snapshots to retain on the replica.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_alert_thres</maml:name> <maml:description> <maml:para>Replication alert threshold in seconds. If the replication of a snapshot takes more than this amount of time to complete an alert will be generated. Enter 0 to disable this alert.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_verify</maml:name> <maml:description> <maml:para>Run verification tool on snapshot created by this schedule. This option can only be used with snapshot schedules of a protection template that has application synchronization. The tool used to verify snapshot depends on the type of application. For example, if application synchronization is VSS and the application ID is Exchange, eseutil tool is run on the snapshots. If verification fails, the logs are not truncated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>skip_db_consistency_check</maml:name> <maml:description> <maml:para>Skip consistency check for database files on snapshots created by this schedule. This option only applies to snapshot schedules of a protection template with application synchronization set to VSS, application ID set to MS Exchange 2010 or later w/DAG, this schedule's snap_verify option set to yes, and its disable_appsync option set to false. Skipping consistency checks is only recommended if each database in a DAG has multiple copies.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>disable_appsync</maml:name> <maml:description> <maml:para>Disables application synchronized snapshots and creates crash consistent snapshots instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>schedule_type</maml:name> <maml:description> <maml:para>Normal schedules have internal timers which drive snapshot creation. An externally driven schedule has no internal timers. All snapshot activity is driven by an external trigger. In other words, these schedules are used only for externally driven manual snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>active</maml:name> <maml:description> <maml:para>A schedule is active only if it is owned by the same owner as the volume collection. Only active schedules of a volume collection participate in the creation of snapshots and replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this protection schedule was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this protection schedule was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_mod_sched_time</maml:name> <maml:description> <maml:para>Time when the timing of the protection schedule was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_replicated_snapcoll_name</maml:name> <maml:description> <maml:para>Specifies the name of last replicated snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_replicated_snapcoll_id</maml:name> <maml:description> <maml:para>Specifies the snapshot collection ID of last replicated snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_replicated_at_time</maml:name> <maml:description> <maml:para>Time when last snapshot collection was replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_snap_time</maml:name> <maml:description> <maml:para>Time when last snapshot was taken.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>next_snap_time</maml:name> <maml:description> <maml:para>Time when next snapshot will be taken.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>next_repl_snap_time</maml:name> <maml:description> <maml:para>Time when next snapshot will be replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_counter</maml:name> <maml:description> <maml:para>This is only used by custom read handler for internal calculations.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sched_owner_id</maml:name> <maml:description> <maml:para>Identifier of the group that owns this schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sched_owner_name</maml:name> <maml:description> <maml:para>Name of the group that owns this schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_config_change_time</maml:name> <maml:description> <maml:para>The last timing configutation changed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>currently_replicating_snapcoll_name</maml:name> <maml:description> <maml:para>The name of the currently replicating snapshot collection if one exists, the empty string otherwise.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_status_list</maml:name> <maml:description> <maml:para>The list of the replication status of volumes undergoing replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sync_repl_vol_status_list</maml:name> <maml:description> <maml:para>A list of the replication status of volumes undergoing synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>use_downstream_for_DR</maml:name> <maml:description> <maml:para>Break synchronous replication for the specified volume collection and present downstream volumes to host(s). Downstream volumes in the volume collection will be set to online and presented to the host(s) using new serial and LUN numbers. No changes will be made to the upstream volumes, their serial and LUN numbers, and their online state. The existing ACLs on the upstream volumes will be copied to the downstream volumes. Use this in conjunction with an empty downstream_partner_id. This unconfigures synchronous replication when the partner is removed from the last replicating schedule in the specified volume collection and presents the downstream volumes to host(s). Host(s) will need to be configured to access the new volumes with the newly assigned serial and LUN numbers. Use this option to expose downstream volumes in a synchronously replicated volume collection to host(s) only when the upstream partner is confirmed to be down and there is no communication between partners. Do not execute this operation if a previous Group Management Service takeover has been performed on a different array. Do not perform a subsequent Group Management Service takeover on a different array as it will lead to irreconcilable conflicts. This limitation is cleared once the Group management service backup array has successfully synchronized after reconnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for protection schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of snapshot schedule to create.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volcoll_or_prottmpl_type</maml:name> <maml:description> <maml:para>Type of the protection policy this schedule is attached to. Valid values are protection_template and volume_collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volcoll_or_prottmpl_id</maml:name> <maml:description> <maml:para>Identifier of the protection policy (protection_template or volume_collection) in which this protection schedule is attached to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>period</maml:name> <maml:description> <maml:para>Repeat interval for snapshots with respect to the period_unit. For example, a value of 2 with the 'period_unit' of 'hours' results in one snapshot every 2 hours.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>period_unit</maml:name> <maml:description> <maml:para>Time unit over which to take the number of snapshots specified in 'period'. For example, a value of 'days' with a 'period' of '1' results in one snapshot every day.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>at_time</maml:name> <maml:description> <maml:para>Time of day when snapshot should be taken. In case repeat frequency specifies more than one snapshot in a day then the until_time option specifies until what time of day to take snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>until_time</maml:name> <maml:description> <maml:para>Time of day to stop taking snapshots. Applicable only when repeat frequency specifies more than one snapshot in a day.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>days</maml:name> <maml:description> <maml:para>Specifies which days snapshots should be taken.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>num_retain</maml:name> <maml:description> <maml:para>Number of snapshots to retain. If replication is enabled on this schedule the array will always retain the latest replicated snapshot, which may exceed the specified retention value. This is necessary to ensure efficient replication performance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>downstream_partner</maml:name> <maml:description> <maml:para>Specifies the partner name if snapshots created by this schedule should be replicated.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>downstream_partner_name</maml:name> <maml:description> <maml:para>Specifies the partner name if snapshots created by this schedule should be replicated.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>downstream_partner_id</maml:name> <maml:description> <maml:para>Specifies the partner ID if snapshots created by this schedule should be replicated. In an update operation, if snapshots should be replicated, set this attribute to the ID of the replication partner. If snapshots should not be replicated, set this attribute to the empty string.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>upstream_partner_name</maml:name> <maml:description> <maml:para>Specifies the partner name from which snapshots created by this schedule are replicated.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>upstream_partner_id</maml:name> <maml:description> <maml:para>Specifies the partner ID from which snapshots created by this schedule are replicated.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>replicate_every</maml:name> <maml:description> <maml:para>Specifies which snapshots should be replicated. If snapshots are replicated and this option is not specified, every snapshot is replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_retain_replica</maml:name> <maml:description> <maml:para>Number of snapshots to retain on the replica.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_alert_thres</maml:name> <maml:description> <maml:para>Replication alert threshold in seconds. If the replication of a snapshot takes more than this amount of time to complete an alert will be generated. Enter 0 to disable this alert.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_verify</maml:name> <maml:description> <maml:para>Run verification tool on snapshot created by this schedule. This option can only be used with snapshot schedules of a protection template that has application synchronization. The tool used to verify snapshot depends on the type of application. For example, if application synchronization is VSS and the application ID is Exchange, eseutil tool is run on the snapshots. If verification fails, the logs are not truncated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>skip_db_consistency_check</maml:name> <maml:description> <maml:para>Skip consistency check for database files on snapshots created by this schedule. This option only applies to snapshot schedules of a protection template with application synchronization set to VSS, application ID set to MS Exchange 2010 or later w/DAG, this schedule's snap_verify option set to yes, and its disable_appsync option set to false. Skipping consistency checks is only recommended if each database in a DAG has multiple copies.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>disable_appsync</maml:name> <maml:description> <maml:para>Disables application synchronized snapshots and creates crash consistent snapshots instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>schedule_type</maml:name> <maml:description> <maml:para>Normal schedules have internal timers which drive snapshot creation. An externally driven schedule has no internal timers. All snapshot activity is driven by an external trigger. In other words, these schedules are used only for externally driven manual snapshots.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>active</maml:name> <maml:description> <maml:para>A schedule is active only if it is owned by the same owner as the volume collection. Only active schedules of a volume collection participate in the creation of snapshots and replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this protection schedule was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this protection schedule was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_mod_sched_time</maml:name> <maml:description> <maml:para>Time when the timing of the protection schedule was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_replicated_snapcoll_name</maml:name> <maml:description> <maml:para>Specifies the name of last replicated snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>last_replicated_snapcoll_id</maml:name> <maml:description> <maml:para>Specifies the snapshot collection ID of last replicated snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>last_replicated_at_time</maml:name> <maml:description> <maml:para>Time when last snapshot collection was replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_snap_time</maml:name> <maml:description> <maml:para>Time when last snapshot was taken.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>next_snap_time</maml:name> <maml:description> <maml:para>Time when next snapshot will be taken.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>next_repl_snap_time</maml:name> <maml:description> <maml:para>Time when next snapshot will be replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_counter</maml:name> <maml:description> <maml:para>This is only used by custom read handler for internal calculations.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>sched_owner_id</maml:name> <maml:description> <maml:para>Identifier of the group that owns this schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>sched_owner_name</maml:name> <maml:description> <maml:para>Name of the group that owns this schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>last_config_change_time</maml:name> <maml:description> <maml:para>The last timing configutation changed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>currently_replicating_snapcoll_name</maml:name> <maml:description> <maml:para>The name of the currently replicating snapshot collection if one exists, the empty string otherwise.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vol_status_list</maml:name> <maml:description> <maml:para>The list of the replication status of volumes undergoing replication.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>sync_repl_vol_status_list</maml:name> <maml:description> <maml:para>A list of the replication status of volumes undergoing synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>use_downstream_for_DR</maml:name> <maml:description> <maml:para>Break synchronous replication for the specified volume collection and present downstream volumes to host(s). Downstream volumes in the volume collection will be set to online and presented to the host(s) using new serial and LUN numbers. No changes will be made to the upstream volumes, their serial and LUN numbers, and their online state. The existing ACLs on the upstream volumes will be copied to the downstream volumes. Use this in conjunction with an empty downstream_partner_id. This unconfigures synchronous replication when the partner is removed from the last replicating schedule in the specified volume collection and presents the downstream volumes to host(s). Host(s) will need to be configured to access the new volumes with the newly assigned serial and LUN numbers. Use this option to expose downstream volumes in a synchronously replicated volume collection to host(s) only when the upstream partner is confirmed to be down and there is no communication between partners. Do not execute this operation if a previous Group Management Service takeover has been performed on a different array. Do not perform a subsequent Group Management Service takeover on a different array as it will lead to irreconcilable conflicts. This limitation is cleared once the Group management service backup array has successfully synchronized after reconnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSProtectionSchedule</command:name> <maml:description> <maml:para>Update a protection schedule.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSProtectionSchedule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Update a protection schedule.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for protection schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of snapshot schedule to create.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volcoll_or_prottmpl_type</maml:name> <maml:description> <maml:para>Type of the protection policy this schedule is attached to. Valid values are protection_template and volume_collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volcoll_or_prottmpl_id</maml:name> <maml:description> <maml:para>Identifier of the protection policy (protection_template or volume_collection) in which this protection schedule is attached to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>period</maml:name> <maml:description> <maml:para>Repeat interval for snapshots with respect to the period_unit. For example, a value of 2 with the 'period_unit' of 'hours' results in one snapshot every 2 hours.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>period_unit</maml:name> <maml:description> <maml:para>Time unit over which to take the number of snapshots specified in 'period'. For example, a value of 'days' with a 'period' of '1' results in one snapshot every day.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>at_time</maml:name> <maml:description> <maml:para>Time of day when snapshot should be taken. In case repeat frequency specifies more than one snapshot in a day then the until_time option specifies until what time of day to take snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>until_time</maml:name> <maml:description> <maml:para>Time of day to stop taking snapshots. Applicable only when repeat frequency specifies more than one snapshot in a day.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>days</maml:name> <maml:description> <maml:para>Specifies which days snapshots should be taken.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_retain</maml:name> <maml:description> <maml:para>Number of snapshots to retain. If replication is enabled on this schedule the array will always retain the latest replicated snapshot, which may exceed the specified retention value. This is necessary to ensure efficient replication performance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>downstream_partner</maml:name> <maml:description> <maml:para>Specifies the partner name if snapshots created by this schedule should be replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>downstream_partner_name</maml:name> <maml:description> <maml:para>Specifies the partner name if snapshots created by this schedule should be replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>downstream_partner_id</maml:name> <maml:description> <maml:para>Specifies the partner ID if snapshots created by this schedule should be replicated. In an update operation, if snapshots should be replicated, set this attribute to the ID of the replication partner. If snapshots should not be replicated, set this attribute to the empty string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>upstream_partner_name</maml:name> <maml:description> <maml:para>Specifies the partner name from which snapshots created by this schedule are replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>upstream_partner_id</maml:name> <maml:description> <maml:para>Specifies the partner ID from which snapshots created by this schedule are replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replicate_every</maml:name> <maml:description> <maml:para>Specifies which snapshots should be replicated. If snapshots are replicated and this option is not specified, every snapshot is replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_retain_replica</maml:name> <maml:description> <maml:para>Number of snapshots to retain on the replica.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_alert_thres</maml:name> <maml:description> <maml:para>Replication alert threshold in seconds. If the replication of a snapshot takes more than this amount of time to complete an alert will be generated. Enter 0 to disable this alert.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_verify</maml:name> <maml:description> <maml:para>Run verification tool on snapshot created by this schedule. This option can only be used with snapshot schedules of a protection template that has application synchronization. The tool used to verify snapshot depends on the type of application. For example, if application synchronization is VSS and the application ID is Exchange, eseutil tool is run on the snapshots. If verification fails, the logs are not truncated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>skip_db_consistency_check</maml:name> <maml:description> <maml:para>Skip consistency check for database files on snapshots created by this schedule. This option only applies to snapshot schedules of a protection template with application synchronization set to VSS, application ID set to MS Exchange 2010 or later w/DAG, this schedule's snap_verify option set to yes, and its disable_appsync option set to false. Skipping consistency checks is only recommended if each database in a DAG has multiple copies.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>disable_appsync</maml:name> <maml:description> <maml:para>Disables application synchronized snapshots and creates crash consistent snapshots instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>schedule_type</maml:name> <maml:description> <maml:para>Normal schedules have internal timers which drive snapshot creation. An externally driven schedule has no internal timers. All snapshot activity is driven by an external trigger. In other words, these schedules are used only for externally driven manual snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>active</maml:name> <maml:description> <maml:para>A schedule is active only if it is owned by the same owner as the volume collection. Only active schedules of a volume collection participate in the creation of snapshots and replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this protection schedule was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this protection schedule was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_mod_sched_time</maml:name> <maml:description> <maml:para>Time when the timing of the protection schedule was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_replicated_snapcoll_name</maml:name> <maml:description> <maml:para>Specifies the name of last replicated snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_replicated_snapcoll_id</maml:name> <maml:description> <maml:para>Specifies the snapshot collection ID of last replicated snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_replicated_at_time</maml:name> <maml:description> <maml:para>Time when last snapshot collection was replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_snap_time</maml:name> <maml:description> <maml:para>Time when last snapshot was taken.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>next_snap_time</maml:name> <maml:description> <maml:para>Time when next snapshot will be taken.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>next_repl_snap_time</maml:name> <maml:description> <maml:para>Time when next snapshot will be replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_counter</maml:name> <maml:description> <maml:para>This is only used by custom read handler for internal calculations.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sched_owner_id</maml:name> <maml:description> <maml:para>Identifier of the group that owns this schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sched_owner_name</maml:name> <maml:description> <maml:para>Name of the group that owns this schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_config_change_time</maml:name> <maml:description> <maml:para>The last timing configutation changed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>currently_replicating_snapcoll_name</maml:name> <maml:description> <maml:para>The name of the currently replicating snapshot collection if one exists, the empty string otherwise.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_status_list</maml:name> <maml:description> <maml:para>The list of the replication status of volumes undergoing replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sync_repl_vol_status_list</maml:name> <maml:description> <maml:para>A list of the replication status of volumes undergoing synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>use_downstream_for_DR</maml:name> <maml:description> <maml:para>Break synchronous replication for the specified volume collection and present downstream volumes to host(s). Downstream volumes in the volume collection will be set to online and presented to the host(s) using new serial and LUN numbers. No changes will be made to the upstream volumes, their serial and LUN numbers, and their online state. The existing ACLs on the upstream volumes will be copied to the downstream volumes. Use this in conjunction with an empty downstream_partner_id. This unconfigures synchronous replication when the partner is removed from the last replicating schedule in the specified volume collection and presents the downstream volumes to host(s). Host(s) will need to be configured to access the new volumes with the newly assigned serial and LUN numbers. Use this option to expose downstream volumes in a synchronously replicated volume collection to host(s) only when the upstream partner is confirmed to be down and there is no communication between partners. Do not execute this operation if a previous Group Management Service takeover has been performed on a different array. Do not perform a subsequent Group Management Service takeover on a different array as it will lead to irreconcilable conflicts. This limitation is cleared once the Group management service backup array has successfully synchronized after reconnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for protection schedule.</maml:para> </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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of snapshot schedule to create.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volcoll_or_prottmpl_type</maml:name> <maml:description> <maml:para>Type of the protection policy this schedule is attached to. Valid values are protection_template and volume_collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volcoll_or_prottmpl_id</maml:name> <maml:description> <maml:para>Identifier of the protection policy (protection_template or volume_collection) in which this protection schedule is attached to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>period</maml:name> <maml:description> <maml:para>Repeat interval for snapshots with respect to the period_unit. For example, a value of 2 with the 'period_unit' of 'hours' results in one snapshot every 2 hours.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>period_unit</maml:name> <maml:description> <maml:para>Time unit over which to take the number of snapshots specified in 'period'. For example, a value of 'days' with a 'period' of '1' results in one snapshot every day.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>at_time</maml:name> <maml:description> <maml:para>Time of day when snapshot should be taken. In case repeat frequency specifies more than one snapshot in a day then the until_time option specifies until what time of day to take snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>until_time</maml:name> <maml:description> <maml:para>Time of day to stop taking snapshots. Applicable only when repeat frequency specifies more than one snapshot in a day.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>days</maml:name> <maml:description> <maml:para>Specifies which days snapshots should be taken.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>num_retain</maml:name> <maml:description> <maml:para>Number of snapshots to retain. If replication is enabled on this schedule the array will always retain the latest replicated snapshot, which may exceed the specified retention value. This is necessary to ensure efficient replication performance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>downstream_partner</maml:name> <maml:description> <maml:para>Specifies the partner name if snapshots created by this schedule should be replicated.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>downstream_partner_name</maml:name> <maml:description> <maml:para>Specifies the partner name if snapshots created by this schedule should be replicated.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>downstream_partner_id</maml:name> <maml:description> <maml:para>Specifies the partner ID if snapshots created by this schedule should be replicated. In an update operation, if snapshots should be replicated, set this attribute to the ID of the replication partner. If snapshots should not be replicated, set this attribute to the empty string.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>upstream_partner_name</maml:name> <maml:description> <maml:para>Specifies the partner name from which snapshots created by this schedule are replicated.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>upstream_partner_id</maml:name> <maml:description> <maml:para>Specifies the partner ID from which snapshots created by this schedule are replicated.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>replicate_every</maml:name> <maml:description> <maml:para>Specifies which snapshots should be replicated. If snapshots are replicated and this option is not specified, every snapshot is replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_retain_replica</maml:name> <maml:description> <maml:para>Number of snapshots to retain on the replica.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_alert_thres</maml:name> <maml:description> <maml:para>Replication alert threshold in seconds. If the replication of a snapshot takes more than this amount of time to complete an alert will be generated. Enter 0 to disable this alert.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_verify</maml:name> <maml:description> <maml:para>Run verification tool on snapshot created by this schedule. This option can only be used with snapshot schedules of a protection template that has application synchronization. The tool used to verify snapshot depends on the type of application. For example, if application synchronization is VSS and the application ID is Exchange, eseutil tool is run on the snapshots. If verification fails, the logs are not truncated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>skip_db_consistency_check</maml:name> <maml:description> <maml:para>Skip consistency check for database files on snapshots created by this schedule. This option only applies to snapshot schedules of a protection template with application synchronization set to VSS, application ID set to MS Exchange 2010 or later w/DAG, this schedule's snap_verify option set to yes, and its disable_appsync option set to false. Skipping consistency checks is only recommended if each database in a DAG has multiple copies.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>disable_appsync</maml:name> <maml:description> <maml:para>Disables application synchronized snapshots and creates crash consistent snapshots instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>schedule_type</maml:name> <maml:description> <maml:para>Normal schedules have internal timers which drive snapshot creation. An externally driven schedule has no internal timers. All snapshot activity is driven by an external trigger. In other words, these schedules are used only for externally driven manual snapshots.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>active</maml:name> <maml:description> <maml:para>A schedule is active only if it is owned by the same owner as the volume collection. Only active schedules of a volume collection participate in the creation of snapshots and replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this protection schedule was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this protection schedule was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_mod_sched_time</maml:name> <maml:description> <maml:para>Time when the timing of the protection schedule was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_replicated_snapcoll_name</maml:name> <maml:description> <maml:para>Specifies the name of last replicated snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>last_replicated_snapcoll_id</maml:name> <maml:description> <maml:para>Specifies the snapshot collection ID of last replicated snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>last_replicated_at_time</maml:name> <maml:description> <maml:para>Time when last snapshot collection was replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_snap_time</maml:name> <maml:description> <maml:para>Time when last snapshot was taken.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>next_snap_time</maml:name> <maml:description> <maml:para>Time when next snapshot will be taken.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>next_repl_snap_time</maml:name> <maml:description> <maml:para>Time when next snapshot will be replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_counter</maml:name> <maml:description> <maml:para>This is only used by custom read handler for internal calculations.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>sched_owner_id</maml:name> <maml:description> <maml:para>Identifier of the group that owns this schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>sched_owner_name</maml:name> <maml:description> <maml:para>Name of the group that owns this schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>last_config_change_time</maml:name> <maml:description> <maml:para>The last timing configutation changed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>currently_replicating_snapcoll_name</maml:name> <maml:description> <maml:para>The name of the currently replicating snapshot collection if one exists, the empty string otherwise.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vol_status_list</maml:name> <maml:description> <maml:para>The list of the replication status of volumes undergoing replication.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>sync_repl_vol_status_list</maml:name> <maml:description> <maml:para>A list of the replication status of volumes undergoing synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>use_downstream_for_DR</maml:name> <maml:description> <maml:para>Break synchronous replication for the specified volume collection and present downstream volumes to host(s). Downstream volumes in the volume collection will be set to online and presented to the host(s) using new serial and LUN numbers. No changes will be made to the upstream volumes, their serial and LUN numbers, and their online state. The existing ACLs on the upstream volumes will be copied to the downstream volumes. Use this in conjunction with an empty downstream_partner_id. This unconfigures synchronous replication when the partner is removed from the last replicating schedule in the specified volume collection and presents the downstream volumes to host(s). Host(s) will need to be configured to access the new volumes with the newly assigned serial and LUN numbers. Use this option to expose downstream volumes in a synchronously replicated volume collection to host(s) only when the upstream partner is confirmed to be down and there is no communication between partners. Do not execute this operation if a previous Group Management Service takeover has been performed on a different array. Do not perform a subsequent Group Management Service takeover on a different array as it will lead to irreconcilable conflicts. This limitation is cleared once the Group management service backup array has successfully synchronized after reconnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSProtectionSchedule</command:name> <maml:description> <maml:para>Delete a protection schedule.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSProtectionSchedule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Delete a protection schedule.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for protection schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of snapshot schedule to create.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volcoll_or_prottmpl_type</maml:name> <maml:description> <maml:para>Type of the protection policy this schedule is attached to. Valid values are protection_template and volume_collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>volcoll_or_prottmpl_id</maml:name> <maml:description> <maml:para>Identifier of the protection policy (protection_template or volume_collection) in which this protection schedule is attached to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>period</maml:name> <maml:description> <maml:para>Repeat interval for snapshots with respect to the period_unit. For example, a value of 2 with the 'period_unit' of 'hours' results in one snapshot every 2 hours.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>period_unit</maml:name> <maml:description> <maml:para>Time unit over which to take the number of snapshots specified in 'period'. For example, a value of 'days' with a 'period' of '1' results in one snapshot every day.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>at_time</maml:name> <maml:description> <maml:para>Time of day when snapshot should be taken. In case repeat frequency specifies more than one snapshot in a day then the until_time option specifies until what time of day to take snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>until_time</maml:name> <maml:description> <maml:para>Time of day to stop taking snapshots. Applicable only when repeat frequency specifies more than one snapshot in a day.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>days</maml:name> <maml:description> <maml:para>Specifies which days snapshots should be taken.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_retain</maml:name> <maml:description> <maml:para>Number of snapshots to retain. If replication is enabled on this schedule the array will always retain the latest replicated snapshot, which may exceed the specified retention value. This is necessary to ensure efficient replication performance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>downstream_partner</maml:name> <maml:description> <maml:para>Specifies the partner name if snapshots created by this schedule should be replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>downstream_partner_name</maml:name> <maml:description> <maml:para>Specifies the partner name if snapshots created by this schedule should be replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>downstream_partner_id</maml:name> <maml:description> <maml:para>Specifies the partner ID if snapshots created by this schedule should be replicated. In an update operation, if snapshots should be replicated, set this attribute to the ID of the replication partner. If snapshots should not be replicated, set this attribute to the empty string.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>upstream_partner_name</maml:name> <maml:description> <maml:para>Specifies the partner name from which snapshots created by this schedule are replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>upstream_partner_id</maml:name> <maml:description> <maml:para>Specifies the partner ID from which snapshots created by this schedule are replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>replicate_every</maml:name> <maml:description> <maml:para>Specifies which snapshots should be replicated. If snapshots are replicated and this option is not specified, every snapshot is replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>num_retain_replica</maml:name> <maml:description> <maml:para>Number of snapshots to retain on the replica.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>repl_alert_thres</maml:name> <maml:description> <maml:para>Replication alert threshold in seconds. If the replication of a snapshot takes more than this amount of time to complete an alert will be generated. Enter 0 to disable this alert.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_verify</maml:name> <maml:description> <maml:para>Run verification tool on snapshot created by this schedule. This option can only be used with snapshot schedules of a protection template that has application synchronization. The tool used to verify snapshot depends on the type of application. For example, if application synchronization is VSS and the application ID is Exchange, eseutil tool is run on the snapshots. If verification fails, the logs are not truncated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>skip_db_consistency_check</maml:name> <maml:description> <maml:para>Skip consistency check for database files on snapshots created by this schedule. This option only applies to snapshot schedules of a protection template with application synchronization set to VSS, application ID set to MS Exchange 2010 or later w/DAG, this schedule's snap_verify option set to yes, and its disable_appsync option set to false. Skipping consistency checks is only recommended if each database in a DAG has multiple copies.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>disable_appsync</maml:name> <maml:description> <maml:para>Disables application synchronized snapshots and creates crash consistent snapshots instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>schedule_type</maml:name> <maml:description> <maml:para>Normal schedules have internal timers which drive snapshot creation. An externally driven schedule has no internal timers. All snapshot activity is driven by an external trigger. In other words, these schedules are used only for externally driven manual snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>active</maml:name> <maml:description> <maml:para>A schedule is active only if it is owned by the same owner as the volume collection. Only active schedules of a volume collection participate in the creation of snapshots and replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this protection schedule was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this protection schedule was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_mod_sched_time</maml:name> <maml:description> <maml:para>Time when the timing of the protection schedule was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_replicated_snapcoll_name</maml:name> <maml:description> <maml:para>Specifies the name of last replicated snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_replicated_snapcoll_id</maml:name> <maml:description> <maml:para>Specifies the snapshot collection ID of last replicated snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_replicated_at_time</maml:name> <maml:description> <maml:para>Time when last snapshot collection was replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_snap_time</maml:name> <maml:description> <maml:para>Time when last snapshot was taken.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>next_snap_time</maml:name> <maml:description> <maml:para>Time when next snapshot will be taken.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>next_repl_snap_time</maml:name> <maml:description> <maml:para>Time when next snapshot will be replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_counter</maml:name> <maml:description> <maml:para>This is only used by custom read handler for internal calculations.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sched_owner_id</maml:name> <maml:description> <maml:para>Identifier of the group that owns this schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sched_owner_name</maml:name> <maml:description> <maml:para>Name of the group that owns this schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_config_change_time</maml:name> <maml:description> <maml:para>The last timing configutation changed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>currently_replicating_snapcoll_name</maml:name> <maml:description> <maml:para>The name of the currently replicating snapshot collection if one exists, the empty string otherwise.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_status_list</maml:name> <maml:description> <maml:para>The list of the replication status of volumes undergoing replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>sync_repl_vol_status_list</maml:name> <maml:description> <maml:para>A list of the replication status of volumes undergoing synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSProtectionSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>use_downstream_for_DR</maml:name> <maml:description> <maml:para>Break synchronous replication for the specified volume collection and present downstream volumes to host(s). Downstream volumes in the volume collection will be set to online and presented to the host(s) using new serial and LUN numbers. No changes will be made to the upstream volumes, their serial and LUN numbers, and their online state. The existing ACLs on the upstream volumes will be copied to the downstream volumes. Use this in conjunction with an empty downstream_partner_id. This unconfigures synchronous replication when the partner is removed from the last replicating schedule in the specified volume collection and presents the downstream volumes to host(s). Host(s) will need to be configured to access the new volumes with the newly assigned serial and LUN numbers. Use this option to expose downstream volumes in a synchronously replicated volume collection to host(s) only when the upstream partner is confirmed to be down and there is no communication between partners. Do not execute this operation if a previous Group Management Service takeover has been performed on a different array. Do not perform a subsequent Group Management Service takeover on a different array as it will lead to irreconcilable conflicts. This limitation is cleared once the Group management service backup array has successfully synchronized after reconnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for protection schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of snapshot schedule to create.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volcoll_or_prottmpl_type</maml:name> <maml:description> <maml:para>Type of the protection policy this schedule is attached to. Valid values are protection_template and volume_collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>volcoll_or_prottmpl_id</maml:name> <maml:description> <maml:para>Identifier of the protection policy (protection_template or volume_collection) in which this protection schedule is attached to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>period</maml:name> <maml:description> <maml:para>Repeat interval for snapshots with respect to the period_unit. For example, a value of 2 with the 'period_unit' of 'hours' results in one snapshot every 2 hours.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>period_unit</maml:name> <maml:description> <maml:para>Time unit over which to take the number of snapshots specified in 'period'. For example, a value of 'days' with a 'period' of '1' results in one snapshot every day.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>at_time</maml:name> <maml:description> <maml:para>Time of day when snapshot should be taken. In case repeat frequency specifies more than one snapshot in a day then the until_time option specifies until what time of day to take snapshots.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>until_time</maml:name> <maml:description> <maml:para>Time of day to stop taking snapshots. Applicable only when repeat frequency specifies more than one snapshot in a day.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>days</maml:name> <maml:description> <maml:para>Specifies which days snapshots should be taken.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>num_retain</maml:name> <maml:description> <maml:para>Number of snapshots to retain. If replication is enabled on this schedule the array will always retain the latest replicated snapshot, which may exceed the specified retention value. This is necessary to ensure efficient replication performance.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>downstream_partner</maml:name> <maml:description> <maml:para>Specifies the partner name if snapshots created by this schedule should be replicated.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>downstream_partner_name</maml:name> <maml:description> <maml:para>Specifies the partner name if snapshots created by this schedule should be replicated.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>downstream_partner_id</maml:name> <maml:description> <maml:para>Specifies the partner ID if snapshots created by this schedule should be replicated. In an update operation, if snapshots should be replicated, set this attribute to the ID of the replication partner. If snapshots should not be replicated, set this attribute to the empty string.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>upstream_partner_name</maml:name> <maml:description> <maml:para>Specifies the partner name from which snapshots created by this schedule are replicated.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>upstream_partner_id</maml:name> <maml:description> <maml:para>Specifies the partner ID from which snapshots created by this schedule are replicated.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>replicate_every</maml:name> <maml:description> <maml:para>Specifies which snapshots should be replicated. If snapshots are replicated and this option is not specified, every snapshot is replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>num_retain_replica</maml:name> <maml:description> <maml:para>Number of snapshots to retain on the replica.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>repl_alert_thres</maml:name> <maml:description> <maml:para>Replication alert threshold in seconds. If the replication of a snapshot takes more than this amount of time to complete an alert will be generated. Enter 0 to disable this alert.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_verify</maml:name> <maml:description> <maml:para>Run verification tool on snapshot created by this schedule. This option can only be used with snapshot schedules of a protection template that has application synchronization. The tool used to verify snapshot depends on the type of application. For example, if application synchronization is VSS and the application ID is Exchange, eseutil tool is run on the snapshots. If verification fails, the logs are not truncated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>skip_db_consistency_check</maml:name> <maml:description> <maml:para>Skip consistency check for database files on snapshots created by this schedule. This option only applies to snapshot schedules of a protection template with application synchronization set to VSS, application ID set to MS Exchange 2010 or later w/DAG, this schedule's snap_verify option set to yes, and its disable_appsync option set to false. Skipping consistency checks is only recommended if each database in a DAG has multiple copies.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>disable_appsync</maml:name> <maml:description> <maml:para>Disables application synchronized snapshots and creates crash consistent snapshots instead.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>schedule_type</maml:name> <maml:description> <maml:para>Normal schedules have internal timers which drive snapshot creation. An externally driven schedule has no internal timers. All snapshot activity is driven by an external trigger. In other words, these schedules are used only for externally driven manual snapshots.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>active</maml:name> <maml:description> <maml:para>A schedule is active only if it is owned by the same owner as the volume collection. Only active schedules of a volume collection participate in the creation of snapshots and replication.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this protection schedule was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this protection schedule was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_mod_sched_time</maml:name> <maml:description> <maml:para>Time when the timing of the protection schedule was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_replicated_snapcoll_name</maml:name> <maml:description> <maml:para>Specifies the name of last replicated snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>last_replicated_snapcoll_id</maml:name> <maml:description> <maml:para>Specifies the snapshot collection ID of last replicated snapshot collection.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>last_replicated_at_time</maml:name> <maml:description> <maml:para>Time when last snapshot collection was replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_snap_time</maml:name> <maml:description> <maml:para>Time when last snapshot was taken.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>next_snap_time</maml:name> <maml:description> <maml:para>Time when next snapshot will be taken.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>next_repl_snap_time</maml:name> <maml:description> <maml:para>Time when next snapshot will be replicated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_counter</maml:name> <maml:description> <maml:para>This is only used by custom read handler for internal calculations.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>sched_owner_id</maml:name> <maml:description> <maml:para>Identifier of the group that owns this schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>sched_owner_name</maml:name> <maml:description> <maml:para>Name of the group that owns this schedule.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>last_config_change_time</maml:name> <maml:description> <maml:para>The last timing configutation changed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>currently_replicating_snapcoll_name</maml:name> <maml:description> <maml:para>The name of the currently replicating snapshot collection if one exists, the empty string otherwise.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vol_status_list</maml:name> <maml:description> <maml:para>The list of the replication status of volumes undergoing replication.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>sync_repl_vol_status_list</maml:name> <maml:description> <maml:para>A list of the replication status of volumes undergoing synchronous replication.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>use_downstream_for_DR</maml:name> <maml:description> <maml:para>Break synchronous replication for the specified volume collection and present downstream volumes to host(s). Downstream volumes in the volume collection will be set to online and presented to the host(s) using new serial and LUN numbers. No changes will be made to the upstream volumes, their serial and LUN numbers, and their online state. The existing ACLs on the upstream volumes will be copied to the downstream volumes. Use this in conjunction with an empty downstream_partner_id. This unconfigures synchronous replication when the partner is removed from the last replicating schedule in the specified volume collection and presents the downstream volumes to host(s). Host(s) will need to be configured to access the new volumes with the newly assigned serial and LUN numbers. Use this option to expose downstream volumes in a synchronously replicated volume collection to host(s) only when the upstream partner is confirmed to be down and there is no communication between partners. Do not execute this operation if a previous Group Management Service takeover has been performed on a different array. Do not perform a subsequent Group Management Service takeover on a different array as it will lead to irreconcilable conflicts. This limitation is cleared once the Group management service backup array has successfully synchronized after reconnection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSApplicationCategory</command:name> <maml:description> <maml:para>Lists application categories.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSApplicationCategory</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Lists application categories.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSApplicationCategory</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the application category.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSApplicationCategory</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of application category.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSApplicationCategory</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_enabled</maml:name> <maml:description> <maml:para>Specifies if dedupe is enabled for performance policies associated with this application category.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSApplicationCategory</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this application category was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSApplicationCategory</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this application category was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the application category.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of application category.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>dedupe_enabled</maml:name> <maml:description> <maml:para>Specifies if dedupe is enabled for performance policies associated with this application category.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this application category was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this application category was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSApplicatinCategory name id ---- -- Exchange 390000000000000000000000000000000000000001 Oracle 390000000000000000000000000000000000000002 SQL Server 390000000000000000000000000000000000000003 DB2 390000000000000000000000000000000000000004 SharePoint 390000000000000000000000000000000000000005 Virtual Server 390000000000000000000000000000000000000006 Virtual Desktop 390000000000000000000000000000000000000007 File Server 390000000000000000000000000000000000000008 Other 390000000000000000000000000000000000000009 Unassigned 39000000000000000000000000000000000000000a Backup 39000000000000000000000000000000000000000b </dev:code> <dev:remarks> <maml:para>This command will retrieves list of current Application Categories. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 2 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSApplicatinCategory -name Exchange name id ---- -- Exchange 390000000000000000000000000000000000000001 </dev:code> <dev:remarks> <maml:para>This command will retrieve a specific Application Category specified by name. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSAuditLog</command:name> <maml:description> <maml:para>List a set of audit log entries or a single audit log record.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSAuditLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List a set of audit log entries or a single audit log record.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSAuditLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the audit log record.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAuditLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>Identifier for type of audit log record.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAuditLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>object_id</maml:name> <maml:description> <maml:para>Identifier of object operated upon.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAuditLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>object_name</maml:name> <maml:description> <maml:para>Name of object operated upon.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAuditLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>object_type</maml:name> <maml:description> <maml:para>Type of the object being operated upon.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAuditLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>scope</maml:name> <maml:description> <maml:para>Scope within which object exists, for example, name of the array for a NIC.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAuditLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>time</maml:name> <maml:description> <maml:para>Time when this operation was performed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAuditLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Status of the operation -- success or failure.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAuditLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>error_code</maml:name> <maml:description> <maml:para>If the operation has failed, this indicates the error code corresponding to the failure.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAuditLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user_id</maml:name> <maml:description> <maml:para>Identifier of the user who performed the operation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAuditLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user_name</maml:name> <maml:description> <maml:para>Username of the user who performed the operation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAuditLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user_full_name</maml:name> <maml:description> <maml:para>Full name of the user who performed the operation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAuditLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>source_ip</maml:name> <maml:description> <maml:para>IP address from where the operation request originated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAuditLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ext_user_id</maml:name> <maml:description> <maml:para>The user id of an external user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAuditLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ext_user_group_id</maml:name> <maml:description> <maml:para>The group ID of an external user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAuditLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ext_user_group_name</maml:name> <maml:description> <maml:para>The group name of an external user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAuditLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>app_name</maml:name> <maml:description> <maml:para>Name of application from where the operation request was issued, for example, pam, VSS Agent, etc.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAuditLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>access_type</maml:name> <maml:description> <maml:para>Name of access on how the operation request was issued, for example, GUI, CLI or API.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAuditLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>category</maml:name> <maml:description> <maml:para>Category of the audit log record.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAuditLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>activity_type</maml:name> <maml:description> <maml:para>Type of activity performed, for example, create, update or delete.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAuditLog</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>activity</maml:name> <maml:description> <maml:para>Description of activity performed and recorded in audit log.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the audit log record.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>Identifier for type of audit log record.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>object_id</maml:name> <maml:description> <maml:para>Identifier of object operated upon.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>object_name</maml:name> <maml:description> <maml:para>Name of object operated upon.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>object_type</maml:name> <maml:description> <maml:para>Type of the object being operated upon.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>scope</maml:name> <maml:description> <maml:para>Scope within which object exists, for example, name of the array for a NIC.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>time</maml:name> <maml:description> <maml:para>Time when this operation was performed.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Status of the operation -- success or failure.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>error_code</maml:name> <maml:description> <maml:para>If the operation has failed, this indicates the error code corresponding to the failure.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>user_id</maml:name> <maml:description> <maml:para>Identifier of the user who performed the operation.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>user_name</maml:name> <maml:description> <maml:para>Username of the user who performed the operation.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>user_full_name</maml:name> <maml:description> <maml:para>Full name of the user who performed the operation.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>source_ip</maml:name> <maml:description> <maml:para>IP address from where the operation request originated.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>ext_user_id</maml:name> <maml:description> <maml:para>The user id of an external user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>ext_user_group_id</maml:name> <maml:description> <maml:para>The group ID of an external user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>ext_user_group_name</maml:name> <maml:description> <maml:para>The group name of an external user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>app_name</maml:name> <maml:description> <maml:para>Name of application from where the operation request was issued, for example, pam, VSS Agent, etc.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>access_type</maml:name> <maml:description> <maml:para>Name of access on how the operation request was issued, for example, GUI, CLI or API.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>category</maml:name> <maml:description> <maml:para>Category of the audit log record.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>activity_type</maml:name> <maml:description> <maml:para>Type of activity performed, for example, create, update or delete.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>activity</maml:name> <maml:description> <maml:para>Description of activity performed and recorded in audit log.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSAuditLog user_name activity category status time --------- -------- -------- ------ ---- admin Login attempt user_access succeeded 1513640687 admin Complete setup on group g... system_configuration succeeded 1513640688 admin Login attempt user_access succeeded 1513640721 admin Create volume CHAPI-Testvol1 data_provisioning succeeded 1513640935 admin Add ACL for volume CHAPI-... data_access succeeded 1513640935 </dev:code> <dev:remarks> <maml:para>This command will retrieves list of audit log entries. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 2 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSAuditLog -status failed user_name activity category status time --------- -------- -------- ------ ---- admin Validate network configur... system_configuration failed 1513671364 admin Validate network configur... system_configuration failed 1513759916 admin Validate network configur... system_configuration failed 1513845695 admin Validate network configur... system_configuration failed 1513929821 admin Validate network configur... system_configuration failed 1514018428 </dev:code> <dev:remarks> <maml:para>This command will retrieves list of audit log entries that are marked as failed status. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSJob</command:name> <maml:description> <maml:para>Read a set of jobs or a single job.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSJob</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Read a set of jobs or a single job.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>completion_time</maml:name> <maml:description> <maml:para>Completion time of the job.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this job was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>current_phase</maml:name> <maml:description> <maml:para>Phase number of the job in progress.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>current_phase_description</maml:name> <maml:description> <maml:para>Description of the current phase of the job.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the job.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for job.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the job.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time of the last update from the job.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>object_id</maml:name> <maml:description> <maml:para>Identifier for object being acted upon.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>op_type</maml:name> <maml:description> <maml:para>Type of operation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>Job type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>parent_job_id</maml:name> <maml:description> <maml:para>Identifier of parent job.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>percent_complete</maml:name> <maml:description> <maml:para>Progress of the job as a percentage.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>request</maml:name> <maml:description> <maml:para>Original request that the job is responsible for.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>response</maml:name> <maml:description> <maml:para>Response from the operation as the job executes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>state</maml:name> <maml:description> <maml:para>Status of the job.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>result</maml:name> <maml:description> <maml:para>Result of the job.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>total_phases</maml:name> <maml:description> <maml:para>Total number of phases of the job.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>completion_time</maml:name> <maml:description> <maml:para>Completion time of the job.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this job was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>current_phase</maml:name> <maml:description> <maml:para>Phase number of the job in progress.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>current_phase_description</maml:name> <maml:description> <maml:para>Description of the current phase of the job.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the job.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for job.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the job.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time of the last update from the job.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>object_id</maml:name> <maml:description> <maml:para>Identifier for object being acted upon.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>op_type</maml:name> <maml:description> <maml:para>Type of operation.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>Job type.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>parent_job_id</maml:name> <maml:description> <maml:para>Identifier of parent job.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>percent_complete</maml:name> <maml:description> <maml:para>Progress of the job as a percentage.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>request</maml:name> <maml:description> <maml:para>Original request that the job is responsible for.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>response</maml:name> <maml:description> <maml:para>Response from the operation as the job executes.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>state</maml:name> <maml:description> <maml:para>Status of the job.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>result</maml:name> <maml:description> <maml:para>Result of the job.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>total_phases</maml:name> <maml:description> <maml:para>Total number of phases of the job.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSDisk</command:name> <maml:description> <maml:para>Retrieve information about a set of disks or a single disk.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSDisk</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Retrieve information about a set of disks or a single disk.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of disk.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_dfc</maml:name> <maml:description> <maml:para>Is disk part of dual flash carrier.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>serial</maml:name> <maml:description> <maml:para>Disk serial number(N/A if empty).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>path</maml:name> <maml:description> <maml:para>Disk SCSI device path.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>shelf_serial</maml:name> <maml:description> <maml:para>Serial number of the shelf the disk is attached to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>shelf_location</maml:name> <maml:description> <maml:para>Identifies the controller, port, and chain position of the shelf the disk belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>shelf_id</maml:name> <maml:description> <maml:para>Identifies the physical shelf the disk belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>shelf_location_id</maml:name> <maml:description> <maml:para>Identifies the position shelf the disk belongs to, as coded integer.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vshelf_id</maml:name> <maml:description> <maml:para>Identifies the local shelf ID the disk belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>slot</maml:name> <maml:description> <maml:para>Disk slot number.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>bank</maml:name> <maml:description> <maml:para>Disk bank number.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>model</maml:name> <maml:description> <maml:para>Disk model name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vendor</maml:name> <maml:description> <maml:para>Vendor name of the disk manufacturer.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>firmware_version</maml:name> <maml:description> <maml:para>Firmware version on the disk.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>hba</maml:name> <maml:description> <maml:para>HBA ID the disk is connected to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>HBA port number the disk is connected to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>size</maml:name> <maml:description> <maml:para>Disk size in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>state</maml:name> <maml:description> <maml:para>Disk hardware state.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>Type of disk (HDD, SSD, N/A).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>block_type</maml:name> <maml:description> <maml:para>Native block type of the disk.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>raid_id</maml:name> <maml:description> <maml:para>Raid ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>raid_resync_percent</maml:name> <maml:description> <maml:para>Percentage RAID rebuild completed on this disk.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>raid_resync_current_speed</maml:name> <maml:description> <maml:para>Current RAID rebuild speed (bytes/sec).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>raid_resync_average_speed</maml:name> <maml:description> <maml:para>Average RAID rebuild speed (bytes/sec).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>raid_state</maml:name> <maml:description> <maml:para>RAID status for the disk (N/A, okay, resynchronizing, spare, faulty).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>disk_internal_stat_1</maml:name> <maml:description> <maml:para>Internal disk statistic 1.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>smart_attribute_list</maml:name> <maml:description> <maml:para>S.M.A.R.T. attributes for the disk.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>disk_op</maml:name> <maml:description> <maml:para>The intended operation to be performed on the specified disk.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly add a disk.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_name</maml:name> <maml:description> <maml:para>Name of array the disk belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_id</maml:name> <maml:description> <maml:para>ID of array the disk belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>partial_response_ok</maml:name> <maml:description> <maml:para>Indicate that it is okay to provide partially available response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of disk.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>is_dfc</maml:name> <maml:description> <maml:para>Is disk part of dual flash carrier.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>serial</maml:name> <maml:description> <maml:para>Disk serial number(N/A if empty).</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>path</maml:name> <maml:description> <maml:para>Disk SCSI device path.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>shelf_serial</maml:name> <maml:description> <maml:para>Serial number of the shelf the disk is attached to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>shelf_location</maml:name> <maml:description> <maml:para>Identifies the controller, port, and chain position of the shelf the disk belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>shelf_id</maml:name> <maml:description> <maml:para>Identifies the physical shelf the disk belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>shelf_location_id</maml:name> <maml:description> <maml:para>Identifies the position shelf the disk belongs to, as coded integer.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vshelf_id</maml:name> <maml:description> <maml:para>Identifies the local shelf ID the disk belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>slot</maml:name> <maml:description> <maml:para>Disk slot number.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>bank</maml:name> <maml:description> <maml:para>Disk bank number.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>model</maml:name> <maml:description> <maml:para>Disk model name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vendor</maml:name> <maml:description> <maml:para>Vendor name of the disk manufacturer.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>firmware_version</maml:name> <maml:description> <maml:para>Firmware version on the disk.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>hba</maml:name> <maml:description> <maml:para>HBA ID the disk is connected to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>HBA port number the disk is connected to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>size</maml:name> <maml:description> <maml:para>Disk size in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>state</maml:name> <maml:description> <maml:para>Disk hardware state.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>Type of disk (HDD, SSD, N/A).</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>block_type</maml:name> <maml:description> <maml:para>Native block type of the disk.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>raid_id</maml:name> <maml:description> <maml:para>Raid ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>raid_resync_percent</maml:name> <maml:description> <maml:para>Percentage RAID rebuild completed on this disk.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>raid_resync_current_speed</maml:name> <maml:description> <maml:para>Current RAID rebuild speed (bytes/sec).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>raid_resync_average_speed</maml:name> <maml:description> <maml:para>Average RAID rebuild speed (bytes/sec).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>raid_state</maml:name> <maml:description> <maml:para>RAID status for the disk (N/A, okay, resynchronizing, spare, faulty).</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>disk_internal_stat_1</maml:name> <maml:description> <maml:para>Internal disk statistic 1.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>smart_attribute_list</maml:name> <maml:description> <maml:para>S.M.A.R.T. attributes for the disk.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>disk_op</maml:name> <maml:description> <maml:para>The intended operation to be performed on the specified disk.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly add a disk.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>array_name</maml:name> <maml:description> <maml:para>Name of array the disk belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>array_id</maml:name> <maml:description> <maml:para>ID of array the disk belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>partial_response_ok</maml:name> <maml:description> <maml:para>Indicate that it is okay to provide partially available response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSDisk model id serial shelf_serial slot size ----- -- ------ ------------ ---- ---- Virtual disk 2c28eada7f8dd99d3b0001000000000b0000000100 /dev/sdb chapi-afa-a1 1 21474836480 Virtual disk 2c28eada7f8dd99d3b0001000000000b0000000200 /dev/sdc chapi-afa-a1 2 21474836480 Virtual disk 2c28eada7f8dd99d3b0001000000000b0000000300 /dev/sdd chapi-afa-a1 3 21474836480 Virtual disk 2c28eada7f8dd99d3b0001000000000b0000000400 /dev/sde chapi-afa-a1 4 21474836480 Virtual disk 2c28eada7f8dd99d3b0001000000000b0000000500 /dev/sdf chapi-afa-a1 5 21474836480 </dev:code> <dev:remarks> <maml:para>This command will retrieve the disk inventory. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSDisk</command:name> <maml:description> <maml:para>Add or remove a disk.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSDisk</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Add or remove a disk.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of disk.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_dfc</maml:name> <maml:description> <maml:para>Is disk part of dual flash carrier.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>serial</maml:name> <maml:description> <maml:para>Disk serial number(N/A if empty).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>path</maml:name> <maml:description> <maml:para>Disk SCSI device path.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>shelf_serial</maml:name> <maml:description> <maml:para>Serial number of the shelf the disk is attached to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>shelf_location</maml:name> <maml:description> <maml:para>Identifies the controller, port, and chain position of the shelf the disk belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>shelf_id</maml:name> <maml:description> <maml:para>Identifies the physical shelf the disk belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>shelf_location_id</maml:name> <maml:description> <maml:para>Identifies the position shelf the disk belongs to, as coded integer.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vshelf_id</maml:name> <maml:description> <maml:para>Identifies the local shelf ID the disk belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>slot</maml:name> <maml:description> <maml:para>Disk slot number.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>bank</maml:name> <maml:description> <maml:para>Disk bank number.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>model</maml:name> <maml:description> <maml:para>Disk model name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vendor</maml:name> <maml:description> <maml:para>Vendor name of the disk manufacturer.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>firmware_version</maml:name> <maml:description> <maml:para>Firmware version on the disk.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>hba</maml:name> <maml:description> <maml:para>HBA ID the disk is connected to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>HBA port number the disk is connected to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>size</maml:name> <maml:description> <maml:para>Disk size in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>state</maml:name> <maml:description> <maml:para>Disk hardware state.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>Type of disk (HDD, SSD, N/A).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>block_type</maml:name> <maml:description> <maml:para>Native block type of the disk.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>raid_id</maml:name> <maml:description> <maml:para>Raid ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>raid_resync_percent</maml:name> <maml:description> <maml:para>Percentage RAID rebuild completed on this disk.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>raid_resync_current_speed</maml:name> <maml:description> <maml:para>Current RAID rebuild speed (bytes/sec).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>raid_resync_average_speed</maml:name> <maml:description> <maml:para>Average RAID rebuild speed (bytes/sec).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>raid_state</maml:name> <maml:description> <maml:para>RAID status for the disk (N/A, okay, resynchronizing, spare, faulty).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>disk_internal_stat_1</maml:name> <maml:description> <maml:para>Internal disk statistic 1.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>smart_attribute_list</maml:name> <maml:description> <maml:para>S.M.A.R.T. attributes for the disk.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>disk_op</maml:name> <maml:description> <maml:para>The intended operation to be performed on the specified disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly add a disk.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_name</maml:name> <maml:description> <maml:para>Name of array the disk belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_id</maml:name> <maml:description> <maml:para>ID of array the disk belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSDisk</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>partial_response_ok</maml:name> <maml:description> <maml:para>Indicate that it is okay to provide partially available response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of disk.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>is_dfc</maml:name> <maml:description> <maml:para>Is disk part of dual flash carrier.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>serial</maml:name> <maml:description> <maml:para>Disk serial number(N/A if empty).</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>path</maml:name> <maml:description> <maml:para>Disk SCSI device path.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>shelf_serial</maml:name> <maml:description> <maml:para>Serial number of the shelf the disk is attached to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>shelf_location</maml:name> <maml:description> <maml:para>Identifies the controller, port, and chain position of the shelf the disk belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>shelf_id</maml:name> <maml:description> <maml:para>Identifies the physical shelf the disk belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>shelf_location_id</maml:name> <maml:description> <maml:para>Identifies the position shelf the disk belongs to, as coded integer.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vshelf_id</maml:name> <maml:description> <maml:para>Identifies the local shelf ID the disk belongs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>slot</maml:name> <maml:description> <maml:para>Disk slot number.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>bank</maml:name> <maml:description> <maml:para>Disk bank number.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>model</maml:name> <maml:description> <maml:para>Disk model name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>vendor</maml:name> <maml:description> <maml:para>Vendor name of the disk manufacturer.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>firmware_version</maml:name> <maml:description> <maml:para>Firmware version on the disk.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>hba</maml:name> <maml:description> <maml:para>HBA ID the disk is connected to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>HBA port number the disk is connected to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>size</maml:name> <maml:description> <maml:para>Disk size in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>state</maml:name> <maml:description> <maml:para>Disk hardware state.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>Type of disk (HDD, SSD, N/A).</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>block_type</maml:name> <maml:description> <maml:para>Native block type of the disk.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>raid_id</maml:name> <maml:description> <maml:para>Raid ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>raid_resync_percent</maml:name> <maml:description> <maml:para>Percentage RAID rebuild completed on this disk.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>raid_resync_current_speed</maml:name> <maml:description> <maml:para>Current RAID rebuild speed (bytes/sec).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>raid_resync_average_speed</maml:name> <maml:description> <maml:para>Average RAID rebuild speed (bytes/sec).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>raid_state</maml:name> <maml:description> <maml:para>RAID status for the disk (N/A, okay, resynchronizing, spare, faulty).</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>disk_internal_stat_1</maml:name> <maml:description> <maml:para>Internal disk statistic 1.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>smart_attribute_list</maml:name> <maml:description> <maml:para>S.M.A.R.T. attributes for the disk.</maml:para> </maml:description> <command:parameterValue required="false" 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="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>disk_op</maml:name> <maml:description> <maml:para>The intended operation to be performed on the specified disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly add a disk.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>array_name</maml:name> <maml:description> <maml:para>Name of array the disk belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>array_id</maml:name> <maml:description> <maml:para>ID of array the disk belongs to.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>partial_response_ok</maml:name> <maml:description> <maml:para>Indicate that it is okay to provide partially available response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Set-NSdisk -id 2c28eada7f8dd99d3b0001000000000b0000000200 -disk_op remove model id serial shelf_serial slot size ----- -- ------ ------------ ---- ---- Virtual disk 2c28eada7f8dd99d3b0001000000000b0000000200 /dev/sdc chapi-afa-a1 2 21474836480 </dev:code> <dev:remarks> <maml:para>This command will prepair a disk for removal from the array. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 2 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Set-NSdisk -id 2c28eada7f8dd99d3b0001000000000b0000000200 -disk_op add model id serial shelf_serial slot size ----- -- ------ ------------ ---- ---- Virtual disk 2c28eada7f8dd99d3b0001000000000b0000000200 /dev/sdc chapi-afa-a1 2 21474836480 </dev:code> <dev:remarks> <maml:para>This command will add a previously removed disk to the array. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSNetworkInterface</command:name> <maml:description> <maml:para>List a set of network interfaces or a single network interface.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSNetworkInterface</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List a set of network interfaces or a single network interface.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSNetworkInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_name_or_serial</maml:name> <maml:description> <maml:para>Name or serial of the array where the interface is hosted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>partial_response_ok</maml:name> <maml:description> <maml:para>Indicate that it is ok to provide partially available response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_id</maml:name> <maml:description> <maml:para>Identifier for the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>controller_name</maml:name> <maml:description> <maml:para>Name (A or B) of the controller where the interface is hosted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>controller_id</maml:name> <maml:description> <maml:para>Identifier of the controller where the interface is hosted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>mac</maml:name> <maml:description> <maml:para>MAC address of the interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_present</maml:name> <maml:description> <maml:para>Whether this interface is present on this controller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>link_speed</maml:name> <maml:description> <maml:para>Speed of the link.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>link_status</maml:name> <maml:description> <maml:para>Status of the link.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>mtu</maml:name> <maml:description> <maml:para>MTU on the link.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>Port number for this interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>slot</maml:name> <maml:description> <maml:para>Slot number for this interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>max_link_speed</maml:name> <maml:description> <maml:para>Maximum speed of the link.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>nic_type</maml:name> <maml:description> <maml:para>Interface type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSNetworkInterface</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ip_list</maml:name> <maml:description> <maml:para>List of IP addresses assigned to this network interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the interface.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>array_name_or_serial</maml:name> <maml:description> <maml:para>Name or serial of the array where the interface is hosted.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>partial_response_ok</maml:name> <maml:description> <maml:para>Indicate that it is ok to provide partially available response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>array_id</maml:name> <maml:description> <maml:para>Identifier for the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>controller_name</maml:name> <maml:description> <maml:para>Name (A or B) of the controller where the interface is hosted.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>controller_id</maml:name> <maml:description> <maml:para>Identifier of the controller where the interface is hosted.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the interface.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>mac</maml:name> <maml:description> <maml:para>MAC address of the interface.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>is_present</maml:name> <maml:description> <maml:para>Whether this interface is present on this controller.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>link_speed</maml:name> <maml:description> <maml:para>Speed of the link.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>link_status</maml:name> <maml:description> <maml:para>Status of the link.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>mtu</maml:name> <maml:description> <maml:para>MTU on the link.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>port</maml:name> <maml:description> <maml:para>Port number for this interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>slot</maml:name> <maml:description> <maml:para>Slot number for this interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>max_link_speed</maml:name> <maml:description> <maml:para>Maximum speed of the link.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>nic_type</maml:name> <maml:description> <maml:para>Interface type.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>ip_list</maml:name> <maml:description> <maml:para>List of IP addresses assigned to this network interface.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSNetworkInterface id name array_id array_name_or_serial controller_id -- ---- -------- -------------------- ------------- 1c28eada7f8dd99d3b00000001000000... eth1 0928eada7f8dd99d3b00000000000000... chapi-afa-a1 c328eada7f8dd99d3b000... 1c28eada7f8dd99d3b00000001000000... eth2 0928eada7f8dd99d3b00000000000000... chapi-afa-a1 c328eada7f8dd99d3b000... 1c28eada7f8dd99d3b00000001000000... eth3 0928eada7f8dd99d3b00000000000000... chapi-afa-a1 c328eada7f8dd99d3b000... </dev:code> <dev:remarks> <maml:para>This command will retrieve the NetworkInterface from the array. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSSoftwareVersion</command:name> <maml:description> <maml:para>Read software versions.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSSoftwareVersion</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Read software versions.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSSoftwareVersion</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>version</maml:name> <maml:description> <maml:para>Software version, used as identifier in URL.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSoftwareVersion</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>signature</maml:name> <maml:description> <maml:para>Keyed hash of download package.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSoftwareVersion</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of version.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSoftwareVersion</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Status of version.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSoftwareVersion</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>total_bytes</maml:name> <maml:description> <maml:para>Size of version.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSoftwareVersion</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>downloaded_bytes</maml:name> <maml:description> <maml:para>Number of bytes downloaded for the version.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSoftwareVersion</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>blacklist_reason</maml:name> <maml:description> <maml:para>Reason for blacklisting the version. Empty if version is not blacklisted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSoftwareVersion</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>release_date</maml:name> <maml:description> <maml:para>Date when software version was released.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSoftwareVersion</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_manually_downloaded</maml:name> <maml:description> <maml:para>Whether or not the version was downloaded manually.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSoftwareVersion</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>release_status</maml:name> <maml:description> <maml:para>Release status of software version.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSSoftwareVersion</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>no_partial_response</maml:name> <maml:description> <maml:para>Indicate that it is not ok to provide partially available response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>version</maml:name> <maml:description> <maml:para>Software version, used as identifier in URL.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>signature</maml:name> <maml:description> <maml:para>Keyed hash of download package.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of version.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Status of version.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>total_bytes</maml:name> <maml:description> <maml:para>Size of version.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>downloaded_bytes</maml:name> <maml:description> <maml:para>Number of bytes downloaded for the version.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>blacklist_reason</maml:name> <maml:description> <maml:para>Reason for blacklisting the version. Empty if version is not blacklisted.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>release_date</maml:name> <maml:description> <maml:para>Date when software version was released.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_manually_downloaded</maml:name> <maml:description> <maml:para>Whether or not the version was downloaded manually.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>release_status</maml:name> <maml:description> <maml:para>Release status of software version.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>no_partial_response</maml:name> <maml:description> <maml:para>Indicate that it is not ok to provide partially available response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSFibreChannelConfig</command:name> <maml:description> <maml:para>List the Fibre Channel configuration.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSFibreChannelConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List the Fibre Channel configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSFibreChannelConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for Fibre Channel configuration.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array_list</maml:name> <maml:description> <maml:para>List of array Fibre Channel configs.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSFibreChannelConfig</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group_leader_array</maml:name> <maml:description> <maml:para>Name of the group leader array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for Fibre Channel configuration.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>array_list</maml:name> <maml:description> <maml:para>List of array Fibre Channel configs.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>group_leader_array</maml:name> <maml:description> <maml:para>Name of the group leader array.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-NSFibreChannelConfig</command:name> <maml:description> <maml:para>Regenerate Fibre Channel configuration.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Updat</command:verb> <command:noun>-NSFibreChannelConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Regenerate Fibre Channel configuration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-NSFibreChannelConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the Fibre Channel configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-NSFibreChannelConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>wwnn_base_str</maml:name> <maml:description> <maml:para>Base World Wide Node Name(WWNN).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-NSFibreChannelConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>precheck</maml:name> <maml:description> <maml:para>Check if the interfaces are offline before regenerating the WWNN (World Wide Node Name).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the Fibre Channel configuration.</maml:para> </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="true (ByValue)" position="named"> <maml:name>wwnn_base_str</maml:name> <maml:description> <maml:para>Base World Wide Node Name(WWNN).</maml:para> </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="true (ByValue)" position="named"> <maml:name>precheck</maml:name> <maml:description> <maml:para>Check if the interfaces are offline before regenerating the WWNN (World Wide Node Name).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-NSFibreChannelConfig</command:name> <maml:description> <maml:para>Update Fibre Channel configuration after hardware changes.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Updat</command:verb> <command:noun>-NSFibreChannelConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Update Fibre Channel configuration after hardware changes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-NSFibreChannelConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the Fibre Channel configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the Fibre Channel configuration.</maml:para> </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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSUser</command:name> <maml:description> <maml:para>Create a user.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Create a user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of the user used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>role_id</maml:name> <maml:description> <maml:para>Identifier for the user's role.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>User's login password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>auth_password</maml:name> <maml:description> <maml:para>Authorization password for changing password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>inactivity_timeout</maml:name> <maml:description> <maml:para>The amount of time that the user session is inactive before timing out. A value of 0 indicates that the timeout is taken from the group setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this user was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this user was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>email_addr</maml:name> <maml:description> <maml:para>Email address of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Identifier for the tenant.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tenant_key</maml:name> <maml:description> <maml:para>Tenant secret key for encrypting the password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>disabled</maml:name> <maml:description> <maml:para>User is currently disabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>auth_lock</maml:name> <maml:description> <maml:para>User was locked due to failed logins.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_login</maml:name> <maml:description> <maml:para>Last login time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_logout</maml:name> <maml:description> <maml:para>Last logout time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>logged_in</maml:name> <maml:description> <maml:para>User is currently logged in.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of the user used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>role_id</maml:name> <maml:description> <maml:para>Identifier for the user's role.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>User's login password.</maml:para> </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="true (ByValue)" position="named"> <maml:name>auth_password</maml:name> <maml:description> <maml:para>Authorization password for changing password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>inactivity_timeout</maml:name> <maml:description> <maml:para>The amount of time that the user session is inactive before timing out. A value of 0 indicates that the timeout is taken from the group setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this user was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this user was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>email_addr</maml:name> <maml:description> <maml:para>Email address of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Identifier for the tenant.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>tenant_key</maml:name> <maml:description> <maml:para>Tenant secret key for encrypting the password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>disabled</maml:name> <maml:description> <maml:para>User is currently disabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>auth_lock</maml:name> <maml:description> <maml:para>User was locked due to failed logins.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_login</maml:name> <maml:description> <maml:para>Last login time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_logout</maml:name> <maml:description> <maml:para>Last logout time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>logged_in</maml:name> <maml:description> <maml:para>User is currently logged in.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> New-NSUser -name testuser1 -password "testpassword" name id role full_name logged_in disabled description ---- -- ---- --------- --------- -------- ----------- testuser1 1028eada7f8dd99d3b000000000000000000000029 guest False False </dev:code> <dev:remarks> <maml:para>This command will create a new volume using the minimal number of parameters. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 2 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> New-NSUser -name testuser1 -password "testpassword" -description "My Test User" -role administrator name id role full_name logged_in disabled description ---- -- ---- --------- --------- -------- ----------- testuser1 1028eada7f8dd99d3b00000000000000000000002a administrator False False My Test User </dev:code> <dev:remarks> <maml:para>This command will create a new volume using thea common number of parameters. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSUser</command:name> <maml:description> <maml:para>List one or more users.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List one or more users.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of the user used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>role_id</maml:name> <maml:description> <maml:para>Identifier for the user's role.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>User's login password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>auth_password</maml:name> <maml:description> <maml:para>Authorization password for changing password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>inactivity_timeout</maml:name> <maml:description> <maml:para>The amount of time that the user session is inactive before timing out. A value of 0 indicates that the timeout is taken from the group setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this user was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this user was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>email_addr</maml:name> <maml:description> <maml:para>Email address of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Identifier for the tenant.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tenant_key</maml:name> <maml:description> <maml:para>Tenant secret key for encrypting the password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>disabled</maml:name> <maml:description> <maml:para>User is currently disabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>auth_lock</maml:name> <maml:description> <maml:para>User was locked due to failed logins.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_login</maml:name> <maml:description> <maml:para>Last login time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_logout</maml:name> <maml:description> <maml:para>Last logout time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>logged_in</maml:name> <maml:description> <maml:para>User is currently logged in.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of the user used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>role_id</maml:name> <maml:description> <maml:para>Identifier for the user's role.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>User's login password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>auth_password</maml:name> <maml:description> <maml:para>Authorization password for changing password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>inactivity_timeout</maml:name> <maml:description> <maml:para>The amount of time that the user session is inactive before timing out. A value of 0 indicates that the timeout is taken from the group setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this user was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this user was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>email_addr</maml:name> <maml:description> <maml:para>Email address of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Identifier for the tenant.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>tenant_key</maml:name> <maml:description> <maml:para>Tenant secret key for encrypting the password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>disabled</maml:name> <maml:description> <maml:para>User is currently disabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>auth_lock</maml:name> <maml:description> <maml:para>User was locked due to failed logins.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_login</maml:name> <maml:description> <maml:para>Last login time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_logout</maml:name> <maml:description> <maml:para>Last logout time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>logged_in</maml:name> <maml:description> <maml:para>User is currently logged in.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSUSer name id role full_name logged_in disabled description ---- -- ---- --------- --------- -------- ----------- admin2 1028eada7f8dd99d3b000000000000000000000008 administrator roy thomas False False admin 1028eada7f8dd99d3b000000000000000000000001 administrator Administrator True False Administrator </dev:code> <dev:remarks> <maml:para>This command will retrieve the list of users. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 2 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSUser -name admin name id role full_name logged_in disabled description ---- -- ---- --------- --------- -------- ----------- admin 1028eada7f8dd99d3b000000000000000000000001 administrator Administrator True False Administrator </dev:code> <dev:remarks> <maml:para>This command will retrieve the user specified by name. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSUser</command:name> <maml:description> <maml:para>Modify information about a user.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Modify information about a user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of the user used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>role_id</maml:name> <maml:description> <maml:para>Identifier for the user's role.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>User's login password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>auth_password</maml:name> <maml:description> <maml:para>Authorization password for changing password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>inactivity_timeout</maml:name> <maml:description> <maml:para>The amount of time that the user session is inactive before timing out. A value of 0 indicates that the timeout is taken from the group setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this user was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this user was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>email_addr</maml:name> <maml:description> <maml:para>Email address of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Identifier for the tenant.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tenant_key</maml:name> <maml:description> <maml:para>Tenant secret key for encrypting the password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>disabled</maml:name> <maml:description> <maml:para>User is currently disabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>auth_lock</maml:name> <maml:description> <maml:para>User was locked due to failed logins.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_login</maml:name> <maml:description> <maml:para>Last login time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_logout</maml:name> <maml:description> <maml:para>Last logout time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>logged_in</maml:name> <maml:description> <maml:para>User is currently logged in.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of the user used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>role_id</maml:name> <maml:description> <maml:para>Identifier for the user's role.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>User's login password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>auth_password</maml:name> <maml:description> <maml:para>Authorization password for changing password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>inactivity_timeout</maml:name> <maml:description> <maml:para>The amount of time that the user session is inactive before timing out. A value of 0 indicates that the timeout is taken from the group setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this user was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this user was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>email_addr</maml:name> <maml:description> <maml:para>Email address of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Identifier for the tenant.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>tenant_key</maml:name> <maml:description> <maml:para>Tenant secret key for encrypting the password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>disabled</maml:name> <maml:description> <maml:para>User is currently disabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>auth_lock</maml:name> <maml:description> <maml:para>User was locked due to failed logins.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_login</maml:name> <maml:description> <maml:para>Last login time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_logout</maml:name> <maml:description> <maml:para>Last logout time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>logged_in</maml:name> <maml:description> <maml:para>User is currently logged in.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Set-NSuser -id 1028eada7f8dd99d3b00000000000000000000002a -description "A New Description" name id role full_name logged_in disabled description ---- -- ---- --------- --------- -------- ----------- testuser1 1028eada7f8dd99d3b00000000000000000000002a administrator False False A New Description </dev:code> <dev:remarks> <maml:para>This command will set the description for the user specified by id. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSUser</command:name> <maml:description> <maml:para>Delete a user.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Delete a user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of the user used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>role_id</maml:name> <maml:description> <maml:para>Identifier for the user's role.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>User's login password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>auth_password</maml:name> <maml:description> <maml:para>Authorization password for changing password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>inactivity_timeout</maml:name> <maml:description> <maml:para>The amount of time that the user session is inactive before timing out. A value of 0 indicates that the timeout is taken from the group setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this user was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this user was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>email_addr</maml:name> <maml:description> <maml:para>Email address of the user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Identifier for the tenant.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tenant_key</maml:name> <maml:description> <maml:para>Tenant secret key for encrypting the password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>disabled</maml:name> <maml:description> <maml:para>User is currently disabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>auth_lock</maml:name> <maml:description> <maml:para>User was locked due to failed logins.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_login</maml:name> <maml:description> <maml:para>Last login time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_logout</maml:name> <maml:description> <maml:para>Last logout time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>logged_in</maml:name> <maml:description> <maml:para>User is currently logged in.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>Name of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>Name of the user used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>description</maml:name> <maml:description> <maml:para>Description of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>role_id</maml:name> <maml:description> <maml:para>Identifier for the user's role.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>password</maml:name> <maml:description> <maml:para>User's login password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>auth_password</maml:name> <maml:description> <maml:para>Authorization password for changing password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>inactivity_timeout</maml:name> <maml:description> <maml:para>The amount of time that the user session is inactive before timing out. A value of 0 indicates that the timeout is taken from the group setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this user was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this user was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>Fully qualified name of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>email_addr</maml:name> <maml:description> <maml:para>Email address of the user.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>tenant_id</maml:name> <maml:description> <maml:para>Identifier for the tenant.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>tenant_key</maml:name> <maml:description> <maml:para>Tenant secret key for encrypting the password.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>disabled</maml:name> <maml:description> <maml:para>User is currently disabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>auth_lock</maml:name> <maml:description> <maml:para>User was locked due to failed logins.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_login</maml:name> <maml:description> <maml:para>Last login time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_logout</maml:name> <maml:description> <maml:para>Last logout time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>logged_in</maml:name> <maml:description> <maml:para>User is currently logged in.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Remove-NSuser -id 1028eada7f8dd99d3b00000000000000000000002a </dev:code> <dev:remarks> <maml:para>This command will remove the user specified by id. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Unlock-NSUser</command:name> <maml:description> <maml:para>Unlocks user account locked due to failed logins.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Unloc</command:verb> <command:noun>-NSUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Unlocks user account locked due to failed logins.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Unlock-NSUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID for the user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID for the user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NSArray</command:name> <maml:description> <maml:para>Creates an array with given attributes.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>NSArray</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Creates an array with given attributes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>The user provided name of the array. It is also the array's hostname.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>The array's fully qualified name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>The array name used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Reachability status of the array in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of the array in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group_state</maml:name> <maml:description> <maml:para>State of the array in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of pool to which this is a member.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>ID of pool to which this is a member.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>model</maml:name> <maml:description> <maml:para>Array model.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>serial</maml:name> <maml:description> <maml:para>Serial number of the array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>version</maml:name> <maml:description> <maml:para>Software version of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_sfa</maml:name> <maml:description> <maml:para>True if this array supports SFA; false otherwise.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this array object was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this array object was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicates whether the usage of array is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usable_capacity_bytes</maml:name> <maml:description> <maml:para>The usable capacity of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usable_cache_capacity_bytes</maml:name> <maml:description> <maml:para>The usable cache capacity of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>raw_capacity_bytes</maml:name> <maml:description> <maml:para>The raw capacity of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_usage_bytes</maml:name> <maml:description> <maml:para>The compressed usage of volumes in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>The uncompressed usage of volumes in array. This is the pre-reduced usage.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_compression</maml:name> <maml:description> <maml:para>The compression rate of volumes in array expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_saved_bytes</maml:name> <maml:description> <maml:para>The saved space of volumes in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_usage_bytes</maml:name> <maml:description> <maml:para>The compressed usage of snapshots in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>The uncompressed usage of snapshots in array. This is the pre-reduced usage.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_compression</maml:name> <maml:description> <maml:para>The compression rate of snapshots in array expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_space_reduction</maml:name> <maml:description> <maml:para>The space reduction rate of snapshots in array expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_saved_bytes</maml:name> <maml:description> <maml:para>The saved space of snapshots in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pending_delete_bytes</maml:name> <maml:description> <maml:para>The pending delete bytes in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>available_bytes</maml:name> <maml:description> <maml:para>The available space of array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage</maml:name> <maml:description> <maml:para>Used space of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>all_flash</maml:name> <maml:description> <maml:para>Whether it is an all-flash array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_capacity_bytes</maml:name> <maml:description> <maml:para>The dedupe capacity of a hybrid array. Does not apply to all-flash arrays.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_usage_bytes</maml:name> <maml:description> <maml:para>The dedupe usage of a hybrid array. Does not apply to all-flash arrays.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_fully_dedupe_capable</maml:name> <maml:description> <maml:para>Is array fully capable to dedupe its usable capacity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_disabled</maml:name> <maml:description> <maml:para>Is data deduplication disabled for this array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>extended_model</maml:name> <maml:description> <maml:para>Extended model of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>oem</maml:name> <maml:description> <maml:para>OEM brand of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>brand</maml:name> <maml:description> <maml:para>Brand of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_supported_hw_config</maml:name> <maml:description> <maml:para>Whether it is a supported hardware config.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>gig_nic_port_count</maml:name> <maml:description> <maml:para>Count of 1G NIC Ports installed on the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ten_gig_sfp_nic_port_count</maml:name> <maml:description> <maml:para>Count of SFP NIC Ports installed on the array capable of 10G, 25G or 100G speeds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ten_gig_t_nic_port_count</maml:name> <maml:description> <maml:para>Count of 10G BaseT NIC Ports installed on the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fc_port_count</maml:name> <maml:description> <maml:para>Count of Fibre Channel Ports installed on the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>public_key</maml:name> <maml:description> <maml:para>Public key of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>upgrade</maml:name> <maml:description> <maml:para>The array upgrade data.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>create_pool</maml:name> <maml:description> <maml:para>Whether to create associated pool during array create.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_description</maml:name> <maml:description> <maml:para>Text description of the pool to be created during array creation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>allow_lower_limits</maml:name> <maml:description> <maml:para>A True setting will allow you to add an array with lower limits to a pool with higher limits.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ctrlr_a_support_ip</maml:name> <maml:description> <maml:para>Controller A Support IP Address.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ctrlr_b_support_ip</maml:name> <maml:description> <maml:para>Controller B Support IP Address.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>nic_list</maml:name> <maml:description> <maml:para>List NICs information. Used when creating an array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>model_sub_type</maml:name> <maml:description> <maml:para>Array model sub type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>zconf_ipaddrs</maml:name> <maml:description> <maml:para>List of link-local zero-configuration addresses of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>secondary_mgmt_ip</maml:name> <maml:description> <maml:para>Secondary management IP address for the Group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>The user provided name of the array. It is also the array's hostname.</maml:para> </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="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>The array's fully qualified name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>The array name used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Reachability status of the array in the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of the array in the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>group_state</maml:name> <maml:description> <maml:para>State of the array in the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of pool to which this is a member.</maml:para> </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="true (ByValue)" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>ID of pool to which this is a member.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>model</maml:name> <maml:description> <maml:para>Array model.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>serial</maml:name> <maml:description> <maml:para>Serial number of the array.</maml:para> </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="true (ByValue)" position="named"> <maml:name>version</maml:name> <maml:description> <maml:para>Software version of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>is_sfa</maml:name> <maml:description> <maml:para>True if this array supports SFA; false otherwise.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this array object was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this array object was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicates whether the usage of array is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usable_capacity_bytes</maml:name> <maml:description> <maml:para>The usable capacity of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usable_cache_capacity_bytes</maml:name> <maml:description> <maml:para>The usable cache capacity of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>raw_capacity_bytes</maml:name> <maml:description> <maml:para>The raw capacity of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_usage_bytes</maml:name> <maml:description> <maml:para>The compressed usage of volumes in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>The uncompressed usage of volumes in array. This is the pre-reduced usage.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_compression</maml:name> <maml:description> <maml:para>The compression rate of volumes in array expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_saved_bytes</maml:name> <maml:description> <maml:para>The saved space of volumes in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_usage_bytes</maml:name> <maml:description> <maml:para>The compressed usage of snapshots in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>The uncompressed usage of snapshots in array. This is the pre-reduced usage.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_compression</maml:name> <maml:description> <maml:para>The compression rate of snapshots in array expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_space_reduction</maml:name> <maml:description> <maml:para>The space reduction rate of snapshots in array expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_saved_bytes</maml:name> <maml:description> <maml:para>The saved space of snapshots in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pending_delete_bytes</maml:name> <maml:description> <maml:para>The pending delete bytes in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>available_bytes</maml:name> <maml:description> <maml:para>The available space of array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage</maml:name> <maml:description> <maml:para>Used space of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>all_flash</maml:name> <maml:description> <maml:para>Whether it is an all-flash array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_capacity_bytes</maml:name> <maml:description> <maml:para>The dedupe capacity of a hybrid array. Does not apply to all-flash arrays.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_usage_bytes</maml:name> <maml:description> <maml:para>The dedupe usage of a hybrid array. Does not apply to all-flash arrays.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_fully_dedupe_capable</maml:name> <maml:description> <maml:para>Is array fully capable to dedupe its usable capacity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_disabled</maml:name> <maml:description> <maml:para>Is data deduplication disabled for this array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>extended_model</maml:name> <maml:description> <maml:para>Extended model of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>oem</maml:name> <maml:description> <maml:para>OEM brand of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>brand</maml:name> <maml:description> <maml:para>Brand of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>is_supported_hw_config</maml:name> <maml:description> <maml:para>Whether it is a supported hardware config.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>gig_nic_port_count</maml:name> <maml:description> <maml:para>Count of 1G NIC Ports installed on the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ten_gig_sfp_nic_port_count</maml:name> <maml:description> <maml:para>Count of SFP NIC Ports installed on the array capable of 10G, 25G or 100G speeds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ten_gig_t_nic_port_count</maml:name> <maml:description> <maml:para>Count of 10G BaseT NIC Ports installed on the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>fc_port_count</maml:name> <maml:description> <maml:para>Count of Fibre Channel Ports installed on the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>public_key</maml:name> <maml:description> <maml:para>Public key of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>upgrade</maml:name> <maml:description> <maml:para>The array upgrade data.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>create_pool</maml:name> <maml:description> <maml:para>Whether to create associated pool during array create.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pool_description</maml:name> <maml:description> <maml:para>Text description of the pool to be created during array creation.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>allow_lower_limits</maml:name> <maml:description> <maml:para>A True setting will allow you to add an array with lower limits to a pool with higher limits.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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>ctrlr_a_support_ip</maml:name> <maml:description> <maml:para>Controller A Support IP Address.</maml:para> </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="true (ByValue)" position="named"> <maml:name>ctrlr_b_support_ip</maml:name> <maml:description> <maml:para>Controller B Support IP Address.</maml:para> </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="true (ByValue)" position="named"> <maml:name>nic_list</maml:name> <maml:description> <maml:para>List NICs information. Used when creating an array.</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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>model_sub_type</maml:name> <maml:description> <maml:para>Array model sub type.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>zconf_ipaddrs</maml:name> <maml:description> <maml:para>List of link-local zero-configuration addresses of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>secondary_mgmt_ip</maml:name> <maml:description> <maml:para>Secondary management IP address for the Group.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSArray</command:name> <maml:description> <maml:para>Read one or more arrays.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSArray</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Read one or more arrays.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>The user provided name of the array. It is also the array's hostname.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>The array's fully qualified name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>The array name used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Reachability status of the array in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of the array in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group_state</maml:name> <maml:description> <maml:para>State of the array in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of pool to which this is a member.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>ID of pool to which this is a member.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>model</maml:name> <maml:description> <maml:para>Array model.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>serial</maml:name> <maml:description> <maml:para>Serial number of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>version</maml:name> <maml:description> <maml:para>Software version of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_sfa</maml:name> <maml:description> <maml:para>True if this array supports SFA; false otherwise.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this array object was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this array object was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicates whether the usage of array is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usable_capacity_bytes</maml:name> <maml:description> <maml:para>The usable capacity of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usable_cache_capacity_bytes</maml:name> <maml:description> <maml:para>The usable cache capacity of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>raw_capacity_bytes</maml:name> <maml:description> <maml:para>The raw capacity of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_usage_bytes</maml:name> <maml:description> <maml:para>The compressed usage of volumes in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>The uncompressed usage of volumes in array. This is the pre-reduced usage.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_compression</maml:name> <maml:description> <maml:para>The compression rate of volumes in array expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_saved_bytes</maml:name> <maml:description> <maml:para>The saved space of volumes in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_usage_bytes</maml:name> <maml:description> <maml:para>The compressed usage of snapshots in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>The uncompressed usage of snapshots in array. This is the pre-reduced usage.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_compression</maml:name> <maml:description> <maml:para>The compression rate of snapshots in array expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_space_reduction</maml:name> <maml:description> <maml:para>The space reduction rate of snapshots in array expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_saved_bytes</maml:name> <maml:description> <maml:para>The saved space of snapshots in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pending_delete_bytes</maml:name> <maml:description> <maml:para>The pending delete bytes in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>available_bytes</maml:name> <maml:description> <maml:para>The available space of array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage</maml:name> <maml:description> <maml:para>Used space of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>all_flash</maml:name> <maml:description> <maml:para>Whether it is an all-flash array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_capacity_bytes</maml:name> <maml:description> <maml:para>The dedupe capacity of a hybrid array. Does not apply to all-flash arrays.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_usage_bytes</maml:name> <maml:description> <maml:para>The dedupe usage of a hybrid array. Does not apply to all-flash arrays.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_fully_dedupe_capable</maml:name> <maml:description> <maml:para>Is array fully capable to dedupe its usable capacity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_disabled</maml:name> <maml:description> <maml:para>Is data deduplication disabled for this array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>extended_model</maml:name> <maml:description> <maml:para>Extended model of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>oem</maml:name> <maml:description> <maml:para>OEM brand of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>brand</maml:name> <maml:description> <maml:para>Brand of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_supported_hw_config</maml:name> <maml:description> <maml:para>Whether it is a supported hardware config.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>gig_nic_port_count</maml:name> <maml:description> <maml:para>Count of 1G NIC Ports installed on the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ten_gig_sfp_nic_port_count</maml:name> <maml:description> <maml:para>Count of SFP NIC Ports installed on the array capable of 10G, 25G or 100G speeds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ten_gig_t_nic_port_count</maml:name> <maml:description> <maml:para>Count of 10G BaseT NIC Ports installed on the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fc_port_count</maml:name> <maml:description> <maml:para>Count of Fibre Channel Ports installed on the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>public_key</maml:name> <maml:description> <maml:para>Public key of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>upgrade</maml:name> <maml:description> <maml:para>The array upgrade data.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>create_pool</maml:name> <maml:description> <maml:para>Whether to create associated pool during array create.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_description</maml:name> <maml:description> <maml:para>Text description of the pool to be created during array creation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>allow_lower_limits</maml:name> <maml:description> <maml:para>A True setting will allow you to add an array with lower limits to a pool with higher limits.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ctrlr_a_support_ip</maml:name> <maml:description> <maml:para>Controller A Support IP Address.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ctrlr_b_support_ip</maml:name> <maml:description> <maml:para>Controller B Support IP Address.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>nic_list</maml:name> <maml:description> <maml:para>List NICs information. Used when creating an array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>model_sub_type</maml:name> <maml:description> <maml:para>Array model sub type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>zconf_ipaddrs</maml:name> <maml:description> <maml:para>List of link-local zero-configuration addresses of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>secondary_mgmt_ip</maml:name> <maml:description> <maml:para>Secondary management IP address for the Group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>The user provided name of the array. It is also the array's hostname.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>The array's fully qualified name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>The array name used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Reachability status of the array in the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of the array in the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>group_state</maml:name> <maml:description> <maml:para>State of the array in the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of pool to which this is a member.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>ID of pool to which this is a member.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>model</maml:name> <maml:description> <maml:para>Array model.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>serial</maml:name> <maml:description> <maml:para>Serial number of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>version</maml:name> <maml:description> <maml:para>Software version of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>is_sfa</maml:name> <maml:description> <maml:para>True if this array supports SFA; false otherwise.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this array object was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this array object was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicates whether the usage of array is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usable_capacity_bytes</maml:name> <maml:description> <maml:para>The usable capacity of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usable_cache_capacity_bytes</maml:name> <maml:description> <maml:para>The usable cache capacity of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>raw_capacity_bytes</maml:name> <maml:description> <maml:para>The raw capacity of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_usage_bytes</maml:name> <maml:description> <maml:para>The compressed usage of volumes in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>The uncompressed usage of volumes in array. This is the pre-reduced usage.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_compression</maml:name> <maml:description> <maml:para>The compression rate of volumes in array expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_saved_bytes</maml:name> <maml:description> <maml:para>The saved space of volumes in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_usage_bytes</maml:name> <maml:description> <maml:para>The compressed usage of snapshots in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>The uncompressed usage of snapshots in array. This is the pre-reduced usage.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_compression</maml:name> <maml:description> <maml:para>The compression rate of snapshots in array expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_space_reduction</maml:name> <maml:description> <maml:para>The space reduction rate of snapshots in array expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_saved_bytes</maml:name> <maml:description> <maml:para>The saved space of snapshots in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pending_delete_bytes</maml:name> <maml:description> <maml:para>The pending delete bytes in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>available_bytes</maml:name> <maml:description> <maml:para>The available space of array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage</maml:name> <maml:description> <maml:para>Used space of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>all_flash</maml:name> <maml:description> <maml:para>Whether it is an all-flash array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_capacity_bytes</maml:name> <maml:description> <maml:para>The dedupe capacity of a hybrid array. Does not apply to all-flash arrays.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_usage_bytes</maml:name> <maml:description> <maml:para>The dedupe usage of a hybrid array. Does not apply to all-flash arrays.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_fully_dedupe_capable</maml:name> <maml:description> <maml:para>Is array fully capable to dedupe its usable capacity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_disabled</maml:name> <maml:description> <maml:para>Is data deduplication disabled for this array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>extended_model</maml:name> <maml:description> <maml:para>Extended model of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>oem</maml:name> <maml:description> <maml:para>OEM brand of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>brand</maml:name> <maml:description> <maml:para>Brand of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>is_supported_hw_config</maml:name> <maml:description> <maml:para>Whether it is a supported hardware config.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>gig_nic_port_count</maml:name> <maml:description> <maml:para>Count of 1G NIC Ports installed on the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ten_gig_sfp_nic_port_count</maml:name> <maml:description> <maml:para>Count of SFP NIC Ports installed on the array capable of 10G, 25G or 100G speeds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ten_gig_t_nic_port_count</maml:name> <maml:description> <maml:para>Count of 10G BaseT NIC Ports installed on the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>fc_port_count</maml:name> <maml:description> <maml:para>Count of Fibre Channel Ports installed on the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>public_key</maml:name> <maml:description> <maml:para>Public key of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>upgrade</maml:name> <maml:description> <maml:para>The array upgrade data.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>create_pool</maml:name> <maml:description> <maml:para>Whether to create associated pool during array create.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pool_description</maml:name> <maml:description> <maml:para>Text description of the pool to be created during array creation.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>allow_lower_limits</maml:name> <maml:description> <maml:para>A True setting will allow you to add an array with lower limits to a pool with higher limits.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ctrlr_a_support_ip</maml:name> <maml:description> <maml:para>Controller A Support IP Address.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>ctrlr_b_support_ip</maml:name> <maml:description> <maml:para>Controller B Support IP Address.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>nic_list</maml:name> <maml:description> <maml:para>List NICs information. Used when creating an array.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>model_sub_type</maml:name> <maml:description> <maml:para>Array model sub type.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>zconf_ipaddrs</maml:name> <maml:description> <maml:para>List of link-local zero-configuration addresses of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>secondary_mgmt_ip</maml:name> <maml:description> <maml:para>Secondary management IP address for the Group.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSArray name id model serial role version ---- -- ----- ------ ---- ------- sjc-arnab2-arr 091bde905fd66eed40000000000000000000000006 vmware sjc-arnab2-arr backup_leader 5.0.3.100-57... sjc-arnab-arr 091bde905fd66eed40000000000000000000000001 vmware sjc-arnab-arr leader 5.0.3.100-57... </dev:code> <dev:remarks> <maml:para>This command will retrieves list of currently connected Array. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 2 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-nsArray -role leader name id model serial role version ---- -- ----- ------ ---- ------- sjc-arnab-arr 091bde905fd66eed40000000000000000000000001 vmware sjc-arnab-arr leader 5.0.3.100-57... </dev:code> <dev:remarks> <maml:para>This command will retrieve a specific Application Server specified by role. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSArray</command:name> <maml:description> <maml:para>Modify the settings for the array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSArray</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Modify the settings for the array.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>The user provided name of the array. It is also the array's hostname.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>The array's fully qualified name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>The array name used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Reachability status of the array in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of the array in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group_state</maml:name> <maml:description> <maml:para>State of the array in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of pool to which this is a member.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>ID of pool to which this is a member.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>model</maml:name> <maml:description> <maml:para>Array model.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>serial</maml:name> <maml:description> <maml:para>Serial number of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>version</maml:name> <maml:description> <maml:para>Software version of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_sfa</maml:name> <maml:description> <maml:para>True if this array supports SFA; false otherwise.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this array object was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this array object was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicates whether the usage of array is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usable_capacity_bytes</maml:name> <maml:description> <maml:para>The usable capacity of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usable_cache_capacity_bytes</maml:name> <maml:description> <maml:para>The usable cache capacity of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>raw_capacity_bytes</maml:name> <maml:description> <maml:para>The raw capacity of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_usage_bytes</maml:name> <maml:description> <maml:para>The compressed usage of volumes in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>The uncompressed usage of volumes in array. This is the pre-reduced usage.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_compression</maml:name> <maml:description> <maml:para>The compression rate of volumes in array expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_saved_bytes</maml:name> <maml:description> <maml:para>The saved space of volumes in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_usage_bytes</maml:name> <maml:description> <maml:para>The compressed usage of snapshots in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>The uncompressed usage of snapshots in array. This is the pre-reduced usage.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_compression</maml:name> <maml:description> <maml:para>The compression rate of snapshots in array expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_space_reduction</maml:name> <maml:description> <maml:para>The space reduction rate of snapshots in array expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_saved_bytes</maml:name> <maml:description> <maml:para>The saved space of snapshots in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pending_delete_bytes</maml:name> <maml:description> <maml:para>The pending delete bytes in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>available_bytes</maml:name> <maml:description> <maml:para>The available space of array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage</maml:name> <maml:description> <maml:para>Used space of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>all_flash</maml:name> <maml:description> <maml:para>Whether it is an all-flash array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_capacity_bytes</maml:name> <maml:description> <maml:para>The dedupe capacity of a hybrid array. Does not apply to all-flash arrays.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_usage_bytes</maml:name> <maml:description> <maml:para>The dedupe usage of a hybrid array. Does not apply to all-flash arrays.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_fully_dedupe_capable</maml:name> <maml:description> <maml:para>Is array fully capable to dedupe its usable capacity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_disabled</maml:name> <maml:description> <maml:para>Is data deduplication disabled for this array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>extended_model</maml:name> <maml:description> <maml:para>Extended model of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>oem</maml:name> <maml:description> <maml:para>OEM brand of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>brand</maml:name> <maml:description> <maml:para>Brand of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_supported_hw_config</maml:name> <maml:description> <maml:para>Whether it is a supported hardware config.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>gig_nic_port_count</maml:name> <maml:description> <maml:para>Count of 1G NIC Ports installed on the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ten_gig_sfp_nic_port_count</maml:name> <maml:description> <maml:para>Count of SFP NIC Ports installed on the array capable of 10G, 25G or 100G speeds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ten_gig_t_nic_port_count</maml:name> <maml:description> <maml:para>Count of 10G BaseT NIC Ports installed on the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fc_port_count</maml:name> <maml:description> <maml:para>Count of Fibre Channel Ports installed on the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>public_key</maml:name> <maml:description> <maml:para>Public key of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>upgrade</maml:name> <maml:description> <maml:para>The array upgrade data.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>create_pool</maml:name> <maml:description> <maml:para>Whether to create associated pool during array create.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_description</maml:name> <maml:description> <maml:para>Text description of the pool to be created during array creation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>allow_lower_limits</maml:name> <maml:description> <maml:para>A True setting will allow you to add an array with lower limits to a pool with higher limits.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ctrlr_a_support_ip</maml:name> <maml:description> <maml:para>Controller A Support IP Address.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ctrlr_b_support_ip</maml:name> <maml:description> <maml:para>Controller B Support IP Address.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>nic_list</maml:name> <maml:description> <maml:para>List NICs information. Used when creating an array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>model_sub_type</maml:name> <maml:description> <maml:para>Array model sub type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>zconf_ipaddrs</maml:name> <maml:description> <maml:para>List of link-local zero-configuration addresses of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>secondary_mgmt_ip</maml:name> <maml:description> <maml:para>Secondary management IP address for the Group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for array.</maml:para> </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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>The user provided name of the array. It is also the array's hostname.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>The array's fully qualified name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>The array name used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Reachability status of the array in the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of the array in the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>group_state</maml:name> <maml:description> <maml:para>State of the array in the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of pool to which this is a member.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>ID of pool to which this is a member.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>model</maml:name> <maml:description> <maml:para>Array model.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>serial</maml:name> <maml:description> <maml:para>Serial number of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>version</maml:name> <maml:description> <maml:para>Software version of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>is_sfa</maml:name> <maml:description> <maml:para>True if this array supports SFA; false otherwise.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this array object was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this array object was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicates whether the usage of array is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usable_capacity_bytes</maml:name> <maml:description> <maml:para>The usable capacity of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usable_cache_capacity_bytes</maml:name> <maml:description> <maml:para>The usable cache capacity of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>raw_capacity_bytes</maml:name> <maml:description> <maml:para>The raw capacity of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_usage_bytes</maml:name> <maml:description> <maml:para>The compressed usage of volumes in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>The uncompressed usage of volumes in array. This is the pre-reduced usage.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_compression</maml:name> <maml:description> <maml:para>The compression rate of volumes in array expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_saved_bytes</maml:name> <maml:description> <maml:para>The saved space of volumes in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_usage_bytes</maml:name> <maml:description> <maml:para>The compressed usage of snapshots in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>The uncompressed usage of snapshots in array. This is the pre-reduced usage.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_compression</maml:name> <maml:description> <maml:para>The compression rate of snapshots in array expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_space_reduction</maml:name> <maml:description> <maml:para>The space reduction rate of snapshots in array expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_saved_bytes</maml:name> <maml:description> <maml:para>The saved space of snapshots in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pending_delete_bytes</maml:name> <maml:description> <maml:para>The pending delete bytes in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>available_bytes</maml:name> <maml:description> <maml:para>The available space of array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage</maml:name> <maml:description> <maml:para>Used space of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>all_flash</maml:name> <maml:description> <maml:para>Whether it is an all-flash array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_capacity_bytes</maml:name> <maml:description> <maml:para>The dedupe capacity of a hybrid array. Does not apply to all-flash arrays.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_usage_bytes</maml:name> <maml:description> <maml:para>The dedupe usage of a hybrid array. Does not apply to all-flash arrays.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_fully_dedupe_capable</maml:name> <maml:description> <maml:para>Is array fully capable to dedupe its usable capacity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_disabled</maml:name> <maml:description> <maml:para>Is data deduplication disabled for this array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>extended_model</maml:name> <maml:description> <maml:para>Extended model of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>oem</maml:name> <maml:description> <maml:para>OEM brand of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>brand</maml:name> <maml:description> <maml:para>Brand of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>is_supported_hw_config</maml:name> <maml:description> <maml:para>Whether it is a supported hardware config.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>gig_nic_port_count</maml:name> <maml:description> <maml:para>Count of 1G NIC Ports installed on the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ten_gig_sfp_nic_port_count</maml:name> <maml:description> <maml:para>Count of SFP NIC Ports installed on the array capable of 10G, 25G or 100G speeds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ten_gig_t_nic_port_count</maml:name> <maml:description> <maml:para>Count of 10G BaseT NIC Ports installed on the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>fc_port_count</maml:name> <maml:description> <maml:para>Count of Fibre Channel Ports installed on the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>public_key</maml:name> <maml:description> <maml:para>Public key of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>upgrade</maml:name> <maml:description> <maml:para>The array upgrade data.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>create_pool</maml:name> <maml:description> <maml:para>Whether to create associated pool during array create.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pool_description</maml:name> <maml:description> <maml:para>Text description of the pool to be created during array creation.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>allow_lower_limits</maml:name> <maml:description> <maml:para>A True setting will allow you to add an array with lower limits to a pool with higher limits.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ctrlr_a_support_ip</maml:name> <maml:description> <maml:para>Controller A Support IP Address.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>ctrlr_b_support_ip</maml:name> <maml:description> <maml:para>Controller B Support IP Address.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>nic_list</maml:name> <maml:description> <maml:para>List NICs information. Used when creating an array.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>model_sub_type</maml:name> <maml:description> <maml:para>Array model sub type.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>zconf_ipaddrs</maml:name> <maml:description> <maml:para>List of link-local zero-configuration addresses of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>secondary_mgmt_ip</maml:name> <maml:description> <maml:para>Secondary management IP address for the Group.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSArray</command:name> <maml:description> <maml:para>Removes an array with the given ID. The force option is being deprecated.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSArray</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Removes an array with the given ID. The force option is being deprecated.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>The user provided name of the array. It is also the array's hostname.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>The array's fully qualified name.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>The array name used for object search.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Reachability status of the array in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of the array in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>group_state</maml:name> <maml:description> <maml:para>State of the array in the group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of pool to which this is a member.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>ID of pool to which this is a member.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>model</maml:name> <maml:description> <maml:para>Array model.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>serial</maml:name> <maml:description> <maml:para>Serial number of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>version</maml:name> <maml:description> <maml:para>Software version of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_sfa</maml:name> <maml:description> <maml:para>True if this array supports SFA; false otherwise.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this array object was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this array object was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicates whether the usage of array is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usable_capacity_bytes</maml:name> <maml:description> <maml:para>The usable capacity of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usable_cache_capacity_bytes</maml:name> <maml:description> <maml:para>The usable cache capacity of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>raw_capacity_bytes</maml:name> <maml:description> <maml:para>The raw capacity of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_usage_bytes</maml:name> <maml:description> <maml:para>The compressed usage of volumes in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>The uncompressed usage of volumes in array. This is the pre-reduced usage.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_compression</maml:name> <maml:description> <maml:para>The compression rate of volumes in array expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>vol_saved_bytes</maml:name> <maml:description> <maml:para>The saved space of volumes in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_usage_bytes</maml:name> <maml:description> <maml:para>The compressed usage of snapshots in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>The uncompressed usage of snapshots in array. This is the pre-reduced usage.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_compression</maml:name> <maml:description> <maml:para>The compression rate of snapshots in array expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_space_reduction</maml:name> <maml:description> <maml:para>The space reduction rate of snapshots in array expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>snap_saved_bytes</maml:name> <maml:description> <maml:para>The saved space of snapshots in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pending_delete_bytes</maml:name> <maml:description> <maml:para>The pending delete bytes in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>available_bytes</maml:name> <maml:description> <maml:para>The available space of array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>usage</maml:name> <maml:description> <maml:para>Used space of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>all_flash</maml:name> <maml:description> <maml:para>Whether it is an all-flash array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_capacity_bytes</maml:name> <maml:description> <maml:para>The dedupe capacity of a hybrid array. Does not apply to all-flash arrays.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_usage_bytes</maml:name> <maml:description> <maml:para>The dedupe usage of a hybrid array. Does not apply to all-flash arrays.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_fully_dedupe_capable</maml:name> <maml:description> <maml:para>Is array fully capable to dedupe its usable capacity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>dedupe_disabled</maml:name> <maml:description> <maml:para>Is data deduplication disabled for this array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>extended_model</maml:name> <maml:description> <maml:para>Extended model of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>oem</maml:name> <maml:description> <maml:para>OEM brand of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>brand</maml:name> <maml:description> <maml:para>Brand of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>is_supported_hw_config</maml:name> <maml:description> <maml:para>Whether it is a supported hardware config.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>gig_nic_port_count</maml:name> <maml:description> <maml:para>Count of 1G NIC Ports installed on the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ten_gig_sfp_nic_port_count</maml:name> <maml:description> <maml:para>Count of SFP NIC Ports installed on the array capable of 10G, 25G or 100G speeds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ten_gig_t_nic_port_count</maml:name> <maml:description> <maml:para>Count of 10G BaseT NIC Ports installed on the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>fc_port_count</maml:name> <maml:description> <maml:para>Count of Fibre Channel Ports installed on the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>public_key</maml:name> <maml:description> <maml:para>Public key of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>upgrade</maml:name> <maml:description> <maml:para>The array upgrade data.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>create_pool</maml:name> <maml:description> <maml:para>Whether to create associated pool during array create.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>pool_description</maml:name> <maml:description> <maml:para>Text description of the pool to be created during array creation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>allow_lower_limits</maml:name> <maml:description> <maml:para>A True setting will allow you to add an array with lower limits to a pool with higher limits.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ctrlr_a_support_ip</maml:name> <maml:description> <maml:para>Controller A Support IP Address.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ctrlr_b_support_ip</maml:name> <maml:description> <maml:para>Controller B Support IP Address.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>nic_list</maml:name> <maml:description> <maml:para>List NICs information. Used when creating an array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>model_sub_type</maml:name> <maml:description> <maml:para>Array model sub type.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>zconf_ipaddrs</maml:name> <maml:description> <maml:para>List of link-local zero-configuration addresses of the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Object[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>secondary_mgmt_ip</maml:name> <maml:description> <maml:para>Secondary management IP address for the Group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>name</maml:name> <maml:description> <maml:para>The user provided name of the array. It is also the array's hostname.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Forcibly delete the specified array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>full_name</maml:name> <maml:description> <maml:para>The array's fully qualified name.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>search_name</maml:name> <maml:description> <maml:para>The array name used for object search.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Reachability status of the array in the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>role</maml:name> <maml:description> <maml:para>Role of the array in the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>group_state</maml:name> <maml:description> <maml:para>State of the array in the group.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_name</maml:name> <maml:description> <maml:para>Name of pool to which this is a member.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>pool_id</maml:name> <maml:description> <maml:para>ID of pool to which this is a member.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>model</maml:name> <maml:description> <maml:para>Array model.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>serial</maml:name> <maml:description> <maml:para>Serial number of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>version</maml:name> <maml:description> <maml:para>Software version of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>is_sfa</maml:name> <maml:description> <maml:para>True if this array supports SFA; false otherwise.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>creation_time</maml:name> <maml:description> <maml:para>Time when this array object was created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>last_modified</maml:name> <maml:description> <maml:para>Time when this array object was last modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage_valid</maml:name> <maml:description> <maml:para>Indicates whether the usage of array is valid.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usable_capacity_bytes</maml:name> <maml:description> <maml:para>The usable capacity of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usable_cache_capacity_bytes</maml:name> <maml:description> <maml:para>The usable cache capacity of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>raw_capacity_bytes</maml:name> <maml:description> <maml:para>The raw capacity of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_usage_bytes</maml:name> <maml:description> <maml:para>The compressed usage of volumes in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>The uncompressed usage of volumes in array. This is the pre-reduced usage.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_compression</maml:name> <maml:description> <maml:para>The compression rate of volumes in array expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>vol_saved_bytes</maml:name> <maml:description> <maml:para>The saved space of volumes in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_usage_bytes</maml:name> <maml:description> <maml:para>The compressed usage of snapshots in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_usage_uncompressed_bytes</maml:name> <maml:description> <maml:para>The uncompressed usage of snapshots in array. This is the pre-reduced usage.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_compression</maml:name> <maml:description> <maml:para>The compression rate of snapshots in array expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_space_reduction</maml:name> <maml:description> <maml:para>The space reduction rate of snapshots in array expressed as ratio.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[double]</command:parameterValue> <dev:type> <maml:name>Nullable[double]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>snap_saved_bytes</maml:name> <maml:description> <maml:para>The saved space of snapshots in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pending_delete_bytes</maml:name> <maml:description> <maml:para>The pending delete bytes in array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>available_bytes</maml:name> <maml:description> <maml:para>The available space of array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>usage</maml:name> <maml:description> <maml:para>Used space of the array in bytes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>all_flash</maml:name> <maml:description> <maml:para>Whether it is an all-flash array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_capacity_bytes</maml:name> <maml:description> <maml:para>The dedupe capacity of a hybrid array. Does not apply to all-flash arrays.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_usage_bytes</maml:name> <maml:description> <maml:para>The dedupe usage of a hybrid array. Does not apply to all-flash arrays.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>is_fully_dedupe_capable</maml:name> <maml:description> <maml:para>Is array fully capable to dedupe its usable capacity.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>dedupe_disabled</maml:name> <maml:description> <maml:para>Is data deduplication disabled for this array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>extended_model</maml:name> <maml:description> <maml:para>Extended model of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>oem</maml:name> <maml:description> <maml:para>OEM brand of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>brand</maml:name> <maml:description> <maml:para>Brand of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>is_supported_hw_config</maml:name> <maml:description> <maml:para>Whether it is a supported hardware config.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>gig_nic_port_count</maml:name> <maml:description> <maml:para>Count of 1G NIC Ports installed on the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ten_gig_sfp_nic_port_count</maml:name> <maml:description> <maml:para>Count of SFP NIC Ports installed on the array capable of 10G, 25G or 100G speeds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ten_gig_t_nic_port_count</maml:name> <maml:description> <maml:para>Count of 10G BaseT NIC Ports installed on the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>fc_port_count</maml:name> <maml:description> <maml:para>Count of Fibre Channel Ports installed on the array.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>public_key</maml:name> <maml:description> <maml:para>Public key of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>upgrade</maml:name> <maml:description> <maml:para>The array upgrade data.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>create_pool</maml:name> <maml:description> <maml:para>Whether to create associated pool during array create.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>pool_description</maml:name> <maml:description> <maml:para>Text description of the pool to be created during array creation.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>allow_lower_limits</maml:name> <maml:description> <maml:para>A True setting will allow you to add an array with lower limits to a pool with higher limits.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ctrlr_a_support_ip</maml:name> <maml:description> <maml:para>Controller A Support IP Address.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>ctrlr_b_support_ip</maml:name> <maml:description> <maml:para>Controller B Support IP Address.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>nic_list</maml:name> <maml:description> <maml:para>List NICs information. Used when creating an array.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>model_sub_type</maml:name> <maml:description> <maml:para>Array model sub type.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>zconf_ipaddrs</maml:name> <maml:description> <maml:para>List of link-local zero-configuration addresses of the array.</maml:para> </maml:description> <command:parameterValue required="false" 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="false" pipelineInput="true (ByValue)" position="named"> <maml:name>secondary_mgmt_ip</maml:name> <maml:description> <maml:para>Secondary management IP address for the Group.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Remove-NSArray -id 0928eada7f8dd99d3b000000000000000000000001 </dev:code> <dev:remarks> <maml:para>This command will remove the currently connected Array from the group. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-NSArray</command:name> <maml:description> <maml:para>Perform a failover on the specified array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Invok</command:verb> <command:noun>-NSArray</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Perform a failover on the specified array.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-NSArray</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the array to perform failover on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-NSArray</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Initiate failover without performing any precheck.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the array to perform failover on.</maml:para> </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="true (ByValue)" position="named"> <maml:name>force</maml:name> <maml:description> <maml:para>Initiate failover without performing any precheck.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Stop-NSArray</command:name> <maml:description> <maml:para>Halt the specified array. Restarting the array will require physically powering it back on.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Stop-</command:verb> <command:noun>-NSArray</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Halt the specified array. Restarting the array will require physically powering it back on.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-NSArray</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the array to halt.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the array to halt.</maml:para> </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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Stop-NSArray -id 0928eada7f8dd99d3b000000000000000000000001 </dev:code> <dev:remarks> <maml:para>This command will halt the Array. The Array will need to be physically powered off and on to restore. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Reset-NSArray</command:name> <maml:description> <maml:para>Reboot the specified array.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Reset</command:verb> <command:noun>-NSArray</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Reboot the specified array.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Reset-NSArray</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the array to reboot.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the array to reboot.</maml:para> </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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Reset-NSArray -id 0928eada7f8dd99d3b000000000000000000000001 </dev:code> <dev:remarks> <maml:para>This command will reset (reboot) the currently connected Array. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-NSAlarm</command:name> <maml:description> <maml:para>List a set of alarms or a single alarm.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>NSAlarm</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>List a set of alarms or a single alarm.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the alarm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>Identifier for type of alarm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array</maml:name> <maml:description> <maml:para>The array name where the alarm is generated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>curr_onset_event_id</maml:name> <maml:description> <maml:para>Identifier for the current onset event.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>object_id</maml:name> <maml:description> <maml:para>Identifier of object operated upon.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>object_name</maml:name> <maml:description> <maml:para>Name of object operated upon.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>object_type</maml:name> <maml:description> <maml:para>Type of the object being operated upon.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>onset_time</maml:name> <maml:description> <maml:para>Time when this alarm was triggered.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ack_time</maml:name> <maml:description> <maml:para>Time when this alarm was acknowledged.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Status of the operation -- open or acknowledged.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user_id</maml:name> <maml:description> <maml:para>Identifier of the user who acknowledged the alarm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user_name</maml:name> <maml:description> <maml:para>Username of the user who acknowledged the alarm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user_full_name</maml:name> <maml:description> <maml:para>Full name of the user who acknowledged the alarm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>category</maml:name> <maml:description> <maml:para>Category of the alarm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>severity</maml:name> <maml:description> <maml:para>Severity level of the event.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>remind_every</maml:name> <maml:description> <maml:para>Frequency of notification. This number and the remind_every_unit define how frequent one alarm notification is sent. For example, a value of 1 with the 'remind_every_unit' of 'days' results in one notification every day.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>remind_every_unit</maml:name> <maml:description> <maml:para>Time unit over which to send the number of notification specified in 'remind_every'. For example, a value of 'days' with a 'remind_every' of '1' results in one notification every day.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>activity</maml:name> <maml:description> <maml:para>Description of activity performed and recorded in alarm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>next_notification_time</maml:name> <maml:description> <maml:para>Time when next reminder for the alarm will be sent.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the alarm.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>Identifier for type of alarm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>array</maml:name> <maml:description> <maml:para>The array name where the alarm is generated.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>curr_onset_event_id</maml:name> <maml:description> <maml:para>Identifier for the current onset event.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>object_id</maml:name> <maml:description> <maml:para>Identifier of object operated upon.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>object_name</maml:name> <maml:description> <maml:para>Name of object operated upon.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>object_type</maml:name> <maml:description> <maml:para>Type of the object being operated upon.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>onset_time</maml:name> <maml:description> <maml:para>Time when this alarm was triggered.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ack_time</maml:name> <maml:description> <maml:para>Time when this alarm was acknowledged.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Status of the operation -- open or acknowledged.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>user_id</maml:name> <maml:description> <maml:para>Identifier of the user who acknowledged the alarm.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>user_name</maml:name> <maml:description> <maml:para>Username of the user who acknowledged the alarm.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>user_full_name</maml:name> <maml:description> <maml:para>Full name of the user who acknowledged the alarm.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>category</maml:name> <maml:description> <maml:para>Category of the alarm.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>severity</maml:name> <maml:description> <maml:para>Severity level of the event.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>remind_every</maml:name> <maml:description> <maml:para>Frequency of notification. This number and the remind_every_unit define how frequent one alarm notification is sent. For example, a value of 1 with the 'remind_every_unit' of 'days' results in one notification every day.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>remind_every_unit</maml:name> <maml:description> <maml:para>Time unit over which to send the number of notification specified in 'remind_every'. For example, a value of 'days' with a 'remind_every' of '1' results in one notification every day.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>activity</maml:name> <maml:description> <maml:para>Description of activity performed and recorded in alarm.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>next_notification_time</maml:name> <maml:description> <maml:para>Time when next reminder for the alarm will be sent.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSAlarm id remind_every remind_every_unit severity status category activity -- ------------ ----------------- -------- ------ -------- -------- 3c1bde905fd66eed40000000000000000000000001 1 days warning open volume Volume vol1.striped space usage at 4% is above its reserve at 2%. It will be t... </dev:code> <dev:remarks> <maml:para>This command will retrieves list of current alarms. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 2 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSAlarm -severity warning id remind_every remind_every_unit severity status category activity -- ------------ ----------------- -------- ------ -------- -------- 3c1bde905fd66eed40000000000000000000000001 1 days warning open volume Volume vol1.striped space usage at 4% is above its reserve at 2%. It will be t... </dev:code> <dev:remarks> <maml:para>This command will retrieves list of current alarms of a given severity. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 3 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Get-NSAlarm -status open id remind_every remind_every_unit severity status category activity -- ------------ ----------------- -------- ------ -------- -------- 3c1bde905fd66eed40000000000000000000000001 1 days warning open volume Volume vol1.striped space usage at 4% is above its reserve at 2%. It will be t... </dev:code> <dev:remarks> <maml:para>This command will retrieves list of current alarms that are open. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-NSAlarm</command:name> <maml:description> <maml:para>Update an alarm.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>NSAlarm</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Update an alarm.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-NSAlarm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the alarm.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>Identifier for type of alarm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array</maml:name> <maml:description> <maml:para>The array name where the alarm is generated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>curr_onset_event_id</maml:name> <maml:description> <maml:para>Identifier for the current onset event.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>object_id</maml:name> <maml:description> <maml:para>Identifier of object operated upon.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>object_name</maml:name> <maml:description> <maml:para>Name of object operated upon.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>object_type</maml:name> <maml:description> <maml:para>Type of the object being operated upon.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>onset_time</maml:name> <maml:description> <maml:para>Time when this alarm was triggered.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ack_time</maml:name> <maml:description> <maml:para>Time when this alarm was acknowledged.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Status of the operation -- open or acknowledged.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user_id</maml:name> <maml:description> <maml:para>Identifier of the user who acknowledged the alarm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user_name</maml:name> <maml:description> <maml:para>Username of the user who acknowledged the alarm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user_full_name</maml:name> <maml:description> <maml:para>Full name of the user who acknowledged the alarm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>category</maml:name> <maml:description> <maml:para>Category of the alarm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>severity</maml:name> <maml:description> <maml:para>Severity level of the event.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSAlarm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>remind_every</maml:name> <maml:description> <maml:para>Frequency of notification. This number and the remind_every_unit define how frequent one alarm notification is sent. For example, a value of 1 with the 'remind_every_unit' of 'days' results in one notification every day.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>remind_every_unit</maml:name> <maml:description> <maml:para>Time unit over which to send the number of notification specified in 'remind_every'. For example, a value of 'days' with a 'remind_every' of '1' results in one notification every day.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>activity</maml:name> <maml:description> <maml:para>Description of activity performed and recorded in alarm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>next_notification_time</maml:name> <maml:description> <maml:para>Time when next reminder for the alarm will be sent.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the alarm.</maml:para> </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="true (ByValue)" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>Identifier for type of alarm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>array</maml:name> <maml:description> <maml:para>The array name where the alarm is generated.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>curr_onset_event_id</maml:name> <maml:description> <maml:para>Identifier for the current onset event.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>object_id</maml:name> <maml:description> <maml:para>Identifier of object operated upon.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>object_name</maml:name> <maml:description> <maml:para>Name of object operated upon.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>object_type</maml:name> <maml:description> <maml:para>Type of the object being operated upon.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>onset_time</maml:name> <maml:description> <maml:para>Time when this alarm was triggered.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ack_time</maml:name> <maml:description> <maml:para>Time when this alarm was acknowledged.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Status of the operation -- open or acknowledged.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>user_id</maml:name> <maml:description> <maml:para>Identifier of the user who acknowledged the alarm.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>user_name</maml:name> <maml:description> <maml:para>Username of the user who acknowledged the alarm.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>user_full_name</maml:name> <maml:description> <maml:para>Full name of the user who acknowledged the alarm.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>category</maml:name> <maml:description> <maml:para>Category of the alarm.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>severity</maml:name> <maml:description> <maml:para>Severity level of the event.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>remind_every</maml:name> <maml:description> <maml:para>Frequency of notification. This number and the remind_every_unit define how frequent one alarm notification is sent. For example, a value of 1 with the 'remind_every_unit' of 'days' results in one notification every day.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>remind_every_unit</maml:name> <maml:description> <maml:para>Time unit over which to send the number of notification specified in 'remind_every'. For example, a value of 'days' with a 'remind_every' of '1' results in one notification every day.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>activity</maml:name> <maml:description> <maml:para>Description of activity performed and recorded in alarm.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>next_notification_time</maml:name> <maml:description> <maml:para>Time when next reminder for the alarm will be sent.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Set-nsAlarm -id 3c1bde905fd66eed40000000000000000000000001 -remind_every 1 -remind_every_unit days id remind_every remind_every_unit severity status category activity -- ------------ ----------------- -------- ------ -------- -------- 3c1bde905fd66eed40000000000000000000000001 1 days warning acknowledged volume Volume vol1.striped space usage at 4% is above its reserve at 2%. It wil... </dev:code> <dev:remarks> <maml:para>This command will update the given alarm to be reminded every 1 day. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-NSAlarm</command:name> <maml:description> <maml:para>Delete an alarm with the given ID.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>NSAlarm</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Delete an alarm with the given ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the alarm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>Identifier for type of alarm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>array</maml:name> <maml:description> <maml:para>The array name where the alarm is generated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>curr_onset_event_id</maml:name> <maml:description> <maml:para>Identifier for the current onset event.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>object_id</maml:name> <maml:description> <maml:para>Identifier of object operated upon.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>object_name</maml:name> <maml:description> <maml:para>Name of object operated upon.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>object_type</maml:name> <maml:description> <maml:para>Type of the object being operated upon.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>onset_time</maml:name> <maml:description> <maml:para>Time when this alarm was triggered.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ack_time</maml:name> <maml:description> <maml:para>Time when this alarm was acknowledged.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Status of the operation -- open or acknowledged.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user_id</maml:name> <maml:description> <maml:para>Identifier of the user who acknowledged the alarm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user_name</maml:name> <maml:description> <maml:para>Username of the user who acknowledged the alarm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>user_full_name</maml:name> <maml:description> <maml:para>Full name of the user who acknowledged the alarm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>category</maml:name> <maml:description> <maml:para>Category of the alarm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>severity</maml:name> <maml:description> <maml:para>Severity level of the event.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>remind_every</maml:name> <maml:description> <maml:para>Frequency of notification. This number and the remind_every_unit define how frequent one alarm notification is sent. For example, a value of 1 with the 'remind_every_unit' of 'days' results in one notification every day.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>remind_every_unit</maml:name> <maml:description> <maml:para>Time unit over which to send the number of notification specified in 'remind_every'. For example, a value of 'days' with a 'remind_every' of '1' results in one notification every day.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>activity</maml:name> <maml:description> <maml:para>Description of activity performed and recorded in alarm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>next_notification_time</maml:name> <maml:description> <maml:para>Time when next reminder for the alarm will be sent.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>Identifier for the alarm.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>type</maml:name> <maml:description> <maml:para>Identifier for type of alarm.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>array</maml:name> <maml:description> <maml:para>The array name where the alarm is generated.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>curr_onset_event_id</maml:name> <maml:description> <maml:para>Identifier for the current onset event.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>object_id</maml:name> <maml:description> <maml:para>Identifier of object operated upon.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>object_name</maml:name> <maml:description> <maml:para>Name of object operated upon.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>object_type</maml:name> <maml:description> <maml:para>Type of the object being operated upon.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>onset_time</maml:name> <maml:description> <maml:para>Time when this alarm was triggered.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ack_time</maml:name> <maml:description> <maml:para>Time when this alarm was acknowledged.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>status</maml:name> <maml:description> <maml:para>Status of the operation -- open or acknowledged.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>user_id</maml:name> <maml:description> <maml:para>Identifier of the user who acknowledged the alarm.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>user_name</maml:name> <maml:description> <maml:para>Username of the user who acknowledged the alarm.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>user_full_name</maml:name> <maml:description> <maml:para>Full name of the user who acknowledged the alarm.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>category</maml:name> <maml:description> <maml:para>Category of the alarm.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>severity</maml:name> <maml:description> <maml:para>Severity level of the event.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>remind_every</maml:name> <maml:description> <maml:para>Frequency of notification. This number and the remind_every_unit define how frequent one alarm notification is sent. For example, a value of 1 with the 'remind_every_unit' of 'days' results in one notification every day.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>remind_every_unit</maml:name> <maml:description> <maml:para>Time unit over which to send the number of notification specified in 'remind_every'. For example, a value of 'days' with a 'remind_every' of '1' results in one notification every day.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>activity</maml:name> <maml:description> <maml:para>Description of activity performed and recorded in alarm.</maml:para> </maml:description> <command:parameterValue required="false" 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="true (ByValue)" position="named"> <maml:name>next_notification_time</maml:name> <maml:description> <maml:para>Time when next reminder for the alarm will be sent.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Clear-NSAlarm</command:name> <maml:description> <maml:para>Acknowledge an alarm.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Clear</command:verb> <command:noun>-NSAlarm</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Acknowledge an alarm.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-NSAlarm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the acknowledged alarm.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Clear-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>remind_every</maml:name> <maml:description> <maml:para>Notification frequency unit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Clear-NSAlarm</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>remind_every_unit</maml:name> <maml:description> <maml:para>Period unit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the acknowledged alarm.</maml:para> </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="true (ByValue)" position="named"> <maml:name>remind_every</maml:name> <maml:description> <maml:para>Notification frequency unit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable`1[Int64]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int64]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>remind_every_unit</maml:name> <maml:description> <maml:para>Period unit.</maml:para> </maml:description> <command:parameterValue required="false" 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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Clear-nsAlarm -id 3c1bde905fd66eed40000000000000000000000001 data ---- @{ack_time=1533274094; activity=Volume vol1.striped space usage at 4% is above its reserve at 2%. It will be taken offline once the free space has been exhausted.; array=-; cate... </dev:code> <dev:remarks> <maml:para>This command clears (or acknowledges) a current alarm. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------- Example 2 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Clear-nsAlarm -id 3c1bde905fd66eed40000000000000000000000001 -remind_every 1 -remind_every_unit hours data ---- @{ack_time=1533274095; activity=Volume vol1.striped space usage at 4% is above its reserve at 2%. It will be taken offline once the free space has been exhausted.; array=-; cate... </dev:code> <dev:remarks> <maml:para>This command clears (or acknowledges) a current alarm, however will only silence the alarm for the designated timeframe of 1 hour. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Undo-NSAlarm</command:name> <maml:description> <maml:para>Unacknowledge an alarm.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Undo-</command:verb> <command:noun>-NSAlarm</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Unacknowledge an alarm.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Undo-NSAlarm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByName)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the acknowledged alarm.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>id</maml:name> <maml:description> <maml:para>ID of the acknowledged alarm.</maml:para> </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:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para /> </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:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1 -------------------- </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>C:\> Undo-nsAlarm -id 3c1bde905fd66eed40000000000000000000000001 data ---- @{ack_time=0; activity=Volume vol1.striped space usage at 4% is above its reserve at 2%. It will be taken offline once the free space has been exhausted.; array=-; category=volu... </dev:code> <dev:remarks> <maml:para>This command will reset the acknowledgement status current alarm back to an unacknowledged state. </maml:para> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandTest /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> </helpItems> |