SolidFire.dll-help.xml
|
<?xml version="1.0" encoding="utf-8" ?> <helpItems xmlns="http://msh" schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SFDrive</command:name> <maml:description> <maml:para>[Cluster] Adds available drives to the cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SFDrive</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Adds available drives to the cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>DriveID</maml:name> <maml:description> <maml:para>The list of drive IDs to add to the cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Adds available drives to the cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>AddDrivesResult</maml:name> <maml:uri>solidfire.github.io/sdk-dotnet</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-SFDrive -DriveID 23</dev:code> <dev:remarks> <maml:para>Adds a single available drive to the cluster by DriveID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-SFDrive -DriveID 9,13</dev:code> <dev:remarks> <maml:para>Adds two drives with IDs 9 and 13 to the cluster.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFDrive | Where-Object {$_.status -eq "available"} | Add-SFDrive</dev:code> <dev:remarks> <maml:para>Adds all available drives to the cluster.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SFInitiatorToVolumeAccessGroup</command:name> <maml:description> <maml:para>[Cluster] Adds initiators to an existing volume access group.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SFInitiatorToVolumeAccessGroup</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Adds initiators to an existing volume access group.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>Initiators</maml:name> <maml:description> <maml:para>List of initiator names (IQNs and WWPNs) to include in the volume access group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeAccessGroupID</maml:name> <maml:description> <maml:para>Enter a volume access group ID or list of volume access group IDs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 System.String[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Adds initiators to an existing volume access group.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>VolumeAccessGroup</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroup.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-SFInitiatorToVolumeAccessGroup -VolumeAccessGroupID 5 -Initiators "iqn.1994-05.com.redhat:8afd1bec9877","iqn.1998-01.com.vmware:pcl-1"</dev:code> <dev:remarks> <maml:para>Adds a pair of iSCSI initiators (IQNs) to a volume access group.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-SFInitiatorToVolumeAccessGroup -VolumeAccessGroupID 5 -Initiators "21:00:00:0e:1e:09:bb:8a"</dev:code> <dev:remarks> <maml:para>Adds a Fibre Channel initiator (WWPN) to a volume access group.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SFNode</command:name> <maml:description> <maml:para>[Cluster] Adds a SolidFire node to the cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SFNode</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Adds a SolidFire node to the cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName, FromRemainingArguments)" position="0" aliases="None"> <maml:name>PendingNodeID</maml:name> <maml:description> <maml:para>Enter one or more pending Node IDs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Adds a SolidFire node to the cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>PendingNode[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_PendingNode.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-SFNode -PendingNodeID 5</dev:code> <dev:remarks> <maml:para>Adds a single pending node to the cluster.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFPendingNode | Add-SFNode</dev:code> <dev:remarks> <maml:para>Adds all pending nodes.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SFSnmpNetwork</command:name> <maml:description> <maml:para>[Cluster] Adds an SNMP network object that is used to configure SNMP on the cluster nodes.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SFSnmpNetwork</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Adds an SNMP network object that is used to configure SNMP on the cluster nodes.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="0" aliases="None"> <maml:name>Access</maml:name> <maml:description> <maml:para>ro: read-only access.*, rw: for read-write access, rosys: for read-only access to a restricted set of system information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="1" aliases="None"> <maml:name>Cidr</maml:name> <maml:description> <maml:para>A Cidr network mask. This network mask must be an integer greater than or equal to 0, and less than or equal to 32. It must also not be equal to 31.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="2" aliases="None"> <maml:name>Community</maml:name> <maml:description> <maml:para>SNMP community string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="3" aliases="None"> <maml:name>Network</maml:name> <maml:description> <maml:para>This parameter, along with the cidr variable, is used to control which network the access and community string apply to. The special value of 'default' is used to specify an entry that applies to all networks. The cidr mask is ignored when network value is either a host name or default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Adds an SNMP network object that is used to configure SNMP on the cluster nodes.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GetSnmpACLResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpACLResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-SFSnmpNetwork -Access ro -Cidr 24 -Community readonly -Network 10.10.10.0</dev:code> <dev:remarks> <maml:para>Adds a read-only network (10.10.10.0) to the community "readonly".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SFSnmpTrapRecipient</command:name> <maml:description> <maml:para>[Cluster] Adds a host that receives traps generated by the cluster master.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SFSnmpTrapRecipient</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Adds a host that receives traps generated by the cluster master.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="1" aliases="None"> <maml:name>Community</maml:name> <maml:description> <maml:para>SNMP community string..</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="0" aliases="None"> <maml:name>Host</maml:name> <maml:description> <maml:para>The IP address or host name of the target network management station.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="2" aliases="None"> <maml:name>Port</maml:name> <maml:description> <maml:para>The UDP port number on the host where the trap is to be sent. Valid range is 1 �" 65535. 0 (zero) is not a valid port number. Most SNMP ports are at 162.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Adds a host that receives traps generated by the cluster master.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GetSnmpTrapInfoResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpTrapInfoResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-SFSnmpTrapRecipient -Host 10.10.10.10 -Community readonly -Port 162</dev:code> <dev:remarks> <maml:para>Add a single trap recipient.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SFSnmpUsmUser</command:name> <maml:description> <maml:para>[Cluster] Adds an SNMP v3 USM users object that is used to access SNMP on the cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SFSnmpUsmUser</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Adds an SNMP v3 USM users object that is used to access SNMP on the cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="0" aliases="None"> <maml:name>Access</maml:name> <maml:description> <maml:para>rouser: read-only access.*, rwuser: for read-write access, rosys: for read-only access to a restricted set of system information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="1" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the user. Must contain at least one character but be no longer than 32 characters. No blank space.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="3" aliases="None"> <maml:name>Passphrase</maml:name> <maml:description> <maml:para>The passphrase of the user. Must be between 8 and 255 characters long (inclusive). No blanks allowed. Required if 'secLevel' is 'priv'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="2" aliases="None"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password of the user. Must be between 8 and 255 characters long (inclusive). No blanks allowed. Required if 'secLevel' is 'auth' or 'priv.'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="4" aliases="None"> <maml:name>SecLevel</maml:name> <maml:description> <maml:para>'noauth': no password or passphrase required. 'auth': a password is required for user access. 'priv': a password and passphrase is required for user access.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Adds an SNMP v3 USM users object that is used to access SNMP on the cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GetSnmpACLResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpACLResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-SFSnmpUsmUser -Name snmpUser -Access rouser -Password snmpPass -Passphrase dummyPhrase -SecLevel noauth</dev:code> <dev:remarks> <maml:para>Creates a new SNMP USM user "snmpUser". Since the SecLevel is set to "noauth" the password and passphrase are entered only as dummy parameters.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-SFVolumeToVolumeAccessGroup</command:name> <maml:description> <maml:para>[Cluster] Adds one or more volumes to an existing volume access group.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Add</command:verb> <command:noun>SFVolumeToVolumeAccessGroup</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Adds one or more volumes to an existing volume access group.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeAccessGroupID</maml:name> <maml:description> <maml:para>Enter a volume access group ID or list of volume access group IDs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>List of initiator names (IQNs and WWPNs) to include in the volume access group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Adds one or more volumes to an existing volume access group.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>VolumeAccessGroup</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroup.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-SFVolumeToVolumeAccessGroup -VolumeAccessGroupID 5 -VolumeID 15</dev:code> <dev:remarks> <maml:para>Adds volume ID 15 to volume access group ID 5.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolumeAccessGroup -Name "Test" | Add-SFVolumeToVolumeAccessGroup -VolumeID 435</dev:code> <dev:remarks> <maml:para>Adds volume ID 435 to the volume access group named "Test".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolume -Name "VMware*" | Add-SFVolumeToVolumeAccessGroup -VolumeAccessGroupID 5</dev:code> <dev:remarks> <maml:para>Add all volumes with names beginning with "VMware" to volume access group ID 5.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Complete-SFClusterPairing</command:name> <maml:description> <maml:para>[Cluster] Creates an encoded key from a cluster that is used to pair with another cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Complete</command:verb> <command:noun>SFClusterPairing</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Creates an encoded key from a cluster that is used to pair with another cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>ClusterPairingKey</maml:name> <maml:description> <maml:para>A string of characters that is returned from the StartClusterPairing API method.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Creates an encoded key from a cluster that is used to pair with another cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>CompleteClusterPairingResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CompleteClusterPairingResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Start-SFClusterPairing | Complete-SFClusterPairing</dev:code> <dev:remarks> <maml:para>Completes the pairing process with the generated ClusterPairingKey.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$key = Start-SFClusterPairing Complete-SFClusterPairing -ClusterPairingKey $key.ClusterPairingKey</dev:code> <dev:remarks> <maml:para>Completes the pairing process with the generated ClusterPairingKey. Does the same as example 1 but also saves the data.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Complete-SFVolumePairing</command:name> <maml:description> <maml:para>[Cluster] Completes the pairing of two volumes.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Complete</command:verb> <command:noun>SFVolumePairing</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Completes the pairing of two volumes.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>The ID of the volume on which to complete the pairing process.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumePairingKey</maml:name> <maml:description> <maml:para>A string of characters that is returned from the StartVolumePairing API method.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String System.Int64 </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Completes the pairing of two volumes.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>CompleteVolumePairingResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CompleteVolumePairingResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Start-SFVolumePairing -VolumeID 2 -Mode Async | Complete-SFVolumePairing -VolumeID 3</dev:code> <dev:remarks> <maml:para>Saved the pairing key for volume ID 2 from the Start command, while setting Mode to "Async", and uses it to complete pairing with volume id 3.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$vol = Start-SFVolumePairing -VolumeID 8 -Mode Async Complete-SFVolumePairing -VolumeID 9 -VolumePairingKey $vol.VolumePairingKey</dev:code> <dev:remarks> <maml:para>Saved the pairing key from the Start command, while setting Mode to "Async", and uses it to complete pairing with second volume. Does same thing as example 1 butalso saves the data.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Connect-SFCluster</command:name> <maml:description> <maml:para>[Node/Cluster] Initiates a connection sequence that establishes a SolidFire node or cluster connection.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Connect</command:verb> <command:noun>SFCluster</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Node/Cluster] Initiates a connection sequence that establishes a SolidFire node or cluster connection.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue)" position="1" aliases="None"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Please supply a valid PSCredential. Use Get-Credential.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">pscredential</command:parameterValue> <dev:type> <maml:name>pscredential</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Node</maml:name> <maml:description> <maml:para>Enter a valid SF node FQDN or IP address</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="2" aliases="None"> <maml:name>Password</maml:name> <maml:description> <maml:para>Enter a valid password</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Port</maml:name> <maml:description> <maml:para>Enter the Port number</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="0" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para>Enter a valid SolidFire cluster or node FQDN or IP address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Use this parameter to change the timeout of the http client. Default is 40 seconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="1" aliases="None"> <maml:name>Username</maml:name> <maml:description> <maml:para>Enter a valid user name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>VersionApi</maml:name> <maml:description> <maml:para>Enter the API Version number</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">float</command:parameterValue> <dev:type> <maml:name>float</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCredential </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Node/Cluster] Initiates a connection sequence that establishes a SolidFire node or cluster connection.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para>Successfully connected to '[Name]' with address '[Target]'.</maml:para> </maml:description> <dev:type> <maml:name>SFConnection</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Connect-SFCluster 172.27.1.56</dev:code> <dev:remarks> <maml:para>Using the Connect-SFCluster cmdlet in this manner will create an on-screen prompt requesting the cluster admin username and password.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Connect-SFCluster 172.27.1.56 -Username clusterAdmin -Password clearPassword</dev:code> <dev:remarks> <maml:para>Note that using Connect-SFCluster in this manner requires a clear-text password be entered on the command line.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Connect-SFCluster 172.27.1.5 -Node</dev:code> <dev:remarks> <maml:para>This will create a connection to a specific node. If a node is already in a cluster, then it will use the same cluster admin credentials as the cluster. If the node has not yet been added to a cluster, then any username and password can be used. Using the Connect-SFCluster cmdlet in this manner will create an on-screen prompt requesting the cluster admin username and password.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$cred = Get-Credential $cred | Connect-SFCluster 172.27.1.56</dev:code> <dev:remarks> <maml:para>The example first prompts for cluster credentials and stores them as a PSCredential object. The credentials can then be piped directly into Connect-SFCluster. Note: Credentials stored in this manner can be saved to a file with the Export-CliXml cmdlet and retrieved with the Import-CliXml cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Connect-SFCluster 172.27.1.56 -VersionApi 7.0</dev:code> <dev:remarks> <maml:para>Connects to a cluster using a specific API end point. For example, you could connect to a cluster running 8.2 on the 7.0 end point.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Copy-SFVolume</command:name> <maml:description> <maml:para>Copies one volume to another.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Copy</command:verb> <command:noun>SFVolume</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Copies one volume to another.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>DstVolumeID</maml:name> <maml:description> <maml:para>Destination volume for the copy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SnapshotID</maml:name> <maml:description> <maml:para>Snapshot ID of the source volume to create the copy from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="Named" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>Source volume to copy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Copies one volume to another.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para>Copies one volume to another.</maml:para> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Copy-SFVolume -VolumeID 267 -DstVolumeID 269</dev:code> <dev:remarks> <maml:para>This will copy contents of VolumeID 267 to existing VolumeID 269.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Copy-SFVolume -VolumeID 267 -DstVolumeID 270 -SnapshotID 2610</dev:code> <dev:remarks> <maml:para>This copies the contents of existing SnapshotID 2610 of VolumeID 267 to existing VolumeID 270.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-SFEncryptionAtRest</command:name> <maml:description> <maml:para>[Cluster] Removes the encryption that was previously applied to the cluster using the Enable-SFEncryptionAtRest CmdLet.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>SFEncryptionAtRest</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Removes the encryption that was previously applied to the cluster using the Enable-SFEncryptionAtRest CmdLet.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Removes the encryption that was previously applied to the cluster using the Enable-SFEncryptionAtRest CmdLet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>DisableEncryptionAtRestResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_DisableEncryptionAtRestResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Disable-SFEncryptionAtRest -Confirm:$false</dev:code> <dev:remarks> <maml:para>Disables SFEncryptionAtRest with no confirmation prompt</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disable-SFSnmp</command:name> <maml:description> <maml:para>[Cluster] Disables SNMP on the SolidFire cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>SFSnmp</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Disables SNMP on the SolidFire cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Disables SNMP on the SolidFire cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GetSnmpStateResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpStateResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Disable-SFSnmp</dev:code> <dev:remarks> <maml:para>Disables SNMP on the connected cluster.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Disconnect-SFCluster</command:name> <maml:description> <maml:para>[Node/Cluster] Disconnects a cluster or node connection.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Disconnect</command:verb> <command:noun>SFCluster</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Node/Cluster] Disconnects a cluster or node connection.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of a node or cluster to disconnect from</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para>Target address of node or cluster to disconnect from</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Node/Cluster] Disconnects a cluster or node connection.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Disconnect-SFCluster</dev:code> <dev:remarks> <maml:para>Running Disconnect-SFCluster without any arguments will disconnect all SolidFire connections in $SFConnections.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Disconnect-SFCluster -Target 172.27.1.56</dev:code> <dev:remarks> <maml:para>In this case Disconnect-SFCluster will only disconnect from the specified target IP or FQDN.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Disconnect-SFCluster -Name ClusterName</dev:code> <dev:remarks> <maml:para>In this case Disconnect-SFCluster will only disconnect from the specified cluster or node name. Wildcards can be used to disconnect from multiple clusters/nodes with similar names. For example: Cluster* will disconnect from any connections whos name begins with Cluster.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-SFEncryptionAtRest</command:name> <maml:description> <maml:para>[Cluster] Enables the (AES) 256-bit encryption at rest so the cluster can manage the encryption key used for the drives on each node.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>SFEncryptionAtRest</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Enables the (AES) 256-bit encryption at rest so the cluster can manage the encryption key used for the drives on each node.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Enables the (AES) 256-bit encryption at rest so the cluster can manage the encryption key used for the drives on each node.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>EnableEncryptionAtRestResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_EnableEncryptionAtRestResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Enable-SFEncryptionAtRest -Confirm:$false</dev:code> <dev:remarks> <maml:para>Enables SF Encryption at Rest with no confirmation prompt</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-SFFeature</command:name> <maml:description> <maml:para>Enables cluster features that are disabled by default.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>SFFeature</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Enables cluster features that are disabled by default.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Feature</maml:name> <maml:description> <maml:para>Valid values: vvols: Enable the Virtual Volumes (VVOLs) cluster feature.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Enables cluster features that are disabled by default.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Enable-SFFeature</dev:code> <dev:remarks> <maml:para>Enable the Virtual Volumes (VVols) cluster feature. By default the command automatically choses to enable this without needing the "-Feature" flag.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Enable-SFFeature -Feature vvols</dev:code> <dev:remarks> <maml:para>Enable the Virtual Volumes (VVols) cluster feature. By default the "-Feature vvols" is not needed to run the command to enable "VVols".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Enable-SFSnmp</command:name> <maml:description> <maml:para>[Cluster] Enables SNMP on the SolidFire cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>SFSnmp</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Enables SNMP on the SolidFire cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>SnmpV3Enabled</maml:name> <maml:description> <maml:para>If set to 'true', then SNMP v3 is enabled on each node in the cluster. If set to 'false', then SNMP v2 is enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Enables SNMP on the SolidFire cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GetSnmpStateResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpStateResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Enable-SFSnmp -SnmpV3Enabled:$true</dev:code> <dev:remarks> <maml:para>Enable SNMP and SNMPv3.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Enable-SFSnmp -SnmpV3Enabled:$false</dev:code> <dev:remarks> <maml:para>Enable SNMP but disable SNMP v3 functionality.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFAccount</command:name> <maml:description> <maml:para>[Cluster] Gets information on all active volume accounts on a SolidFire cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFAccount</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets information on all active volume accounts on a SolidFire cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>AccountID</maml:name> <maml:description> <maml:para>Enter an account ID or list of account IDs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Username</maml:name> <maml:description> <maml:para>Enter a username or list of usernames</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] System.String[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets information on all active volume accounts on a SolidFire cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>Account[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Account.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFAccount</dev:code> <dev:remarks> <maml:para>Gets all active accounts in list format.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFAccount -Username sfadmin</dev:code> <dev:remarks> <maml:para>Gets SolidFire account object for the sfadmin account.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFAccount -Username <User1>,<User2></dev:code> <dev:remarks> <maml:para>Gets information for both UserNames.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFAccount J*</dev:code> <dev:remarks> <maml:para>Gets all accounts with a Username beginning with the letter 'J'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFAccount 5</dev:code> <dev:remarks> <maml:para>Gets account information for account with accountID 5.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFAccount 5,6,8</dev:code> <dev:remarks> <maml:para>Gets account information for accounts with accountID 5, 6, and 8.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFAccountEfficiency</command:name> <maml:description> <maml:para>[Cluster] Gets storage efficiency information for a given account.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFAccountEfficiency</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets storage efficiency information for a given account.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>AccountID</maml:name> <maml:description> <maml:para>Enter an account ID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets storage efficiency information for a given account.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GetEfficiencyResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetEfficiencyResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFAccountEfficiency -AccountID 1</dev:code> <dev:remarks> <maml:para>Gets storage efficiency information for the volumes owned by AccountID 1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$account = Get-SFAccount J* PS C:\> Get-SFAccountEfficiency $account</dev:code> <dev:remarks> <maml:para>Gets storage efficiency information for the accounts in the $account variable.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$account = Get-SFAccount J* PS C:\> $account | Get-SFAccountEfficiency</dev:code> <dev:remarks> <maml:para>Gets storage efficiency information for the accounts in the $account variable.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFActiveNode</command:name> <maml:description> <maml:para>[Cluster] Gets information about the active SolidFire nodes in the cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFActiveNode</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets information about the active SolidFire nodes in the cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Enter a node name or list of node names</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>NodeID</maml:name> <maml:description> <maml:para>Enter a node ID or list of node IDs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] System.String[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets information about the active SolidFire nodes in the cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>Node[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Node.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFActiveNode</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFActiveNode -Name "FCN*"</dev:code> <dev:remarks> <maml:para>Retrieve all nodes with names beginning with "FCN".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFActiveNode -NodeID 5,8</dev:code> <dev:remarks> <maml:para>Gets active nodes ID 5 and 8.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFASyncResult</command:name> <maml:description> <maml:para>[Cluster] Gets the result of an asynchronous method call.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFASyncResult</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets the result of an asynchronous method call.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="Named" aliases="None"> <maml:name>ASyncResultID</maml:name> <maml:description> <maml:para>Async Handle from a previous method call</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>KeepResult</maml:name> <maml:description> <maml:para>If true, GetAsyncResult does not remove the asynchronous result upon returning it, enabling future queries to that asyncHandle. Default is false.</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets the result of an asynchronous method call.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GetAsyncResultRequest</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetAsyncResultRequest.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFASyncResult -ASyncResultID 34</dev:code> <dev:remarks> <maml:para>Gets the status of the async job with ASyncResultID 34. Jobs still in process with return a status of "running". When complete the status will change to "complete".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFAsyncStatus</command:name> <maml:description> <maml:para>Gets the results of all currently running and completed asynchronous methods on the system.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFAsyncStatus</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Gets the results of all currently running and completed asynchronous methods on the system.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>AsyncResultTypes</maml:name> <maml:description> <maml:para>An optional list of types of results. You can use this list to restrict the results to only these types of operations. Possible values:BulkVolume: Copy operations between volumes, such as backups or restores.Clone: Volume cloning operations.DriveRemoval: Operations involving the system copying data from a drive in preparation to remove it from the cluster.RtfiPendingNode: Operations involving the system installing compatible software on a node before adding it to the cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Gets the results of all currently running and completed asynchronous methods on the system.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para>You can use ListAsyncResults to list the results of all currently running and completed asynchronous methods on the system. Querying asynchronous results with ListAsyncResults does not cause completed asyncHandles to expire; you can use GetAsyncResult to query any of the asyncHandles returned by ListAsyncResults.</maml:para> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFAsyncStatus</dev:code> <dev:remarks> <maml:para>Lists all currently running and completed asynchronous methods on the system with no filtering.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFAsyncStatus -AsyncResultTypes: RtfiPendingNode,BulkVolume</dev:code> <dev:remarks> <maml:para>Filtering results to node preparation or bulk copying operations.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFAsyncStatus -AsyncResultTypes: Clone,DriveRemoval</dev:code> <dev:remarks> <maml:para>Filtering results to volume cloning or drive removal preparation operations.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFBootstrapConfig</command:name> <maml:description> <maml:para>[Node] Gets the IP addresses of other nodes that have been configured with the same cluster information as the polled node.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFBootstrapConfig</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Node] Gets the IP addresses of other nodes that have been configured with the same cluster information as the polled node.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Node] Gets the IP addresses of other nodes that have been configured with the same cluster information as the polled node.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GetBootstrapConfigResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetBootstrapConfigResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFBootstrapConfig</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFBulkVolumeJob</command:name> <maml:description> <maml:para>[Cluster] Gets information about each bulk volume read and write operation occuring in the system.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFBulkVolumeJob</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets information about each bulk volume read and write operation occuring in the system.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Volume</maml:name> <maml:description> <maml:para>Please specify volume object(s)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">Volume[]</command:parameterValue> <dev:type> <maml:name>Volume[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>Enter a volume ID or list of volume IDs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>SolidFire.Element.Api.Volume[] System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets information about each bulk volume read and write operation occuring in the system.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>BulkVolumeJob[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_BulkVolumeJob.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFBulkVolumeJob</dev:code> <dev:remarks> <maml:para>Gets all bulk volume jobs executing on the system.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFBulkVolumeJob -VolumeID 3</dev:code> <dev:remarks> <maml:para>Lists bulk volume jobs for the specified volume(s).</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFClusterAdmin</command:name> <maml:description> <maml:para>[Cluster] Gets a list of all cluster administrators for the cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFClusterAdmin</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets a list of all cluster administrators for the cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets a list of all cluster administrators for the cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>ClusterAdmin[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterAdmin.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFClusterAdmin</dev:code> <dev:remarks> <maml:para>Gets all cluster admins configured on the cluster.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFClusterCapacity</command:name> <maml:description> <maml:para>[Cluster] Gets high-level capacity measurements of an entire cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFClusterCapacity</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets high-level capacity measurements of an entire cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets high-level capacity measurements of an entire cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>ClusterCapacity</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterCapacity.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFClusterCapacity</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFClusterConfig</command:name> <maml:description> <maml:para>[Node] Gets the cluster configuration of a node.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFClusterConfig</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Node] Gets the cluster configuration of a node.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Node] Gets the cluster configuration of a node.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>ClusterConfig</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterConfig.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFClusterConfig</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFClusterFault</command:name> <maml:description> <maml:para>[Cluster] Gets information about faults detected on the cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFClusterFault</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets information about faults detected on the cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName, FromRemainingArguments)" position="0" aliases="None"> <maml:name>FaultType</maml:name> <maml:description> <maml:para>Specify the fault type to retrieve faults on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets information about faults detected on the cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>ClusterFaultInfo[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterFaultInfo.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFClusterFault</dev:code> <dev:remarks> <maml:para>Gets all cluster faults, both active and resolved.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFClusterFault -FaultType current</dev:code> <dev:remarks> <maml:para>Retrieves only current (un-resolved) cluster faults.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFClusterFullThreshold</command:name> <maml:description> <maml:para>[Cluster] Gets cluster fullness levels.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFClusterFullThreshold</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets cluster fullness levels.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets cluster fullness levels.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GetClusterFullThresholdResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetClusterFullThresholdResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFClusterFullThreshold</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFClusterHardwareInfo</command:name> <maml:description> <maml:para>Gets the hardware status and information for all Fibre Channel nodes, iSCSI nodes, and drives in the cluster. This generally includes manufacturers, vendors, versions, and other associated hardware identification information.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFClusterHardwareInfo</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Gets the hardware status and information for all Fibre Channel nodes, iSCSI nodes, and drives in the cluster. This generally includes manufacturers, vendors, versions, and other associated hardware identification information.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Type</maml:name> <maml:description> <maml:para>Include only a certain type of hardware information in the response. Can be either "drives", "nodes", or "all". If this parameter is omitted, a type of "all" is assumed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Gets the hardware status and information for all Fibre Channel nodes, iSCSI nodes, and drives in the cluster. This generally includes manufacturers, vendors, versions, and other associated hardware identification information.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFClusterHardwareInfo</dev:code> <dev:remarks> <maml:para>Outputs unfiltered results. By default the '-type all' flag is set without needing to add it manually.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFClusterHardwareInfo -Type nodes</dev:code> <dev:remarks> <maml:para>Outputs information for nodes.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFClusterHardwareInfo -Type drives</dev:code> <dev:remarks> <maml:para>Outputs information for drives.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFClusterInfo</command:name> <maml:description> <maml:para>[Cluster] Gets configuration information about the cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFClusterInfo</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets configuration information about the cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets configuration information about the cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>ClusterInfo</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterInfo.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFClusterInfo</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFClusterMasterNodeID</command:name> <maml:description> <maml:para>[Cluster] Gets the ID of the node that performs cluster-wide administration tasks and holds the storage virtual IP (SVIP) and management virtual IP (MVIP).</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFClusterMasterNodeID</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets the ID of the node that performs cluster-wide administration tasks and holds the storage virtual IP (SVIP) and management virtual IP (MVIP).</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets the ID of the node that performs cluster-wide administration tasks and holds the storage virtual IP (SVIP) and management virtual IP (MVIP).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GetClusterMasterNodeIDResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetClusterMasterNodeIDResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFClusterMasterNodeID</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFClusterPair</command:name> <maml:description> <maml:para>[Cluster] Lists all of the clusters a cluster is paired with.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFClusterPair</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Lists all of the clusters a cluster is paired with.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Lists all of the clusters a cluster is paired with.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>PairedCluster[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_PairedCluster.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFClusterPair</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFClusterState</command:name> <maml:description> <maml:para>[Node] Gets the state of nodes within Cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFClusterState</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Node] Gets the state of nodes within Cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Node] Gets the state of nodes within Cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GetClusterStateResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetClusterStateResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFClusterState</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFClusterStats</command:name> <maml:description> <maml:para>[Cluster] Gets high-level activity measurements for the cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFClusterStats</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets high-level activity measurements for the cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets high-level activity measurements for the cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>ClusterStats</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterStats.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFClusterStats</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFClusterVersionInfo</command:name> <maml:description> <maml:para>[Cluster] Gets information about the Element OS software running on each node in the cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFClusterVersionInfo</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets information about the Element OS software running on each node in the cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets information about the Element OS software running on each node in the cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GetClusterVersionInfoResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetClusterVersionInfoResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFClusterVersionInfo</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFCompleteStats</command:name> <maml:description> <maml:para>[Cluster] Used by SolidFire engineering to troubleshoot new features.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFCompleteStats</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Used by SolidFire engineering to troubleshoot new features.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Used by SolidFire engineering to troubleshoot new features.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFCompleteStats</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFConfig</command:name> <maml:description> <maml:para>[Node] Gets the network and cluster configuration of a node.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFConfig</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Node] Gets the network and cluster configuration of a node.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Node] Gets the network and cluster configuration of a node.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>Config</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Config.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFConfig</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFCurrentClusterAdmin</command:name> <maml:description> <maml:para>[Cluster] Gets user information for the current cluster administrator.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFCurrentClusterAdmin</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets user information for the current cluster administrator.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets user information for the current cluster administrator.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>ClusterAdmin</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterAdmin.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFCurrentClusterAdmin</dev:code> <dev:remarks> <maml:para>Tells you which cluster admin you are currently running commands as.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFDefaultQoS</command:name> <maml:description> <maml:para>[Cluster] Gets the default QoS values that are set for a volume if QoS is not supplied.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFDefaultQoS</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets the default QoS values that are set for a volume if QoS is not supplied.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets the default QoS values that are set for a volume if QoS is not supplied.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>QoS</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_QoS.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFDefaultQoS</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFDeletedVolume</command:name> <maml:description> <maml:para>[Cluster] Gets the entire list of volumes that have been marked for deletion and purged from the system.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFDeletedVolume</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets the entire list of volumes that have been marked for deletion and purged from the system.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Enter a volume name or list of volume names</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>Enter a volume ID or list of volume IDs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] System.String[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets the entire list of volumes that have been marked for deletion and purged from the system.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>Volume[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Volume.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFDeletedVolume</dev:code> <dev:remarks> <maml:para>Gets all deleted volumes on the cluster.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFDeletedVolume -VolumeID 14,19,27</dev:code> <dev:remarks> <maml:para>Gets only volumes 14, 19 and 27.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFDeletedVolume -Name "*Cluster*"</dev:code> <dev:remarks> <maml:para>Gets a list of deleted volumes that have "Cluster" in the name.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFDrive</command:name> <maml:description> <maml:para>[Cluster] Gets a list of drives that exists in the cluster's active nodes.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFDrive</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets a list of drives that exists in the cluster's active nodes.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>DriveID</maml:name> <maml:description> <maml:para>Enter a drive ID or list of drive IDs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="0" aliases="None"> <maml:name>Status</maml:name> <maml:description> <maml:para>Filter the returned drives by one or more Status values. Valid values are: active, available, erasing, failed, removing.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets a list of drives that exists in the cluster's active nodes.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>DriveInfo[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_DriveInfo.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFDrive</dev:code> <dev:remarks> <maml:para>Gets information about all drives in the cluster.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFDrive -DriveID 15</dev:code> <dev:remarks> <maml:para>Gets information about only the specified drive(s).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFDrive -Status available</dev:code> <dev:remarks> <maml:para>Gets all drives whose status is currently "available".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFDriveConfig</command:name> <maml:description> <maml:para>[Node] Gets drive information for each drive in the node.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFDriveConfig</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Node] Gets drive information for each drive in the node.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Node] Gets drive information for each drive in the node.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>DriveConfigInfo</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_DriveConfigInfo.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFDriveConfig</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFDriveHardwareInfo</command:name> <maml:description> <maml:para>[Cluster] Gets hardware information for a specified drive.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFDriveHardwareInfo</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets hardware information for a specified drive.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>DriveID</maml:name> <maml:description> <maml:para>Enter a drive ID, or list of Drive IDs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets hardware information for a specified drive.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>DriveHardwareInfo</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_DriveHardwareInfo.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFDriveHardwareInfo -DriveID 14,18</dev:code> <dev:remarks> <maml:para>Gets drive hardware info for drive ID(s).</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFDriveStats</command:name> <maml:description> <maml:para>[Cluster] Gets high-level activity measurements for a SolidFire drive.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFDriveStats</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets high-level activity measurements for a SolidFire drive.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>DriveID</maml:name> <maml:description> <maml:para>Enter a drive ID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="0" aliases="None"> <maml:name>DriveIDs</maml:name> <maml:description> <maml:para>Enter a drive ID or list of drive IDs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets high-level activity measurements for a SolidFire drive.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>DriveStats</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_DriveStats.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFDriveStats -DriveID 15</dev:code> <dev:remarks> <maml:para>Gets stats about drive ID 15.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFDriveStats -DriveIDs 15,16,17,19</dev:code> <dev:remarks> <maml:para>Gets stats about drives with IDs 15,16,17,19.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFEvent</command:name> <maml:description> <maml:para>[Cluster] Gets events detected on the cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFEvent</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets events detected on the cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>EndEventID</maml:name> <maml:description> <maml:para>Enter an ending event ID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>MaxEvents</maml:name> <maml:description> <maml:para>Enter the maximum number of events to return</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>StartEventID</maml:name> <maml:description> <maml:para>Enter a starting event ID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets events detected on the cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>EventInfo[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_EventInfo.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFEvent</dev:code> <dev:remarks> <maml:para>Gets all events stored on the cluster. The cluster will store ~4,000 of the most recent events.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFEvent -StartEventID 1000 -EndEventID 2000</dev:code> <dev:remarks> <maml:para>Gets events with IDs between 1000 and 2000 inclusive.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFEvent -MaxEvents 10</dev:code> <dev:remarks> <maml:para>Gets the 10 most recent events ordered by EventID descending.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFFeatureStatus</command:name> <maml:description> <maml:para>Gets the status of a cluster feature.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFFeatureStatus</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Gets the status of a cluster feature.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Feature</maml:name> <maml:description> <maml:para>Valid values: vvols: Find the status of the Virtual Volumes (VVOLs) cluster feature.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Gets the status of a cluster feature.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFFeatureStatus</dev:code> <dev:remarks> <maml:para>Checks the status of the Virtual Volumes (VVols) cluster feature. By default the command automatically choses check that feature without needing the "-Feature" flag.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code> Get-SFFeatureStatus -Feature vvols</dev:code> <dev:remarks> <maml:para>Gets the status of 'VVols' cluster feature. By default the "-Feature vvols" is not needed to check "VVols" status.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFFibreChannelPortInfo</command:name> <maml:description> <maml:para>[Cluster] Gets information about Fibre Channel ports on all nodes in a cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFFibreChannelPortInfo</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets information about Fibre Channel ports on all nodes in a cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets information about Fibre Channel ports on all nodes in a cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>ListFibreChannelPortInfoResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ListFibreChannelPortInfoResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFFibreChannelPortInfo</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFFibreChannelSession</command:name> <maml:description> <maml:para>[Cluster] Gets information about the active Fibre Channel sessions on a cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFFibreChannelSession</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets information about the active Fibre Channel sessions on a cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets information about the active Fibre Channel sessions on a cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>FibreChannelSession[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_FibreChannelSession.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFFibreChannelSession</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFGroupSnapshot</command:name> <maml:description> <maml:para>[Cluster] Gets information about all group snapshots that have been created.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFGroupSnapshot</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets information about all group snapshots that have been created.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>GroupSnapshotID</maml:name> <maml:description> <maml:para>Enter a group snapshot ID or list of group snapshot IDs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>GroupSnapshotName</maml:name> <maml:description> <maml:para>Enter a snapshot name or list of snapshot names</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Volume</maml:name> <maml:description> <maml:para>Please specify volume object(s)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">Volume[]</command:parameterValue> <dev:type> <maml:name>Volume[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>An array of unique volume IDs to query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] System.String[] SolidFire.Element.Api.Volume[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets information about all group snapshots that have been created.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GroupSnapshot</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GroupSnapshot.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFGroupSnapshot</dev:code> <dev:remarks> <maml:para>Gets all group snapshots on the cluster.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFGroupSnapshot -GroupSnapshotName "VMware*"</dev:code> <dev:remarks> <maml:para>Return only group snapshots with names that begin with "VMware".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolume -Name "*Cluster*" | Get-SFGroupSnapshot</dev:code> <dev:remarks> <maml:para>Return a list of group snapshots associated with all volumes with names that include "Cluster".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFHardwareConfig</command:name> <maml:description> <maml:para>Gets the hardware configuration information for a node. NOTE: This method is available only through the per-node API endpoint 5.0 or later.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFHardwareConfig</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Gets the hardware configuration information for a node. NOTE: This method is available only through the per-node API endpoint 5.0 or later.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Gets the hardware configuration information for a node. NOTE: This method is available only through the per-node API endpoint 5.0 or later.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFHardwareConfig</dev:code> <dev:remarks> <maml:para>Gets the information for the connected node.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFHardwareInfo</command:name> <maml:description> <maml:para>Gets hardware information and status for a single node. This generally includes manufacturers, vendors, versions, drives, and other associated hardware identification information.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFHardwareInfo</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Gets hardware information and status for a single node. This generally includes manufacturers, vendors, versions, drives, and other associated hardware identification information.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Gets hardware information and status for a single node. This generally includes manufacturers, vendors, versions, drives, and other associated hardware identification information.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para>GetHardwareInfo allows you to return hardware information and status for a single node. This generally includes manufacturers, vendors, versions, drives, and other associated hardware identification information.</maml:para> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFHardwareInfo</dev:code> <dev:remarks> <maml:para>Gets the information for the connected node.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFInitiator</command:name> <maml:description> <maml:para>Lists initiator IQNs or WWPNs.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFInitiator</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Lists initiator IQNs or WWPNs.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="0" aliases="None"> <maml:name>Alias</maml:name> <maml:description> <maml:para>The friendly name to of the initiator to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="0" aliases="None"> <maml:name>InitiatorID</maml:name> <maml:description> <maml:para>The IDs of the initiators to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="0" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the initiator (IQN or WWPN) to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="0" aliases="None"> <maml:name>VolumeAccessGroupID</maml:name> <maml:description> <maml:para>The ID of the volume access group in the initiator to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Lists initiator IQNs or WWPNs.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFInitiator</dev:code> <dev:remarks> <maml:para>Lists all initiators with no filtering.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFInitiator -Alias test</dev:code> <dev:remarks> <maml:para>Lists all initiators with alias "test".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFInitiator -Name test*</dev:code> <dev:remarks> <maml:para>Outputs initiator with name begining with "test".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFInitiator -InitiatorID 1</dev:code> <dev:remarks> <maml:para>Outputs initiator with ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFIscsiSession</command:name> <maml:description> <maml:para>[Cluster] Gets information about the iSCSI sessions for each volume.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFIscsiSession</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets information about the iSCSI sessions for each volume.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets information about the iSCSI sessions for each volume.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>ISCSISession[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ISCSISession.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFIscsiSession</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFLdapConfiguration</command:name> <maml:description> <maml:para>[Cluster] Gets the current LDAP configuration on cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFLdapConfiguration</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets the current LDAP configuration on cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets the current LDAP configuration on cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>LdapConfiguration</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/P_SolidFire_Element_Api_GetLdapConfigurationResult_LdapConfiguration.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFLdapConfiguration</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFLimits</command:name> <maml:description> <maml:para>[Cluster] Gets the limit values defined on the cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFLimits</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets the limit values defined on the cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets the limit values defined on the cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GetLimitsResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetLimitsResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFLimits</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFLoginSessionInfo</command:name> <maml:description> <maml:para>[Cluster] Gets the period of time a login authentication is valid for both login shells and the TUI.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFLoginSessionInfo</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets the period of time a login authentication is valid for both login shells and the TUI.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets the period of time a login authentication is valid for both login shells and the TUI.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>LoginSessionInfo</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_LoginSessionInfo.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFLoginSessionInfo</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFLunAssignment</command:name> <maml:description> <maml:para>[Cluster] Gets LUN mappings of a specified volume access group.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFLunAssignment</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets LUN mappings of a specified volume access group.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeAccessGroup</maml:name> <maml:description> <maml:para>Enter a volume access group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">VolumeAccessGroup[]</command:parameterValue> <dev:type> <maml:name>VolumeAccessGroup[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeAccessGroupID</maml:name> <maml:description> <maml:para>Enter a volume access group ID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] SolidFire.Element.Api.VolumeAccessGroup[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets LUN mappings of a specified volume access group.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>VolumeAccessGroupLunAssignments</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroupLunAssignments.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFLunAssignment -VolumeAccessGroupID 1</dev:code> <dev:remarks> <maml:para>Gets LUN mappings of volume access group ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFNetworkConfig</command:name> <maml:description> <maml:para>[Node] Gets the network configuration of a node.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFNetworkConfig</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Node] Gets the network configuration of a node.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Node] Gets the network configuration of a node.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>Network</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Network.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFNetworkConfig</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFNetworkInterface</command:name> <maml:description> <maml:para>[Cluster] Gets information about each network interface on all nodes in a cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFNetworkInterface</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets information about each network interface on all nodes in a cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets information about each network interface on all nodes in a cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>ListNetworkInterfacesResult[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ListNetworkInterfacesResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFNetworkInterface</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFNodeHardwareInfo</command:name> <maml:description> <maml:para>Gets all the hardware info and status for the node specified. This generally includes manufacturers, vendors, versions, and other associated hardware identification information.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFNodeHardwareInfo</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Gets all the hardware info and status for the node specified. This generally includes manufacturers, vendors, versions, and other associated hardware identification information.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="Named" aliases="None"> <maml:name>NodeID</maml:name> <maml:description> <maml:para>The ID of the node for which hardware information is being requested. Information about a node is returned if a node is specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Gets all the hardware info and status for the node specified. This generally includes manufacturers, vendors, versions, and other associated hardware identification information.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFHardwareInfo -NodeID 1</dev:code> <dev:remarks> <maml:para>Gets the node information from node ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFNodeStats</command:name> <maml:description> <maml:para>[Cluster] Gets the high-level activity measurements for a node or all nodes.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFNodeStats</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets the high-level activity measurements for a node or all nodes.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>NodeID</maml:name> <maml:description> <maml:para>Enter a node ID or list of node IDs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets the high-level activity measurements for a node or all nodes.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>NodeStatsInfo[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_NodeStatsInfo.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFNodeStats</dev:code> <dev:remarks> <maml:para>Gives an unfiltered list of activity measurements for all nodes in cluster.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFNodeStats -NodeID 1</dev:code> <dev:remarks> <maml:para>Lists activity measurements for nodes ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFNtpInfo</command:name> <maml:description> <maml:para>[Cluster] Gets the current network time protocol (NTP) configuration information.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFNtpInfo</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets the current network time protocol (NTP) configuration information.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets the current network time protocol (NTP) configuration information.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GetNtpInfoResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetNtpInfoResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFNtpInfo</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFNvramInfo</command:name> <maml:description> <maml:para>Gets information from each node about the NVRAM card.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFNvramInfo</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Gets information from each node about the NVRAM card.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Gets information from each node about the NVRAM card.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFNvramInfo</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFPendingNode</command:name> <maml:description> <maml:para>[Cluster] Gets information on pending SolidFire nodes that could be added to the cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFPendingNode</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets information on pending SolidFire nodes that could be added to the cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Enter a pending node name or list of pending node names.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>PendingNodeID</maml:name> <maml:description> <maml:para>Enter a pending node ID or list of pending node IDs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] System.String[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets information on pending SolidFire nodes that could be added to the cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>PendingNode[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_PendingNode.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFPendingNode</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFPendingNode -PendingNodeID 1,2</dev:code> <dev:remarks> <maml:para>Gets pending nodes with IDs 1 and 2.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFPendingNode -Name "SFNode*"</dev:code> <dev:remarks> <maml:para>Gets all pending nodes whose name begins with "SFNode".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFPendingOperation</command:name> <maml:description> <maml:para>[Node] Detects an operation on a node that is currently in progress.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFPendingOperation</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Node] Detects an operation on a node that is currently in progress.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Node] Detects an operation on a node that is currently in progress.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>PendingOperation</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_PendingOperation.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFPendingOperation</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFProtocolEndpoint</command:name> <maml:description> <maml:para>Gets protocol endpoints in the system</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFProtocolEndpoint</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Gets protocol endpoints in the system </maml:para> <maml:para>If protocolEndpointIDs isn't specified all protocol endpoints </maml:para> <maml:para>are returned. Else the supplied protocolEndpointIDs are.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="Named" aliases="None"> <maml:name>ProtocolEndpointIDs</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">guid[]</command:parameterValue> <dev:type> <maml:name>guid[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Gets protocol endpoints in the system </maml:para> <maml:para>If protocolEndpointIDs isn't specified all protocol endpoints </maml:para> <maml:para>are returned. Else the supplied protocolEndpointIDs are.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFProtocolEndpoint</dev:code> <dev:remarks> <maml:para>Outputs all Protocol Endpoints.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$pEnd = Get-SFProtocolEndpoint $pEnd[2]</dev:code> <dev:remarks> <maml:para>Saves output and prints 3rd endpoint's data.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code> Get-SFProtocolEndpoint -ProtocolEndpointIDs 3ffb55f2-98d1-43bd-88c6-90f939251252</dev:code> <dev:remarks> <maml:para>Outputs the protocol endpoint information for selected ProtocolEndpointID. In this case, ProtocolEndpointID: "3ffb55f2-98d1-43bd-88c6-90f939251252".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFRawStats</command:name> <maml:description> <maml:para>[Cluster] Used by SolidFire engineering to troubleshoot new features.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFRawStats</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Used by SolidFire engineering to troubleshoot new features.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Used by SolidFire engineering to troubleshoot new features.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFRawStats</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFRemoteLoggingHost</command:name> <maml:description> <maml:para>[Cluster] Retrieves the current list of log servers.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFRemoteLoggingHost</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Retrieves the current list of log servers.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Retrieves the current list of log servers.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>LoggingServer[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_LoggingServer.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFRemoteLoggingHost</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFSchedule</command:name> <maml:description> <maml:para>[Cluster] Gets the scheduled snapshots on a cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFSchedule</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets the scheduled snapshots on a cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>ScheduleID</maml:name> <maml:description> <maml:para>Enter a schedule ID or list of schedule IDs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets the scheduled snapshots on a cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>Schedule[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Schedule.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFSchedule</dev:code> <dev:remarks> <maml:para>Lists all schedules.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFSchedule -ScheduleID 5</dev:code> <dev:remarks> <maml:para>Get single Schedule by ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFSchedule -ScheduleID 5,6,7,8,9,10</dev:code> <dev:remarks> <maml:para>Gets list of Schedules by ID.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFServices</command:name> <maml:description> <maml:para>[Cluster] Lists the services running on the cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFServices</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>You can use ListServices to return the services information for nodes, drives, current software, and other services that are running on the cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can use ListServices to return the services information for nodes, drives, current software, and other services that are running on the cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>DetailedService[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_DetailedService.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFServices</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFSnapshot</command:name> <maml:description> <maml:para>[Cluster] Gets the attributes of each snapshot taken on a volume.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFSnapshot</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets the attributes of each snapshot taken on a volume.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>SnapshotID</maml:name> <maml:description> <maml:para>Enter a snapshot ID or list of snapshot IDs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>SnapshotName</maml:name> <maml:description> <maml:para>Enter a snapshot name or list of snapshot names.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Volume</maml:name> <maml:description> <maml:para>Specify volume object(s)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">Volume[]</command:parameterValue> <dev:type> <maml:name>Volume[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>Enter a volume ID or list of volume IDs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] System.String[] SolidFire.Element.Api.Volume[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets the attributes of each snapshot taken on a volume.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>Snapshot[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Snapshot.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFSnapshot</dev:code> <dev:remarks> <maml:para>Gets all snapshots for all volumes on the cluster.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFSnapshot -SnapshotID 36</dev:code> <dev:remarks> <maml:para>Gets the attributes from snapshot ID 36.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFSnapshot -SnapshotName "VMware*"</dev:code> <dev:remarks> <maml:para>Gets all snapshots that include "VMware" at the beginning of the snapshot name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolume -Name "VM*" | Get-SFSnapshot</dev:code> <dev:remarks> <maml:para>Gets all snapshots from any volumes that inlcude "VM" at the beginning of the volume name.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFSnmpAcl</command:name> <maml:description> <maml:para>[Cluster] Gets the current SNMP access permissions on cluster nodes.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFSnmpAcl</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets the current SNMP access permissions on cluster nodes.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets the current SNMP access permissions on cluster nodes.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GetSnmpACLResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpACLResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFSnmpAcl</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFSnmpInfo</command:name> <maml:description> <maml:para>[Cluster] Gets the current SNMP configuration information.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFSnmpInfo</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets the current SNMP configuration information.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets the current SNMP configuration information.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GetSnmpInfoResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpInfoResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFSnmpInfo</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFSnmpState</command:name> <maml:description> <maml:para>[Cluster] Gets the current state of the SNMP feature.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFSnmpState</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets the current state of the SNMP feature.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets the current state of the SNMP feature.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GetSnmpStateResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpStateResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFSnmpState</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFSnmpTrapInfo</command:name> <maml:description> <maml:para>[Cluster] Gets current SNMP trap configuration information.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFSnmpTrapInfo</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets current SNMP trap configuration information.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets current SNMP trap configuration information.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SFSnmpTrapInfo</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpTrapInfoResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFSnmpTrapInfo</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFStorageContainer</command:name> <maml:description> <maml:para>Gets information for all storage containers currently in the system.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFStorageContainer</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Gets information for all storage containers currently in the system.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="Named" aliases="None"> <maml:name>StorageContainerID</maml:name> <maml:description> <maml:para>List of storage containers to get</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">guid[]</command:parameterValue> <dev:type> <maml:name>guid[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Gets information for all storage containers currently in the system.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFStorageContainer</dev:code> <dev:remarks> <maml:para>Gets information an all storage contains.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$sContainer = Get-SFStorageContainer $sContainer[4]</dev:code> <dev:remarks> <maml:para>Stores data and outputs 5th item in list.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFStorageContainer -StorageContainerID e8087af0-c85d-4018-b7db-9e5249cf34ff</dev:code> <dev:remarks> <maml:para>Gets information for specific storage container by ID. In this case, StorageContainerID: "e8087af0-c85d-4018-b7db-9e5249cf34ff".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFStorageContainerEfficiency</command:name> <maml:description> <maml:para>Gets efficiency information about a virtual volume storage container.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFStorageContainerEfficiency</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Gets efficiency information about a virtual volume storage container.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="Named" aliases="None"> <maml:name>StorageContainerID</maml:name> <maml:description> <maml:para>The ID of the storage container for which to retrieve efficiency information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">guid</command:parameterValue> <dev:type> <maml:name>guid</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Gets efficiency information about a virtual volume storage container.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$sc = Get-SFStorageContainer Get-SFStorageContainerEfficiency -StorageContainerID $sc[3].StorageContainerID</dev:code> <dev:remarks> <maml:para>Gets the efficiency info from the 4th storage container.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFStorageContainerEfficiency -StorageContainerID e8087af0-c85d-4018-b7db-9e5249cf34ff</dev:code> <dev:remarks> <maml:para>Gets the efficiency info from the specified storage container by ID. In this case, StorageContainerID: "e8087af0-c85d-4018-b7db-9e5249cf34ff"</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFSyncJob</command:name> <maml:description> <maml:para>[Cluster] Gets information about the synchronization jobs that are running on a SolidFire cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFSyncJob</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets information about the synchronization jobs that are running on a SolidFire cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets information about the synchronization jobs that are running on a SolidFire cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SyncJob</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_SyncJob.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFSyncJob</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFSystemStatus</command:name> <maml:description> <maml:para>[Cluster] Gets status of nodes in a SolidFire cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFSystemStatus</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets status of nodes in a SolidFire cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets status of nodes in a SolidFire cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GetSystemStatusResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSystemStatusResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFSystemStatus</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFTests</command:name> <maml:description> <maml:para>[Node] Gets the tests that are available to run on a node.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFTests</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Node] Gets the tests that are available to run on a node.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Node] Gets the tests that are available to run on a node.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>ListTestsResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ListTestsResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFTests</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFUtilities</command:name> <maml:description> <maml:para>[Node] Gets the utilities that are available to run on a node.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFUtilities</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Node] Gets the utilities that are available to run on a node.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Node] Gets the utilities that are available to run on a node.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>ListUtilitiesResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ListUtilitiesResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFUtilities</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFVirtualNetwork</command:name> <maml:description> <maml:para>[Cluster] Gets a list of all the configured virtual networks for the cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFVirtualNetwork</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets a list of all the configured virtual networks for the cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VirtualNetworkID</maml:name> <maml:description> <maml:para>Enter a VirtualNetworkID or list of VirtualNetworkIDs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VirtualNetworkTag</maml:name> <maml:description> <maml:para>Enter a VirtualNetworkTag or list of VirtualNetworkTag.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets a list of all the configured virtual networks for the cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>VirtualNetwork[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VirtualNetwork.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVirtualNetwork</dev:code> <dev:remarks> <maml:para>Gets all virtual networks configured on the cluster.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVirtualNetwork -VirtualNetworkID 12</dev:code> <dev:remarks> <maml:para>Gets the specified virtual network(s).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVirtualNetwork -VirtualNetworkTag 120</dev:code> <dev:remarks> <maml:para>Gets the virtual network corresponding to the specified VLAN tag.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFVirtualVolume</command:name> <maml:description> <maml:para>Gets a list of the virtual volumes currently in the system. You can use this method to list all virtual volumes, or only list a subset.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFVirtualVolume</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Gets a list of the virtual volumes currently in the system. You can use this method to list all virtual volumes, or only list a subset.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Details</maml:name> <maml:description> <maml:para>Possible values: true: Include more details about each VVOL in the response. false: Include the standard level of detail about each VVOL in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Limit</maml:name> <maml:description> <maml:para>The maximum number of virtual volumes to list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Recursive</maml:name> <maml:description> <maml:para>Possible values:true: Include information about the children of each VVOL in the response. false: Do not include information about the children of each VVOL in the response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>StartVirtualVolumeID</maml:name> <maml:description> <maml:para>The ID of the virtual volume at which to begin the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">guid</command:parameterValue> <dev:type> <maml:name>guid</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>VirtualVolumeIDs</maml:name> <maml:description> <maml:para>A list of virtual volume IDs for which to retrieve information. If you specify this parameter, the method returns information about only these virtual volumes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">guid[]</command:parameterValue> <dev:type> <maml:name>guid[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Gets a list of the virtual volumes currently in the system. You can use this method to list all virtual volumes, or only list a subset.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVirtualVolume</dev:code> <dev:remarks> <maml:para>Lists all VVols in the system with default output.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVirtualVolume -Details:$true -Limit 2</dev:code> <dev:remarks> <maml:para>Lists VVols with additional details but limits list to the first 2 VVols.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$vvols = Get-SFVirtualVolume Get-SFVirtualVolume -StartVirtualVolumeID $vvols[4].VirtualVolumeID</dev:code> <dev:remarks> <maml:para>Gets the VVols information and then lists it out starting at the 5th entry.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFVirtualVolumeBinding</command:name> <maml:description> <maml:para>Gets a list of VVol bindings.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFVirtualVolumeBinding</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Gets a list of VVol bindings.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>VirtualVolumeBindingIDs</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Gets a list of VVol bindings.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVirtualVolumeBinding</dev:code> <dev:remarks> <maml:para>Lists all VVol bindings. If none, returns empty object.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVirtualVolumeBinding -VirtualVolumeBindingIDs 14,15,16</dev:code> <dev:remarks> <maml:para>Returns VVol binding by ID.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFVirtualVolumeCount</command:name> <maml:description> <maml:para>Gets the number of virtual volumes currently in the system.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFVirtualVolumeCount</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Gets the number of virtual volumes currently in the system.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Gets the number of virtual volumes currently in the system.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVirtualVolumeCount</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFVirtualVolumeHost</command:name> <maml:description> <maml:para>Gets a list of known ESX hosts.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFVirtualVolumeHost</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Gets a list of known ESX hosts.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>VirtualVolumeHostIDs</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">guid[]</command:parameterValue> <dev:type> <maml:name>guid[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Gets a list of known ESX hosts.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVirtualVolumeHost</dev:code> <dev:remarks> <maml:para>Gets all knowns ESX hosts.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFVirtualVolumeTask</command:name> <maml:description> <maml:para>Gets a list of VVol Async Tasks.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFVirtualVolumeTask</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Gets a list of VVol Async Tasks.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>VirtualVolumeTaskIDs</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">guid[]</command:parameterValue> <dev:type> <maml:name>guid[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Gets a list of VVol Async Tasks.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVirtualVolumeTask</dev:code> <dev:remarks> <maml:para>Gets a list of VVols Async Tasks.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFVolume</command:name> <maml:description> <maml:para>[Cluster] Gets a list of volumes from the cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFVolume</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets a list of volumes from the cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Account</maml:name> <maml:description> <maml:para>Specify account(s).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">Account[]</command:parameterValue> <dev:type> <maml:name>Account[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>AccountID</maml:name> <maml:description> <maml:para>Enter an Account ID or list of Account IDs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="1" aliases="None"> <maml:name>ExcludeVVOLs</maml:name> <maml:description> <maml:para>Use -ExcludeVVOLs to exclude volumes that are Virtual Volumes from the returned volumes.</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="2" aliases="None"> <maml:name>IncludeDeleted</maml:name> <maml:description> <maml:para>Use -IncludeDeleted to specify if the resultset should be active volumes only (default) or also include deleted volumes.</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Enter a volume name or list of volume names.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>Enter a VolumeID or list of VolumeIDs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] System.String[] SolidFire.Element.Api.Account[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets a list of volumes from the cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>Volume[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Volume.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolume</dev:code> <dev:remarks> <maml:para>Gets all active volumes on the system.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolume -Name "VM*" -IncludeDeleted</dev:code> <dev:remarks> <maml:para>Gets all volumes, both active and deleted, with names that begin with "VM".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolume -VolumeID 3</dev:code> <dev:remarks> <maml:para>Return only the volume with ID 3.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolume -AccountID 13</dev:code> <dev:remarks> <maml:para>Gets all volumes associated with account ID 13.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFAccount -Username "Customer*" | Get-SFVolume</dev:code> <dev:remarks> <maml:para>Gets all volumes associated with all accounts that have names beginning with "Customer".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFVolumeAccessGroup</command:name> <maml:description> <maml:para>[Cluster] Gets information about a SolidFire volume access group.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFVolumeAccessGroup</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets information about a SolidFire volume access group.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Enter a volume name or list of volume names.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeAccessGroupID</maml:name> <maml:description> <maml:para>Enter a volume access group ID or list of volume access group IDs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] System.String[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets information about a SolidFire volume access group.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>VolumeAccessGroup[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroup.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolumeAccessGroup</dev:code> <dev:remarks> <maml:para>Gets all volume access groups on the cluster.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolumeAccessGroup -Name "VM*"</dev:code> <dev:remarks> <maml:para>Gets all volume access groups with a name beginning with "VM".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolumeAccessGroup -VolumeAccessGroupID 2,3</dev:code> <dev:remarks> <maml:para>Gets the specified volume access group(s).</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFVolumeAccessGroupEfficiency</command:name> <maml:description> <maml:para>[Cluster] Gets efficiency information about all volumes in a volume access group.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFVolumeAccessGroupEfficiency</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets efficiency information about all volumes in a volume access group.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeAccessGroup</maml:name> <maml:description> <maml:para>Enter a volume access group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">VolumeAccessGroup[]</command:parameterValue> <dev:type> <maml:name>VolumeAccessGroup[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeAccessGroupID</maml:name> <maml:description> <maml:para>Enter a volume access group ID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] SolidFire.Element.Api.VolumeAccessGroup[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets efficiency information about all volumes in a volume access group.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GetVolumeEfficiencyResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetVolumeEfficiencyResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolumeAccessGroupEfficiency -VolumeAccessGroupID 13</dev:code> <dev:remarks> <maml:para>Gets efficiency information for the volume access group with ID 13.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolumeAccessGroup -VolumeAccessGroupName "VMware*" | Get-SFVolumeAccessGroupEfficiency</dev:code> <dev:remarks> <maml:para>Gets the efficiency for any volume access group where the name begins with "VMware".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFVolumeEfficiency</command:name> <maml:description> <maml:para>[Cluster] Gets efficiency information about a volume.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFVolumeEfficiency</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets efficiency information about a volume.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>Enter a volume ID or list of volume IDs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets efficiency information about a volume.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GetVolumeEfficiencyResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetVolumeEfficiencyResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolumeEfficiency -VolumeID 19</dev:code> <dev:remarks> <maml:para>Gets the values for the most recent automatic calculation of efficiency numbers for volume ID 19.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolumeEfficiency -VolumeID 19 -ForceGet</dev:code> <dev:remarks> <maml:para>The -ForceGet parameter forces the cluster to recalculate the efficiency numbers for that volume immediately rather than returning the stored values from the most recent automatic run.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFVolumePair</command:name> <maml:description> <maml:para>[Cluster] Gets a list of all of the active paired volumes paired with a volume.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFVolumePair</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets a list of all of the active paired volumes paired with a volume.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets a list of all of the active paired volumes paired with a volume.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>Volume[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Volume.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolumePair</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFVolumeStats</command:name> <maml:description> <maml:para>[Cluster] Gets high-level activity measurements for the specified volume(s).</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFVolumeStats</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Gets high-level activity measurements for the specified volume(s).</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>AccountID</maml:name> <maml:description> <maml:para>Enter an AccountID or list of AccountIDs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeAccessGroupID</maml:name> <maml:description> <maml:para>Enter a volume access group ID or list of volume access group IDs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>Enter a volume ID or list of volume IDs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Gets high-level activity measurements for the specified volume(s).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>VolumeStats[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeStats.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolumeStats</dev:code> <dev:remarks> <maml:para>Gets volume stats for all volumes on the cluster.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolumeStats -VolumeID 13,15</dev:code> <dev:remarks> <maml:para>Gets volume stats for the specified volume(s).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolumeStats -AccountID 13</dev:code> <dev:remarks> <maml:para>Gets volume stats for all volumes associated with account ID 13.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolumeStats -VolumeAccessGroupID 15</dev:code> <dev:remarks> <maml:para>Gets stats for all volumes included in volume access group ID 15.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolume -Name "*VMware*" | Get-SFVolumeStats</dev:code> <dev:remarks> <maml:para>Gets volume stats for all volumes that have "VMware" in the volume name.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SFVolumeStatsByVirtualVolume</command:name> <maml:description> <maml:para>Gets a list of virtual volume statistics for any virtual volume in system.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFVolumeStatsByVirtualVolume</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Gets a list of virtual volume statistics for any virtual volume in system.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="Named" aliases="None"> <maml:name>VirtualVolumeID</maml:name> <maml:description> <maml:para>A list of virtual volume IDs used to retrieve information. If you specify this parameter, the method returns information about only these virtual volumes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">guid[]</command:parameterValue> <dev:type> <maml:name>guid[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Gets a list of virtual volume statistics for any virtual volume in system.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolumeStatsByVirtualVolume</dev:code> <dev:remarks> <maml:para>Gets a list of VVol stats for all VVols in the system.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$vvols = Get-SFVolumeStatsByVirtualVolume Get-SFVolumeStatsByVirtualVolume -VirtualVolumeID $vvols[3].VirtualVolumeID</dev:code> <dev:remarks> <maml:para>Gets stats for a VVol specified by VirtualVolumeID. VirtualVolumeIDs look like: "ad0b08a1-7818-4dd5-9b95-ba376b634780".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-SFApi</command:name> <maml:description> <maml:para>[Node/Cluster] A generic cmdlet that invokes any SolidFire API method.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>SFApi</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Node/Cluster] A generic cmdlet that invokes any SolidFire API method.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="2" aliases="None"> <maml:name>ForcePort</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Method</maml:name> <maml:description> <maml:para>Enter the API Method to call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>Params</maml:name> <maml:description> <maml:para>Enter any parameters to be passed into this API Method in the form of a Hashtable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">hashtable</command:parameterValue> <dev:type> <maml:name>hashtable</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String System.Collections.Hashtable </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Node/Cluster] A generic cmdlet that invokes any SolidFire API method.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para>The deserialized JSON returned from the API in the form of a Hashtable</maml:para> </maml:description> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Invoke-SFApi -Method "GetClusterCapacity"</dev:code> <dev:remarks> <maml:para>Runs the GetClusterCapacity method against the API and returns a Hashtable of the response.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Invoke-SFApi -Method "AddAccount" -Params @{ "username" = "TestAccount"; "initiatorSecret" = "123abc123abc"; "targetSecret" = "789xyz789xyz"}</dev:code> <dev:remarks> <maml:para>Creates a new account by directly calling the "AddAccount" API method. Note that the parameters are built as an in-line hashtable.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$acct = @{} $acct.Add("username","TestAcct2") $acct.Add("initiatorSecret","123451234512345") $acct.Add("targetSecret","abcdeabcdeabcde") Invoke-SFApi -Method "AddAccount" -Params $acct</dev:code> <dev:remarks> <maml:para>Builds the parameter hash table one element at a time and then calls Invoke-SFApi leveraging the variable contents.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Array Example: @("First", "Second", "Third") Hashtable/Object Example: @{"First" = "1st"; "Second" = "2nd"; "Third" = "3rd"} Nested Hashtable Example: @{"NestedObject" = @{"One" = 1; "Two" = 2}; "Status" = "Active"}</dev:code> <dev:remarks> <maml:para>Sometimes the "Params" parameter needs json objects or an array. In order to pass nested json objects and json arrays, use the "@" sign to prepend each item. Objects should be wrapped with curly brackets "{}" and arrays should be wrapped with parentheses "()". Items in an array should be separated with a comma and items in a hashtable/object should be separated with a semicolon.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-SFRestoreDeletedVolume</command:name> <maml:description> <maml:para>[Cluster] Marks a deleted volume as active again.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>SFRestoreDeletedVolume</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Marks a deleted volume as active again.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>Enter a VolumeID for the deleted volume to restore.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Marks a deleted volume as active again.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>Volume</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Volume.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Invoke-SFRestoreDeletedVolume -VolumeID 548</dev:code> <dev:remarks> <maml:para>Restore volume ID 548 from a deleted state back to an active state.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFDeletedVolume | Invoke-SFRestoreDeletedVolume</dev:code> <dev:remarks> <maml:para>Restore all volumes that are currently deleted.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-SFRollbackToGroupSnapshot</command:name> <maml:description> <maml:para>[Cluster] Rolls back all individual volumes in a snapshot group to each volume's individual snapshot.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>SFRollbackToGroupSnapshot</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Rolls back all individual volumes in a snapshot group to each volume's individual snapshot.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="3" aliases="None"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>Attributes to set</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">hashtable</command:parameterValue> <dev:type> <maml:name>hashtable</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>GroupSnapshotID</maml:name> <maml:description> <maml:para>Enter a GroupSnapshotID for the volume to restore.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name for the snapshot. If no name is given then the name of the snapshot being rolled back to is used with '- copy' appended to the end of the name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="2" aliases="None"> <maml:name>SaveCurrentState</maml:name> <maml:description> <maml:para>true: The previous active volume image is kept. false: (default) The previous active volume image is deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 System.String System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Rolls back all individual volumes in a snapshot group to each volume's individual snapshot.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>CreateGroupSnapshotResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CreateGroupSnapshotResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Invoke-SFRollbackToGroupSnapshot -GroupSnapshotID 30</dev:code> <dev:remarks> <maml:para>Rolls the group of volumes back to the specified group snapshot but does not preserve the current state.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Invoke-SFRollbackToGroupSnapshot -GroupSnapshotID 30 -SaveCurrentState:$true -Name CurrentStateGroupSnapshot</dev:code> <dev:remarks> <maml:para>Rolls the group of volumes back to the specified group snapshot. In this case, the command first takes a new group snapshot of the current volumes' state named "CurrentStateGroupSnapshot" prior to rolling back to the snapshot.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolume -Name RCLPSMTestVol-02 | Get-SFGroupSnapshot -GroupSnapshotName Tuesday | Invoke-SFRollbackToGroupSnapshot -SaveCurrentState:$true -Name CurrentStateGroupSnapsnot</dev:code> <dev:remarks> <maml:para>Finds the group snapshot named "Tuesday" where the volume "RCLPSMTestVol-02" is a member. Then rolls back to this snapshot while saving the current state as a new group snapshot "CurrentStateGroupSnapshot"</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-SFRollbackToSnapshot</command:name> <maml:description> <maml:para>[Cluster] Makes an existing snapshot the "active" volume image.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>SFRollbackToSnapshot</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Makes an existing snapshot the "active" volume image.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="4" aliases="None"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>Attributes to set</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">hashtable</command:parameterValue> <dev:type> <maml:name>hashtable</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="2" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name for the snapshot. If no name is given then the name of the snapshot being rolled back to is used with '- copy' appended to the end of the name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="3" aliases="None"> <maml:name>SaveCurrentState</maml:name> <maml:description> <maml:para>true: The previous active volume image is kept. false: (default) The previous active volume image is deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>SnapshotID</maml:name> <maml:description> <maml:para>Enter the SnapshotID of a previously created snapshot on the given volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>Enter a VolumeID for the volume to restore.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 System.String System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Makes an existing snapshot the "active" volume image.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>CreateSnapshotResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CreateSnapshotResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Invoke-SFRollbackToSnapshot -VolumeID 477 -SnapshotID 2506</dev:code> <dev:remarks> <maml:para>Rolls the volume back to the specified snapshot but does not preserve the current state.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Invoke-SFRollbackToSnapshot -VolumeID 477 -SnapshotID 2506 -SaveCurrentState:$true -Name CurrentStateSnapshot</dev:code> <dev:remarks> <maml:para>Rolls the volume back to the specified snapshot. In this case, the command first takes a new snapshot of the current state named "CurrentStateSnapshot" prior to rolling back to the snapshot.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolume -Name SampleVol01 | Get-SFSnapshot -SnapshotName Tuesday | Invoke-SFRollbackToSnapshot -SaveCurrentState:$true -Name CurrentStateSnapshot</dev:code> <dev:remarks> <maml:para>Rolls back the volume named "SampleVol01" to the snapshot named "Tuesday" and saves the current state to a new snapshot named "CurrentStateSnapshot".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-SFSecureEraseDrive</command:name> <maml:description> <maml:para>[Cluster] Removes any residual data from a drive using a Security Erase Unit command and resetting the encryption key on the drive.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>SFSecureEraseDrive</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Removes any residual data from a drive using a Security Erase Unit command and resetting the encryption key on the drive.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Drive</maml:name> <maml:description> <maml:para>Please pass in a SFDrive or list of SFDrives</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">DriveInfo[]</command:parameterValue> <dev:type> <maml:name>DriveInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>DriveID</maml:name> <maml:description> <maml:para>Enter a drive ID or list of drive IDs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] SolidFire.Element.Api.DriveInfo[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Removes any residual data from a drive using a Security Erase Unit command and resetting the encryption key on the drive.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>AsyncHandleResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_AsyncHandleResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Invoke-SFSecureEraseDrive -DriveID 19</dev:code> <dev:remarks> <maml:para>Begins the secure erase process on drive ID 19. Note: Drives must be removed (changed to an "available" status) before being secure erased.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$drives = Get-SFDrive Invoke-SFSecureEraseDrive -Drive $drives[3]</dev:code> <dev:remarks> <maml:para>Begins the secure erase process on a drive recieved from Get command. Note: Drives must be removed (changed to an "available" status) before being secure erased.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-SFShutdown</command:name> <maml:description> <maml:para>[Cluster] Shutdown one or more nodes in a cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>SFShutdown</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>You can use Shutdown to restart or shutdown the nodes in a cluster. You can shut down a single node, a specified number of nodes, or all of the nodes in the cluster using this method.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>You can use Shutdown to restart or shutdown the nodes in a cluster. You can shut down a single node, a specified number of nodes, or all of the nodes in the cluster using this method.</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="Named" aliases="None"> <maml:name>NodeID</maml:name> <maml:description> <maml:para>List of NodeIDs for the nodes to be shutdown.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Option</maml:name> <maml:description> <maml:para>Action to take for the node shutdown: restart or halt. Default is restart.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>You can use Shutdown to restart or shutdown the nodes in a cluster. You can shut down a single node, a specified number of nodes, or all of the nodes in the cluster using this method.</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can use Shutdown to restart or shutdown the nodes in a cluster. You can shut down a single node, a specified number of nodes, or all of the nodes in the cluster using this method.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>ShutdownResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ShutdownResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Invoke-SFShutdown -NodeID 1,2,3,4 </dev:code> <dev:remarks> <maml:para>Shuts down nodes 1 thorugh 4</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-SFAccount</command:name> <maml:description> <maml:para>[Cluster] Adds a new account to the system.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>SFAccount</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Adds a new account to the system.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="3" aliases="None"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>Attributes to set</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">hashtable</command:parameterValue> <dev:type> <maml:name>hashtable</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>InitiatorSecret</maml:name> <maml:description> <maml:para>CHAP secret to use for the initiator</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="2" aliases="None"> <maml:name>TargetSecret</maml:name> <maml:description> <maml:para>CHAP secret to use for the target</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Username</maml:name> <maml:description> <maml:para>Unique username for this account</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String System.Collections.Hashtable </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Adds a new account to the system.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>Account</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Account.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFAccount -Username User1</dev:code> <dev:remarks> <maml:para>The -Username parameter does not have to be specified in this scenario.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFAccount -Username User1 -InitiatorSecret 3ks03ks02l4@1k -TargetSecret 3ks03ks02l4@!l</dev:code> <dev:remarks> <maml:para>Creates a new tennant account "User1" with the specified CHAP secrets.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-SFClone</command:name> <maml:description> <maml:para>[Cluster] Creates a copy of the volume.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>SFClone</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Creates a copy of the volume.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByPropertyName)" position="4" aliases="None"> <maml:name>Access</maml:name> <maml:description> <maml:para>Access allowed for the new volume</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="6" aliases="None"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>List of Name/Value pairs as a hashtable</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">hashtable</command:parameterValue> <dev:type> <maml:name>hashtable</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the new cloned volume</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="2" aliases="None"> <maml:name>NewAccountID</maml:name> <maml:description> <maml:para>AccountID of the owner of the volume</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="3" aliases="None"> <maml:name>NewSize</maml:name> <maml:description> <maml:para>New size of the volume in Gigabytes</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="5" aliases="None"> <maml:name>SnapshotID</maml:name> <maml:description> <maml:para>ID of the snapshot that is used as the source of the clone</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>Volume ID for the volume to be cloned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 System.String System.Collections.Hashtable </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Creates a copy of the volume.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>CloneVolumeResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CloneVolumeResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFClone -VolumeID 29 -Name NewVolume</dev:code> <dev:remarks> <maml:para>Creates a clone of volume ID 29 and names the new volume "NewVolume".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFClone -VolumeID 29 -Name NewVolume -NewAccountID 3 -NewSize 100000000000 -Access readOnly</dev:code> <dev:remarks> <maml:para>Creates a clone of volume ID 29 and names the new volume "NewVolume". This command also associates the new volume with account ID 3, changes the size of the volume to 100 GB (100000000000 Bytes) and changes the access to readOnly.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFClone -VolumeID 29 -Name NewVolume -SnapshotID 27</dev:code> <dev:remarks> <maml:para>Creates a clone of snapshot ID 27 on volume ID 29 and names the new volume "NewVolume".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-SFCloneMultiple</command:name> <maml:description> <maml:para>[Cluster] Creates a clone of a group of specified volumes.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>SFCloneMultiple</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Creates a clone of a group of specified volumes.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="2" aliases="None"> <maml:name>Access</maml:name> <maml:description> <maml:para>New default access method for the new volumes if not overridden by information passed in the Volumes array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="3" aliases="None"> <maml:name>GroupSnapshotID</maml:name> <maml:description> <maml:para>ID of the group snapshot to use as a basis for the clone.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="4" aliases="None"> <maml:name>NewAccountID</maml:name> <maml:description> <maml:para>New account ID for the volumes if not overridden by information passed in the Volumes array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="0" aliases="None"> <maml:name>Volume</maml:name> <maml:description> <maml:para>Unique SFCloneVolume for each volume to include in the clone. If optional parameters are not specified, the values will be inherited from the source volumes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">CloneMultipleVolumeParams[]</command:parameterValue> <dev:type> <maml:name>CloneMultipleVolumeParams[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue)" position="0" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>Unique ID for each volume to include in the clone. Default values will be inherited from the source volumes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Creates a clone of a group of specified volumes.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>CloneMultipleVolumesResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CloneMultipleVolumesResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFCloneMultiple -VolumeID 23,25</dev:code> <dev:remarks> <maml:para>Clone the specified volumes. Volume details all remain the same including name, account, size, QoS and access.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolume -Name "*VM*" | New-SFCloneMultiple -NewAccountID 20</dev:code> <dev:remarks> <maml:para>Clone all of the volumes that include "VM" in the name and associate the new clones with Account ID 20.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFCloneMultiple -GroupSnapshotID 3</dev:code> <dev:remarks> <maml:para>Create a clone of each volume included in the identified group snapshot.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-SFCluster</command:name> <maml:description> <maml:para>[Cluster] Creates a new SolidFire cluster from a list of node SIPs that are configured with the same cluster name.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>SFCluster</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Creates a new SolidFire cluster from a list of nodes that are configured with the same cluster name.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>AcceptEula</maml:name> <maml:description> <maml:para>Include this switch parameter if you accept the EULA.</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="6" aliases="None"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>Dictionary of name/values</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">hashtable</command:parameterValue> <dev:type> <maml:name>hashtable</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Mvip</maml:name> <maml:description> <maml:para>Floating (virtual) IP address for the cluster on the management network</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="4" aliases="None"> <maml:name>Nodes</maml:name> <maml:description> <maml:para>IP addresses of the initial set of nodes making up the cluster. This node's IP must be on the list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="3" aliases="None"> <maml:name>Password</maml:name> <maml:description> <maml:para>Initial password for the cluster admin account</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="5" aliases="None"> <maml:name>ReplicaCount</maml:name> <maml:description> <maml:para>Number of replicas of each piece of data to store in the cluster</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>Svip</maml:name> <maml:description> <maml:para>Floating (virtual) IP address for the cluster on the storage (iSCSI) network</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="2" aliases="None"> <maml:name>Username</maml:name> <maml:description> <maml:para>User name for the cluster admin</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String System.String[] System.Int32 System.Collections.Hashtable </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Creates a new SolidFire cluster from a list of nodes that are configured with the same cluster name.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>CreateClusterResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CreateClusterResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFCluster -Mvip 10.10.1.1 -Svip 10.10.10.1 -Username admin -Password pass -Nodes "10.10.10.11","10.10.10.12","10.10.10.13","10.10.10.14"</dev:code> <dev:remarks> <maml:para>Creates a new SolidFire cluster with the specified nodes.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Connect-SFCluster 172.27.153.41 -Username "fake" -Password "fake" -Node New-SFCluster -Mvip 172.27.153.46 -Svip 172.27.151.46 -Username clusteradmin -Password clusterpass -Nodes (Get-SFBootstrapConfig).Nodes.Name</dev:code> <dev:remarks> <maml:para>Connects to one of the nodes to be included in the newly created cluster with fake credentials (credentials are only used after a cluster has been created). New-SFCluster is then called with the node IPs being pulled directly from Get-SFBootstrapConfig.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-SFClusterAdmin</command:name> <maml:description> <maml:para>[Cluster] Adds a new cluster admin.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>SFClusterAdmin</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Adds a new cluster admin.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>AcceptEula</maml:name> <maml:description> <maml:para>Include this switch parameter if you accept the EULA.</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue)" position="Named" aliases="None"> <maml:name>Access</maml:name> <maml:description> <maml:para>Controls which methods this Cluster Admin can use. For more details on the levels of access, see the Access Control appendix of the SolidFire API.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>List of Name/Value pairs in JSON object format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">hashtable</command:parameterValue> <dev:type> <maml:name>hashtable</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue)" position="Named" aliases="None"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password used to authenticate this Cluster Admin.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue)" position="Named" aliases="None"> <maml:name>Username</maml:name> <maml:description> <maml:para>Unique username for this Cluster Admin.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String System.String[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Adds a new cluster admin.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>ClusterAdmin</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterAdmin.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFClusterAdmin -Username AdminUser -Password NewPass -Access "nodes","drives"</dev:code> <dev:remarks> <maml:para>Adds a cluster admin user with full access to the "nodes" and "drives" groups of API methods. The most common access levels are: "administrator" - Full access to all API methods "reporting" - Access to only readonly API methods with some limitations</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-SFGroupSnapshot</command:name> <maml:description> <maml:para>[Cluster] Creates a point-in-time snapshot of a group of volumes.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>SFGroupSnapshot</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Creates a point-in-time snapshot of a group of volumes.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="4" aliases="None"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>Attributes to set</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">hashtable</command:parameterValue> <dev:type> <maml:name>hashtable</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="2" aliases="None"> <maml:name>EnableRemoteReplication</maml:name> <maml:description> <maml:para>Should the snapsnot be replicated to remote storage?</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="1" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name for the snapshot group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="3" aliases="None"> <maml:name>Retention</maml:name> <maml:description> <maml:para>The amount of time the snapshot should be retained. Enter in HHHHHHHH:mm:ss. Maximum retention time is 10000000:00:00</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>Unique ID of the volume image from which to copy</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Creates a point-in-time snapshot of a group of volumes.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GroupSnapshot</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GroupSnapshot.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFGroupSnapshot -VolumeID 12,13,14 -Name GroupSnap01</dev:code> <dev:remarks> <maml:para>Creates a group snapshot named "GroupSnap01" including the specified volumes.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolume -Name "*VMware*" | New-SFGroupSnapshot -Name VMwareSnap</dev:code> <dev:remarks> <maml:para>Creates a new group snapshot named "VMwareSnap" that includes all volumes on the cluster with "VMware" in the volume name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFGroupSnapshot -VolumeID 4,5 -Name testSnap -Retention 50:00:00 -EnableRemoteReplication:$true</dev:code> <dev:remarks> <maml:para>Creates a new GroupSnapshot named "testSnap" using volume ID 4 and 5. The snapshot is set to be retained for 50 hours and remote replication is enabled.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-SFInitiator</command:name> <maml:description> <maml:para>Creates multiple new initiator IQNs or World Wide Port Names (WWPNs) and optionally assigns them aliases and attributes.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>SFInitiator</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Creates multiple new initiator IQNs or World Wide Port Names (WWPNs) and optionally assigns them aliases and attributes.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Alias</maml:name> <maml:description> <maml:para>The friendly name to assign to this initiator.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>A set of Hashtable attributes assigned to this initiator.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">hashtable</command:parameterValue> <dev:type> <maml:name>hashtable</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the initiator (IQN or WWPN) to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>VolumeAccessGroupID</maml:name> <maml:description> <maml:para>The ID of the volume access group into to which this newly created initiator will be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Creates multiple new initiator IQNs or World Wide Port Names (WWPNs) and optionally assigns them aliases and attributes.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFInitiator -Name test</dev:code> <dev:remarks> <maml:para>Creates a new initiator with name "test".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFInitiator -Name test2 -Alias t2</dev:code> <dev:remarks> <maml:para>Creates a new initiator with name "test2" and alias "t2".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFInitiator -Name test -VolumeAccessGroupID 1</dev:code> <dev:remarks> <maml:para>Creates a new initiator with name "test" and adds it to VolumeAccessGroup ID 1.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-SFLdapClusterAdmin</command:name> <maml:description> <maml:para>[Cluster] Adds a new LDAP cluster admin.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>SFLdapClusterAdmin</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Adds a new LDAP cluster admin.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>AcceptEula</maml:name> <maml:description> <maml:para>Include this switch parameter if you accept the EULA.</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue)" position="Named" aliases="None"> <maml:name>Access</maml:name> <maml:description> <maml:para>Controls which methods this Cluster Admin can use. For more details on the levels of access, see the Access Control appendix in the SolidFire API Reference.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>List of Name/Value pairs in JSON object format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">hashtable</command:parameterValue> <dev:type> <maml:name>hashtable</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue)" position="Named" aliases="None"> <maml:name>Username</maml:name> <maml:description> <maml:para>The distinguished user name for the new LDAP cluster admin.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String System.String[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Adds a new LDAP cluster admin.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>ClusterAdmin</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterAdmin.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFLdapClusterAdmin -Username admin -Access administrator -AcceptEula:$true</dev:code> <dev:remarks> <maml:para>Creates a new SFLdapClusterAdmin with username "admin" and gives it full administrator access. Auto accepts the EULA.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-SFNodeSupportBundle</command:name> <maml:description> <maml:para>[Node] Creates a support bundle file under the node's directory.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>SFNodeSupportBundle</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Node] Creates a support bundle file under the node's directory.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>BundleName</maml:name> <maml:description> <maml:para>Unique name for each support bundle created. If no name is provided, then 'supportbundle' and the node name is used as a file name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>ExtraArgs</maml:name> <maml:description> <maml:para>This parameter is fed to the sf_make_support_bundle script. Should be used only at the request of SolidFire Support.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="2" aliases="None"> <maml:name>TimeoutSec</maml:name> <maml:description> <maml:para>This parameter overrides the Timeout parameter in the SFConnection object. It is fed to the sf_make_support_bundle script. Should be used only at the request of SolidFire Support.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String System.Int32 </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Node] Creates a support bundle file under the node's directory.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>CreateSupportBundleResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_CreateSupportBundleResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFNodeSupportBundle -BundleName "TestBundle" -TimeoutSec 180</dev:code> <dev:remarks> <maml:para>Creates a new support bundle named "TestBundle". It is recommended to use a value greater than 60 for "TimeoutSec". Using a value higher than the expected time to create a support bundle has no negative effects.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$bundle = New-SFNodeSupportBundle -BundleName "TestBundle" -TimeoutSec 180 $bundle.details.url will contain "https://[Target]:442/config/supportbundles/siteB.node1.tar" </dev:code> <dev:remarks> <maml:para>Retrieve the created Support Bundle via the returned URL.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-SFSchedule</command:name> <maml:description> <maml:para>[Cluster] Creates a schedule that will make a snapshot of a volume.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>SFSchedule</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Creates a schedule that will make a snapshot of a volume.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="11" aliases="None"> <maml:name>EnableRemoteReplication</maml:name> <maml:description> <maml:para>Include snapshots in replication when paired. Default is false.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="2" aliases="None"> <maml:name>Frequency</maml:name> <maml:description> <maml:para>Used to indicate the frequency at which the snapshot will be made.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="8" aliases="None"> <maml:name>Paused</maml:name> <maml:description> <maml:para>Use to pause the schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="10" aliases="None"> <maml:name>Recurring</maml:name> <maml:description> <maml:para>Indicates if the schedule will be recurring or not. Default is true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="12" aliases="None"> <maml:name>RetentionDays</maml:name> <maml:description> <maml:para>Number of days to retain snapshots created by this schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">uint64</command:parameterValue> <dev:type> <maml:name>uint64</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="13" aliases="None"> <maml:name>RetentionHours</maml:name> <maml:description> <maml:para>Number of hours to retain snapshots created by this schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">uint64</command:parameterValue> <dev:type> <maml:name>uint64</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="14" aliases="None"> <maml:name>RetentionMinutes</maml:name> <maml:description> <maml:para>Number of minutes to retain snapshots created by this schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">uint64</command:parameterValue> <dev:type> <maml:name>uint64</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="1" aliases="None"> <maml:name>ScheduleName</maml:name> <maml:description> <maml:para>Unique name for the schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="9" aliases="None"> <maml:name>SnapshotName</maml:name> <maml:description> <maml:para>Name of the new snapshot.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="15" aliases="None"> <maml:name>StartingDate</maml:name> <maml:description> <maml:para>Date/Time after which the schedule will be run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>Volume IDs to be included in the resulting snapshots.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Creates a schedule that will make a snapshot of a volume.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>Schedule</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Schedule.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFSchedule -VolumeID 8 -ScheduleName test -Frequency DaysOfWeek -DaysOfWeekDays Monday,Tuesday,Saturday</dev:code> <dev:remarks> <maml:para>Creates a new schedule named "test" on volume 8, and sets the frequency to DaysOfWeek and then sets the days to Monday, Tuesday, and Saturday. NOTE: parameter "DaysOfWeekDays" will only appear if "DaysOfWeek" has already been chosen.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code> New-SFSchedule -VolumeID 9 -ScheduleName test2 -Frequency DaysOfMonth -DaysOfMonthDays 1,10,20,30 -RetentionDays 5 -RetentionHours 15 -RetentionMinutes 5 -StartingDate 2017-06-05T12:22:40</dev:code> <dev:remarks> <maml:para>Creates a new schedule named "test2" on volume 9, and sets the frequency to DaysOfMonth and then sets the days to the 1st, 10th, 20th, and 30th days in the month. Also sets starting date. NOTE: parameter "DaysOfMonthDays" will only appear if "DaysOfMonth" has already been chosen. NOTE: you must use all three retention parameters (RetentionDays,RetentionHours,RetentionMinutes) to add a retention to the schedule or the command will error out.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFSchedule -VolumeID 10 -ScheduleName test3 -Frequency TimeInterval -TimeIntervalHours 5 -TimeIntervalMinutes 30 -SnapshotName snapTest</dev:code> <dev:remarks> <maml:para>Creates a new schedule named "test3" on volume 10, and sets the frequency to TimeInterval and then sets the time interval to five and a half hours. Also sets name of new Snapshot. NOTE: parameters "TimeIntervalDays","TimeIntervalHours", and "TimeIntervalMinutes" will only appear if "TimeInterval" has already been chosen.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-SFSnapshot</command:name> <maml:description> <maml:para>[Cluster] Creates a point-in-time snapshot of a volume.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>SFSnapshot</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Creates a point-in-time snapshot of a volume.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="5" aliases="None"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>Attributes to set</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">hashtable</command:parameterValue> <dev:type> <maml:name>hashtable</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="3" aliases="None"> <maml:name>EnableRemoteReplication</maml:name> <maml:description> <maml:para>Should the snapshot be replicated to remote storage?</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="2" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name 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></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="4" aliases="None"> <maml:name>Retention</maml:name> <maml:description> <maml:para>The amount of time the snapshot should be retained. Enter in HHHHHHHH:mm:ss. Maximum retention time is 10000000:00:00</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>SnapshotID</maml:name> <maml:description> <maml:para>Unique ID of a snapshot from which the new snapshot is made</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Volume</maml:name> <maml:description> <maml:para>Volume objects from which to copy</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">Volume</command:parameterValue> <dev:type> <maml:name>Volume</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>Unique ID of the volume image from which to copy</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 SolidFire.Element.Api.Volume System.Collections.Hashtable </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Creates a point-in-time snapshot of a volume.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>Snapshot</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Snapshot.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFSnapshot -VolumeID 29</dev:code> <dev:remarks> <maml:para>Creates a new snapshot of volume ID 29.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFSnapshot -VolumeID 29 -Name VolSnap</dev:code> <dev:remarks> <maml:para>Creates a new snapshot of volume ID 29 and names the snapshot "VolSnap".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFSnapshot -VolumeID 29 -Name VolSnap -SnapshotID 27</dev:code> <dev:remarks> <maml:para>Creates a new snapshot of volume ID 29 but uses snapshot ID 27 as the source instead of the active volume and names the snapshot "VolSnap".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolume -Name "VM*" | New-SFSnapshot -Name PowerShellSnap</dev:code> <dev:remarks> <maml:para>Creates a new snapshot named "PowerShellSnap" for all volumes on the cluster with names that begin with "VM".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFSnapshot -VolumeID 4 -Name testSnap -Retention 50:00:00 -EnableRemoteReplication:$true</dev:code> <dev:remarks> <maml:para>Creates a new snapshot named "testSnap" using volume ID 4. The snapshot is set to be retained for 50 hours and remote replication is enabled.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-SFStorageContainer</command:name> <maml:description> <maml:para>Creates a new storage container.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>SFStorageContainer</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Creates a new storage container.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>InitiatorSecret</maml:name> <maml:description> <maml:para>The secret for CHAP authentication for the initiator</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the storage container.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>TargetSecret</maml:name> <maml:description> <maml:para>The secret for CHAP authentication for the target</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Creates a new storage container.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFStorageContainer -name container</dev:code> <dev:remarks> <maml:para>Creates a new SFStorageContainer named "container" with auto generated InitiatorSecret and TargetSecret.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code> New-SFStorageContainer -Name container2 -InitiatorSecret abcd1234efgh567 -TargetSecret wxyz1234mnop567</dev:code> <dev:remarks> <maml:para>Creates a new SFStorageContainer with a specified name, InitiatorSecret, and TargetSecret.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-SFVirtualNetwork</command:name> <maml:description> <maml:para>[Cluster] Adds a new virtual network to a cluster configuration.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>SFVirtualNetwork</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Adds a new virtual network to a cluster configuration.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue)" position="2" aliases="None"> <maml:name>AddressBlocks</maml:name> <maml:description> <maml:para>Unique Range of IP addresses to include in the virtual network. List of AddressBlock objects with 'start' and 'size' for the starting IP address range and size of addresses in block.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">AddressBlock[]</command:parameterValue> <dev:type> <maml:name>AddressBlock[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="5" aliases="None"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>List of Name/Value pairs in JSON object format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">hashtable</command:parameterValue> <dev:type> <maml:name>hashtable</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue)" position="1" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>User defined name for the new virtual network.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue)" position="3" aliases="None"> <maml:name>Netmask</maml:name> <maml:description> <maml:para>Unique netmask for the virtual network being created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue)" position="4" aliases="None"> <maml:name>Svip</maml:name> <maml:description> <maml:para>Unique storage IP address for the virtual network being created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue)" position="0" aliases="None"> <maml:name>VirtualNetworkTag</maml:name> <maml:description> <maml:para>A unique virtual network (VLAN) tag. Supported values are 1 to 4095 (the number zero (0) is not supported).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 System.String SolidFire.Element.Api.AddressBlock[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Adds a new virtual network to a cluster configuration.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para>The new VirtualNetwork object.</maml:para> </maml:description> <dev:type> <maml:name>VirtualNetwork</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VirtualNetwork.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFVirtualNetwork -VirtualNetworkTag 2113 -Name VLAN2113 -AddressBlocks @(@{"start"="10.10.10.1";"size"=10}) -Netmask "255.255.255.0" -Svip "10.10.10.254"</dev:code> <dev:remarks> <maml:para>Add a new virtual network with a single block of IP addresses.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFVirtualNetwork -VirtualNetworkTag 2113 -Name VLAN2113 -AddressBlocks @(@{"start"="10.10.10.1";"size"=10};@{"start"="10.10.10.101";"size"=5}) -Netmask "255.255.255.0" -Svip "10.10.10.254" -Attributes @{"Description"="VLAN2113"}</dev:code> <dev:remarks> <maml:para>Add a new virtual network with two blocks of IP addresses and a description in the attributes.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$blocks = @() $block = @{} $block.Add("start", "123.45.45.0") $block.Add("size", 10) $blocks += $block New-SFVirtualNetwork -VirtualNetworkTag 10 -Name "VLAN10-Finance" -AddressBlocks $blocks -Netmask "255.255.255.0" -Svip "123.45.45.25"</dev:code> <dev:remarks> <maml:para>Add a new virtual network with a single block of IP addresses.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-SFVolume</command:name> <maml:description> <maml:para>[Cluster] Creates a new SolidFire volume.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>SFVolume</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Creates a new SolidFire volume.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName, FromRemainingArguments)" position="1" aliases="None"> <maml:name>Account</maml:name> <maml:description> <maml:para>Account Information for the owner of this volume</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">Account</command:parameterValue> <dev:type> <maml:name>Account</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName, FromRemainingArguments)" position="1" aliases="None"> <maml:name>AccountID</maml:name> <maml:description> <maml:para>Account ID for the owner of this volume</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="7" aliases="None"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>Attributes to set</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">hashtable</command:parameterValue> <dev:type> <maml:name>hashtable</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="10" aliases="None"> <maml:name>BurstIOPS</maml:name> <maml:description> <maml:para>The maximum 4KB IOPS allowed for a short time</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="3" aliases="None"> <maml:name>Enable512e</maml:name> <maml:description> <maml:para>The volume provides 512-byte sector emulation</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="5" aliases="None"> <maml:name>GB</maml:name> <maml:description> <maml:para>Switch used to interpret total size as GB</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="6" aliases="None"> <maml:name>GiB</maml:name> <maml:description> <maml:para>Switch used to interpret total size as GiB</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="9" aliases="None"> <maml:name>MaxIOPS</maml:name> <maml:description> <maml:para>The desired maximum 4KB IOPS to guarantee</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="8" aliases="None"> <maml:name>MinIOPS</maml:name> <maml:description> <maml:para>The desired minimum 4KB IOPS to guarantee</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the volume access group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="4" aliases="None"> <maml:name>TotalSize</maml:name> <maml:description> <maml:para>Total size of the volume in GB</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String System.Int64 SolidFire.Element.Api.Account System.Int32 </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Creates a new SolidFire volume.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>Volume</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Volume.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFVolume -Name NewVol01 -AccountID 3 -Enable512e:$true -TotalSize 100 -GB</dev:code> <dev:remarks> <maml:para>Creates a new volume with the name "NewVol01" associated with account ID 3. 512 Byte emulation will be enabled and the total size will be 100 GB. Note that the -GB and -GiB switch parameters are optional. If neither is supplied the -TotalSize parameter must be entered in Bytes. Since Min, Max and Burst IOPS have been omitted, this volume will receive the cluster defaults.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFVolume -Name NewVol01 -AccountID 3 -Enable512e:$true -TotalSize 100 -GB -MinIOPS 100 -MaxIOPS 500 -BurstIOPS 1000</dev:code> <dev:remarks> <maml:para>Creates a new volume with the name "NewVol01" associated with account ID 3. 512 Byte emulation will be enabled and the total size will be 100 GB. For this volume the QoS settings will be 100:500:1000, MinIOPS:MaxIOPS:BurstIOPS.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>For ($i = 1; $i -le 10; $i++) {New-SFVolume -Name NewVol$i -AccountID 3 -TotalSize 100 -GB -Enable512e:$true -MinIOPS 100 -MaxIOPS 500 -BurstIOPS 1000}</dev:code> <dev:remarks> <maml:para>Create 10x 100GB volumes named sequentially from NewVol1 to NewVol10 associated with account ID 3. Each volume will have QoS settings of 100:500:1000, MinIOPS:MaxIOPS:BurstIOPS and 512 Byte emulation will be enabled.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-SFVolumeAccessGroup</command:name> <maml:description> <maml:para>[Cluster] Creates a new volume access group.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>SFVolumeAccessGroup</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Creates a new volume access group.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="3" aliases="None"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>Hashtable of name/values</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">hashtable</command:parameterValue> <dev:type> <maml:name>hashtable</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>Initiators</maml:name> <maml:description> <maml:para>List of initiator names (IQNs and WWPNs) to include in the volume access group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the volume access group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="Named" aliases="None"> <maml:name>VirtualNetworkID</maml:name> <maml:description> <maml:para>The ID of the SolidFire Virtual Network ID to associate the volume access group with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="Named" aliases="None"> <maml:name>VirtualNetworkTag</maml:name> <maml:description> <maml:para>The ID of the VLAN Virtual Network Tag to associate the volume access group with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="2" aliases="None"> <maml:name>VolumeIDs</maml:name> <maml:description> <maml:para>List of VolumeIDs to include in the volume access group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String System.String[] System.Int64[] System.Collections.Hashtable </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Creates a new volume access group.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>VolumeAccessGroup</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroup.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFVolumeAccessGroup -Name VMwareHosts</dev:code> <dev:remarks> <maml:para>Creates a new volume access group with the name "VMwareHosts". Note that this volume access group contains no volumes or initiators at this point.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-SFVolumeAccessGroup -Name VMwareHosts -Initiators "iqn.1994-05.com.redhat:8afd1bec9877" -VolumeIDs 13,14,15</dev:code> <dev:remarks> <maml:para>Creates a new volume access group with the name "VMwareHosts", adds one inititator and three volumes.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SFAccount</command:name> <maml:description> <maml:para>[Cluster] Removes an existing account.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SFAccount</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Removes an existing account.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Account</maml:name> <maml:description> <maml:para>Enter an account ID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">Account[]</command:parameterValue> <dev:type> <maml:name>Account[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>AccountID</maml:name> <maml:description> <maml:para>Enter an account ID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] SolidFire.Element.Api.Account[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Removes an existing account.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para>Remove-SFAccount is used to remove an existing account. All Volumes must be deleted and purged on the account before it can be removed. If volumes on the account are still pending deletion, Remove-SFAccount cannot be used Remove-SFVolume to delete and purge the volumes.</maml:para> </maml:description> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFAccount -AccountID 4</dev:code> <dev:remarks> <maml:para>Removes account with AccountID 4.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFAccount -Account (Get-SFAccount Account1)</dev:code> <dev:remarks> <maml:para>Removes the account(s) provided in the account object.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SFClusterAdmin</command:name> <maml:description> <maml:para>[Cluster] Removes a cluster admin.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SFClusterAdmin</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Removes a cluster admin.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue)" position="0" aliases="None"> <maml:name>ClusterAdmin</maml:name> <maml:description> <maml:para>ClusterAdmin for the Cluster Admin to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">ClusterAdmin[]</command:parameterValue> <dev:type> <maml:name>ClusterAdmin[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>ClusterAdminID</maml:name> <maml:description> <maml:para>ClusterAdminID for the Cluster Admin to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Username</maml:name> <maml:description> <maml:para>Name the Cluster Admin to remove. Must be exact match. Case sensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] System.String[] SolidFire.Element.Api.ClusterAdmin[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Removes a cluster admin.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>ClusterAdmin[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterAdmin.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFClusterAdmin -ClusterAdminID 5</dev:code> <dev:remarks> <maml:para>Removes cluster admin with ID 5.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFClusterAdmin -Username "StorageAdmin"</dev:code> <dev:remarks> <maml:para>Removes a cluster admin user with the username of "StorageAdmin".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SFClusterFault</command:name> <maml:description> <maml:para>[Cluster] Removes faults on the cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SFClusterFault</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Removes faults on the cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName, FromRemainingArguments)" position="0" aliases="None"> <maml:name>FaultType</maml:name> <maml:description> <maml:para>Specify the fault type to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Removes faults on the cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>ClearClusterFaultsResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClearClusterFaultsResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFClusterFault</dev:code> <dev:remarks> <maml:para>Remove all cluster faults.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFClusterFault -FaultType current</dev:code> <dev:remarks> <maml:para>Remove any current active cluster faults.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFClusterFault -FaultType resolved</dev:code> <dev:remarks> <maml:para>Remove any past resolved cluster faults from the fault log.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SFClusterPair</command:name> <maml:description> <maml:para>[Cluster] Disconnects the open connections between two clusters created by cluster pairing.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SFClusterPair</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Disconnects the open connections between two clusters created by cluster pairing.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>ClusterPairID</maml:name> <maml:description> <maml:para>Unique identifier used to pair two clusters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Disconnects the open connections between two clusters created by cluster pairing.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>RemoveClusterPairResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_RemoveClusterPairResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFClusterPair -ClusterPairID 7 -Confirm:$false</dev:code> <dev:remarks> <maml:para>Removes specified ClusterPair without a confirmation prompt.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SFDeletedVolume</command:name> <maml:description> <maml:para>[Cluster] Immediately and permanently purges a volume that has been deleted.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SFDeletedVolume</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Immediately and permanently purges a volume that has been deleted.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="0" aliases="None"> <maml:name>AccountID</maml:name> <maml:description> <maml:para>A list of accountIDs. All of the volumes from all of the specified accounts are purged from the system. Note well: you cannot use this parameter unless all the volumes in a given account have been deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="0" aliases="None"> <maml:name>VolumeAccessGroupID</maml:name> <maml:description> <maml:para>A list of volumeAccessGroupIDs. All of the volumes from all of the specified Volume Access Groups are purged from the system. Note well: you cannot use this parameter unless all the volumes in the given VAG have been deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>Array of VolumeIDs to be purged.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Immediately and permanently purges a volume that has been deleted.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para>Remove-SFDeletedVolume immediately and permanently purges a volume which has been deleted. A volume must be deleted using Delete-SFVolume before it can be purged. Volumes are purged automatically after a period of time, so usage of this method is not typically required.</maml:para> </maml:description> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFDeletedVolume -VolumeID 5</dev:code> <dev:remarks> <maml:para>Purges volume ID 5.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFDeletedVolume -Name "VM*" | Remove-SFDeletedVolume</dev:code> <dev:remarks> <maml:para>Remove all deleted volumes with names beginning with "VM".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SFDrive</command:name> <maml:description> <maml:para>[Cluster] Removes drives that are part of the cluster and ensures data is migrated to other drives in the cluster prior to removal.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SFDrive</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Removes drives that are part of the cluster and ensures data is migrated to other drives in the cluster prior to removal.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Drive</maml:name> <maml:description> <maml:para>Please pass in a SFDrive or list of SFDrives</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">DriveInfo[]</command:parameterValue> <dev:type> <maml:name>DriveInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>DriveID</maml:name> <maml:description> <maml:para>Enter a drive ID or list of drive IDs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] SolidFire.Element.Api.DriveInfo[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Removes drives that are part of the cluster and ensures data is migrated to other drives in the cluster prior to removal.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>AsyncHandleResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_AsyncHandleResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFDrive -DriveID 19</dev:code> <dev:remarks> <maml:para>Removes drive ID 19.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$drives = Get-SFDrive Remove-SFDrive -Drive $drives[3]</dev:code> <dev:remarks> <maml:para>Gets all the drives and passes a selected drive for removal.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SFGroupSnapshot</command:name> <maml:description> <maml:para>[Cluster] Removes a group snapshot and optionally preserves the individual snapshots.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SFGroupSnapshot</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Removes a group snapshot and optionally preserves the individual snapshots.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>GroupSnapshotID</maml:name> <maml:description> <maml:para>Group snapshot ID(s) to remove</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>SaveMembers</maml:name> <maml:description> <maml:para>Save the individual snapshots for the specified group snapshot ID(s), Default False - Both the group and individual snapshots are removed.</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] System.Management.Automation.SwitchParameter </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Removes a group snapshot and optionally preserves the individual snapshots.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para>Removes a group snapshot. The saveMembers parameter can be used to preserve all the snapshots that were made for the volumes in the group, but the group association will be removed.</maml:para> </maml:description> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFGroupSnapshot -GroupSnapshotID 3 -SaveMembers</dev:code> <dev:remarks> <maml:para>Remove the group snapshot with ID 3 but retain the individual volume snapshots that it includes. Note: The default behavior is to remove both the group snapshot and the individual snapshots.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SFInitiator</command:name> <maml:description> <maml:para>Deletes one or more initiators from the system (and from any associated volumes or volume access groups).</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SFInitiator</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Deletes one or more initiators from the system (and from any associated volumes or volume access groups). </maml:para> <maml:para>If DeleteInitiators fails to delete one of the initiators provided in the parameter, the system returns an error and does not delete any initiators (no partial completion is possible).</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="Named" aliases="None"> <maml:name>Initiator</maml:name> <maml:description> <maml:para>An array of initiators to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">Initiator[]</command:parameterValue> <dev:type> <maml:name>Initiator[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="Named" aliases="None"> <maml:name>InitiatorID</maml:name> <maml:description> <maml:para>An array of IDs of initiators to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] SolidFire.Element.Api.Initiator[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Deletes one or more initiators from the system (and from any associated volumes or volume access groups). </maml:para> <maml:para>If DeleteInitiators fails to delete one of the initiators provided in the parameter, the system returns an error and does not delete any initiators (no partial completion is possible).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFInitiator -InitiatorID 1 -Confirm:$false</dev:code> <dev:remarks> <maml:para>Removes the initiatior ID 1 with no confirmation prompt.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFInitiator -InitiatorID 4 | Remove-SFInitiator -confirm:$false</dev:code> <dev:remarks> <maml:para>Gets specified initiator(s) and removes them with no confirmation prompt.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SFInitiatorFromVolumeAccessGroup</command:name> <maml:description> <maml:para>[Cluster] Removes initiators from a volume access group.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SFInitiatorFromVolumeAccessGroup</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Removes initiators from a volume access group.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>Initiators</maml:name> <maml:description> <maml:para>List of initiator names (IQNs and WWPNs) to remove from the volume access group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeAccessGroupID</maml:name> <maml:description> <maml:para>Enter a volume access group ID or list of volume access group IDs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 System.String[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Removes initiators from a volume access group.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>VolumeAccessGroup</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroup.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFInitiatorFromVolumeAccessGroup -VolumeAccessGroupID 3 -Initiators "iqn.1994-05.com.redhat:8afd1bec9877"</dev:code> <dev:remarks> <maml:para>Removes this single initiator from the volume access group.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SFNode</command:name> <maml:description> <maml:para>[Cluster] Removes one or more nodes from the cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SFNode</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Removes one or more nodes from the cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>NodeID</maml:name> <maml:description> <maml:para>List of NodeIDs for the nodes to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Removes one or more nodes from the cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para>Used to remove one or more nodes that should no longer participate in the cluster. Before removing a node, all drives it contains must first be removed with Remove-SFDrive CmdLet. A node cannot be removed until the RemoveDrives process has completed and all data has been migrated away from the node. Once removed, a node registers itself as a pending node and can be added again, or shut down which removes it from the Pending Node list.</maml:para> </maml:description> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFNode -NodeID 4 -Confirm:$false</dev:code> <dev:remarks> <maml:para>Removes node ID 4 with no confirmation prompt.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFNode -NodeID 4,5,6,7,8 -Confirm:$false</dev:code> <dev:remarks> <maml:para>Removes nodes with ID 4,5,6,7,8 with no confirmation prompt.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SFNodeSupportBundle</command:name> <maml:description> <maml:para>[Node] Deletes all support bundles generated with the New-SFNodeSupportBundle cmdlet.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SFNodeSupportBundle</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Node] Deletes all support bundles generated with the New-SFNodeSupportBundle cmdlet.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Node] Deletes all support bundles generated with the New-SFNodeSupportBundle cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para>Remove-SFNodeSupportBundle is used to delete all support bundles generated with the New-SFNodeSupportBundle CmdLet.</maml:para> </maml:description> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFNodeSupportBundle</dev:code> <dev:remarks> <maml:para>Removes all support bundles from a node.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SFSchedule</command:name> <maml:description> <maml:para>[Cluster] Deletes a schedule.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SFSchedule</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Deletes a schedule.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>ScheduleID</maml:name> <maml:description> <maml:para>Schedule ID(s) to remove</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Deletes a schedule.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>Schedule[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Schedule.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFSchedule -ScheduleID 1 -Confirm:$false</dev:code> <dev:remarks> <maml:para>Removes schedule with ID 1 with no confirmation prompt. TO be more specific, sets variable "ToBeDeleted" to True on specified shedule.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SFSnapshot</command:name> <maml:description> <maml:para>[Cluster] Deletes a snapshot.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SFSnapshot</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Deletes a snapshot.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>SnapshotID</maml:name> <maml:description> <maml:para>Snapshot ID(s) to remove</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Deletes a snapshot.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>Snapshot[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Snapshot.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFSnapshot -SnapshotID 37</dev:code> <dev:remarks> <maml:para>Removes the specified snapshot(s).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolume -Name "*VMware*" | Remove-SFSnapshot</dev:code> <dev:remarks> <maml:para>Removes all snapshots on any volumes that have "VMware" in the volume name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFSnapshot -SnapshotName "Saturday*" | Remove-SFSnapshot</dev:code> <dev:remarks> <maml:para>Removes all snapshots on the cluster that include "Saturday" in the snapshot name.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SFStorageContainer</command:name> <maml:description> <maml:para>Removes a storage container when you provide an ID.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SFStorageContainer</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Removes a storage container when you provide an ID.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="Named" aliases="None"> <maml:name>StorageContainerID</maml:name> <maml:description> <maml:para>list of storageContainerID of the storage containers to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">guid[]</command:parameterValue> <dev:type> <maml:name>guid[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Removes a storage container when you provide an ID.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFStorageContainer -StorageContainerID e8087af0-c85d-4018-b7db-9e5249cf34ff</dev:code> <dev:remarks> <maml:para>Removes storage container with specified ID with no confirmation prompt. In this case, StorageContainerID: "e8087af0-c85d-4018-b7db-9e5249cf34ff".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$containers = Get-SFStorageContainer Remove-SFStorageContainer -StorageContainerID $containers[4].StorageContainerID -Confirm:$false</dev:code> <dev:remarks> <maml:para>Removes 5th storage container with no confirmation prompt.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SFVirtualNetwork</command:name> <maml:description> <maml:para>[Cluster] Removes a configured virtual network for the cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SFVirtualNetwork</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Removes a configured virtual network for the cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VirtualNetworkID</maml:name> <maml:description> <maml:para>Enter a VirtualNetworkID to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="0" aliases="None"> <maml:name>VirtualNetworkTag</maml:name> <maml:description> <maml:para>Enter a VirtualNetworkTag to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Removes a configured virtual network for the cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para>After removing the VirtualNetwork, return the list of remaining VirtualNetworks.</maml:para> </maml:description> <dev:type> <maml:name>VirtualNetwork[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VirtualNetwork.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFVirtualNetwork -VirtualNetworkID 18</dev:code> <dev:remarks> <maml:para>Removes the virtual network identified by virtual network ID 18.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFVirtualNetwork -VirtualNetworkTag 1280</dev:code> <dev:remarks> <maml:para>Removes the virtual network associated with VLAN tag 1280.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SFVolume</command:name> <maml:description> <maml:para>[Cluster] Marks an active volume for deletion.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SFVolume</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Marks an active volume for deletion.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>Enter a volume ID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Marks an active volume for deletion.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para>Marks an active volume for deletion. It is purged (permanently deleted) after the cleanup interval elapses (generally 8 hours). After making a request to delete a volume, any active iSCSI connections to the volume is immediately terminated and no further connections are allowed while the volume is in this state. It is not returned in target discovery requests. Any snapshots of a volume that has been marked to delete are not affected. Snapshots are kept until the volume is purged from the system. If a volume is marked for deletion, and it has a bulk volume read or bulk volume write operation in progress, the bulk volume read or write process is stopped. If the volume you delete is paired with a volume, replication between the paired volumes is suspended and no data is transferred to it or from it while in a deleted state. The remote volume the deleted volume was paired with enters into a PausedMisconfigured state and data is no longer sent to it or from the deleted volume. Until the deleted volume is purged, it can be restored and data transfers resumes. If the deleted volume gets purged from the system, the volume it was paired with enters into a StoppedMisconfigured state and the volume pairing status is removed. The purged volume becomes permanently unavailable.</maml:para> </maml:description> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFVolume -VolumeID 12</dev:code> <dev:remarks> <maml:para>Removes volume ID 12.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolume -Name "VMware01" | Remove-SFVolume</dev:code> <dev:remarks> <maml:para>Remove all volumes named "VMware01".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SFVolumeAccessGroup</command:name> <maml:description> <maml:para>[Cluster] Removes a volume access group from the cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SFVolumeAccessGroup</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Removes a volume access group from the cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeAccessGroupID</maml:name> <maml:description> <maml:para>volume access group ID(s) to remove</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Removes a volume access group from the cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para>Removes a volume access group from the cluster. Volume access groups can be removed even if there are active volumes associated.</maml:para> </maml:description> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFVolumeAccessGroup -VolumeAccessGroupID 13</dev:code> <dev:remarks> <maml:para>Removes volume access group ID 13.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolumeAccessGroup -VolumeAccessGroupName "SQLCluster01" | Remove-SFVolumeAccessGroup</dev:code> <dev:remarks> <maml:para>Removes the volume access group named "SQLCluster01".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SFVolumeFromVolumeAccessGroup</command:name> <maml:description> <maml:para>[Cluster] Removes one or more volumes from a volume access group.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SFVolumeFromVolumeAccessGroup</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Removes one or more volumes from a volume access group.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeAccessGroupID</maml:name> <maml:description> <maml:para>Enter a volume access group ID or list of volume access group IDs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>List of volume IDs to remove from the volume access group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Removes one or more volumes from a volume access group.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>VolumeAccessGroup</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroup.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFVolumeFromVolumeAccessGroup -VolumeAccessGroupID 3 -VolumeID 12</dev:code> <dev:remarks> <maml:para>Removes volume ID 12 from volume access group ID 3. This does not delete the volume, it only removes access from the initiators in the volume access group.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-SFVolumePair</command:name> <maml:description> <maml:para>[Cluster] Removes the remote pairing between two volumes.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SFVolumePair</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Removes the remote pairing between two volumes.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>ID of the volume on which to stop the replication process.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Removes the remote pairing between two volumes.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>RemoveVolumePairResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_RemoveVolumePairResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFVolumePair -VolumeID 9 -Confirm:$false</dev:code> <dev:remarks> <maml:para>Removes pairing from volume ID 9 with no confirmation prompt.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Reset-SFDrive</command:name> <maml:description> <maml:para>[Cluster] Reset one or more drives to be reused in a node.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Reset</command:verb> <command:noun>SFDrive</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>ResetDrives allows you to proactively initialize drives and remove all data currently residing on a drive. The drive can then be reused in an existing node or used in an upgraded node. This method requires the force=true parameter to be included in the method call.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>ResetDrives allows you to proactively initialize drives and remove all data currently residing on a drive. The drive can then be reused in an existing node or used in an upgraded node. This method requires the force=true parameter to be included in the method call.</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Drive</maml:name> <maml:description> <maml:para>List of Drives (not driveIDs) to reset.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">DriveInfo[]</command:parameterValue> <dev:type> <maml:name>DriveInfo[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>DriveID</maml:name> <maml:description> <maml:para>List of DriveIDs to reset.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>ResetDrives allows you to proactively initialize drives and remove all data currently residing on a drive. The drive can then be reused in an existing node or used in an upgraded node. This method requires the force=true parameter to be included in the method call.</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] SolidFire.Element.Api.DriveInfo[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>ResetDrives allows you to proactively initialize drives and remove all data currently residing on a drive. The drive can then be reused in an existing node or used in an upgraded node. This method requires the force=true parameter to be included in the method call.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>ResetDriveDetails[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ResetDriveDetails.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Reset-SFDrive -DriveID 19</dev:code> <dev:remarks> <maml:para>Resets drive ID 19.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Reset-SFNode</command:name> <maml:description> <maml:para>[Node] Reset a node.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Reset</command:verb> <command:noun>SFNode</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>The ResetNode API method allows you to reset a node to the factory settings. All data, packages (software upgrades, etc), configurations, and log files are deleted from the node when you call this method. However, network settings for the node are preserved during this operation. Nodes that are participating in a cluster cannot be reset to the factory settings. The ResetNode API can only be used on nodes that are in an Available state. It cannot be used on nodes that are Active in a cluster, or in a Pending state.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="0" aliases="None"> <maml:name>Build</maml:name> <maml:description> <maml:para>Used to specify the URL to a remote Element software image to which the node will be reset.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>The ResetNode API method allows you to reset a node to the factory settings. All data, packages (software upgrades, etc), configurations, and log files are deleted from the node when you call this method. However, network settings for the node are preserved during this operation. Nodes that are participating in a cluster cannot be reset to the factory settings. The ResetNode API can only be used on nodes that are in an Available state. It cannot be used on nodes that are Active in a cluster, or in a Pending state.</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Options</maml:name> <maml:description> <maml:para>Used to enter specifications for running the reset operation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>The ResetNode API method allows you to reset a node to the factory settings. All data, packages (software upgrades, etc), configurations, and log files are deleted from the node when you call this method. However, network settings for the node are preserved during this operation. Nodes that are participating in a cluster cannot be reset to the factory settings. The ResetNode API can only be used on nodes that are in an Available state. It cannot be used on nodes that are Active in a cluster, or in a Pending state.</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The ResetNode API method allows you to reset a node to the factory settings. All data, packages (software upgrades, etc), configurations, and log files are deleted from the node when you call this method. However, network settings for the node are preserved during this operation. Nodes that are participating in a cluster cannot be reset to the factory settings. The ResetNode API can only be used on nodes that are in an Available state. It cannot be used on nodes that are Active in a cluster, or in a Pending state.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>ResetNodeDetails</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ResetNodeDetails.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Reset-SFNode</dev:code> <dev:remarks> <maml:para>Reset the node.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Restart-SFNetworking</command:name> <maml:description> <maml:para>[Node] Restart networking services on node.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Restart</command:verb> <command:noun>SFNetworking</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>The RestartNetworking API method is used to restart the networking services on a node.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>The RestartNetworking API method is used to restart the networking services on a node.</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>The RestartNetworking API method is used to restart the networking services on a node.</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The RestartNetworking API method is used to restart the networking services on a node.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Restart-SFNetworking</dev:code> <dev:remarks> <maml:para>Restart networking on the node.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Restart-SFServices</command:name> <maml:description> <maml:para>[Node] Restart services on node.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Restart</command:verb> <command:noun>SFServices</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>The RestartServices API method is used to restart the services on a node.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="0" aliases="None"> <maml:name>Action</maml:name> <maml:description> <maml:para>Action to perform on the service (start, stop, restart).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>The RestartServices API method is used to restart the services on a node.</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="0" aliases="None"> <maml:name>Service</maml:name> <maml:description> <maml:para>Service name to be restarted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>The RestartServices API method is used to restart the services on a node.</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The RestartServices API method is used to restart the services on a node.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SFAccount</command:name> <maml:description> <maml:para>[Cluster] Modifies an existing account.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFAccount</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Modifies an existing account.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>AccountID</maml:name> <maml:description> <maml:para>AccountID for the account to modify</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="5" aliases="None"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>Attributes to set</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">hashtable</command:parameterValue> <dev:type> <maml:name>hashtable</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByPropertyName)" position="2" aliases="None"> <maml:name>InitiatorSecret</maml:name> <maml:description> <maml:para>CHAP secret to use for the initiator</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="1" aliases="None"> <maml:name>Status</maml:name> <maml:description> <maml:para>Status to set the account to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByPropertyName)" position="3" aliases="None"> <maml:name>TargetSecret</maml:name> <maml:description> <maml:para>CHAP secret to use for the target</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="4" aliases="None"> <maml:name>Username</maml:name> <maml:description> <maml:para>Change username for this account</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 System.String System.Collections.Hashtable </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Modifies an existing account.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>Account</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Account.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFAccount -AccountID 2 -Status "locked"</dev:code> <dev:remarks> <maml:para>Locks the account with account ID 2.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFAccount -AccountID 2 -InitiatorSecret 3ks03ks02l4@1k -TargetSecret 3ks03ks02l4@!l</dev:code> <dev:remarks> <maml:para>Modifies the CHAP secrets for the account with ID 2.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SFClusterAdmin</command:name> <maml:description> <maml:para>[Cluster] Modifies properties on a cluster admin account (password and access).</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFClusterAdmin</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Modifies properties on a cluster admin account (password and access).</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue)" position="2" aliases="None"> <maml:name>Access</maml:name> <maml:description> <maml:para>Controls which methods this Cluster Admin can use. For more details on the levels of access, see the Access Control appendix of the SolidFire API.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="3" aliases="None"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>List of Name/Value pairs in JSON object format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">hashtable</command:parameterValue> <dev:type> <maml:name>hashtable</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue)" position="0" aliases="None"> <maml:name>ClusterAdminID</maml:name> <maml:description> <maml:para>ClusterAdminID for the Cluster Admin or LDAP Cluster Admin to modify.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue)" position="1" aliases="None"> <maml:name>Password</maml:name> <maml:description> <maml:para>Password used to authenticate this Cluster Admin.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 System.String System.String[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Modifies properties on a cluster admin account (password and access).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>ClusterAdmin</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterAdmin.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFClusterAdmin -ClusterAdminID 3 -Password "NewAdminPassword"</dev:code> <dev:remarks> <maml:para>Changes the password of the specified cluster admin. Note: Changing the password on the account currently being used to connect to the cluster will result in future cmdlets failing. You will need to change the admin password, disconnect from the cluster and reconnect with the update credentials.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SFClusterConfig</command:name> <maml:description> <maml:para>[Node] Sets the cluster configuration options for a node.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFClusterConfig</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Node] Sets the cluster configuration options for a node.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="Named" aliases="None"> <maml:name>Cluster</maml:name> <maml:description> <maml:para>Name of the cluster</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="Named" aliases="None"> <maml:name>Mipi</maml:name> <maml:description> <maml:para>The management interface of the node (Bond1G or Bond10G)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="Named" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>Hostname of the node</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Node] Sets the cluster configuration options for a node.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>ClusterConfig</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ClusterConfig.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFClusterConfig -Name "Node1" -Cluster "TestCluster</dev:code> <dev:remarks> <maml:para>Sets the node's hostname to "Node1" and adds it as a pending node for "TestCluster".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFClusterConfig -Mipi Bond1G</dev:code> <dev:remarks> <maml:para>Sets the node's management interface to "Bond1G".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SFClusterFullThreshold</command:name> <maml:description> <maml:para>[Cluster] Changes the level at which an event is generated when the storage cluster approaches the capacity utilization requested.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFClusterFullThreshold</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Changes the level at which an event is generated when the storage cluster approaches the capacity utilization requested.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="1" aliases="None"> <maml:name>MaxMetadataOverProvisionFactor</maml:name> <maml:description> <maml:para>A value representative of the number of times metadata space can be over provisioned relative to the amount of space available.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="0" aliases="None"> <maml:name>Stage2AwareThreshold</maml:name> <maml:description> <maml:para>Number of nodes worth of capacity remaining on the cluster that triggers a notification. For version Nitrogen (7.0) or lower.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="0" aliases="None"> <maml:name>Stage3BlockThresholdPercent</maml:name> <maml:description> <maml:para>The percent value set for stage3. At this percent full, a warning will be posted in the Alerts log. For version Oxygen (8.0) or higher.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Changes the level at which an event is generated when the storage cluster approaches the capacity utilization requested.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>ModifyClusterFullThresholdResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ModifyClusterFullThresholdResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFClusterFullThreshold -MaxMetadataOverProvisionFactor 100 -Stage3BlockThresholdPercent 50 -Confirm:$false</dev:code> <dev:remarks> <maml:para>Sets percentage threshold for Oxygen(8.0) or higher along with setting MaxMetadataOverProvisionFactor with no confirmation prompt.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFClusterFullThreshold -MaxMetadataOverProvisionFactor 100 -Stage2AwareThreshold 2 -Confirm:$false</dev:code> <dev:remarks> <maml:para>Sets node number threshold for Nitrogen (7.0) or lower along with setting MaxMetadataOverProvisionFactor with no confirmation prompt.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SFDefaultQoS</command:name> <maml:description> <maml:para>Sets the default Quality of Service (QoS) values (measured in inputs and outputs per second, or IOPS) for all volumes not yet created.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFDefaultQoS</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Sets the default Quality of Service (QoS) values (measured in inputs and outputs per second, or IOPS) for all volumes not yet created.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>BurstIOPS</maml:name> <maml:description> <maml:para>The maximum number of IOPS allowed in a short burst scenario.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>MaxIOPS</maml:name> <maml:description> <maml:para>The maximum number of sustained IOPS that are provided by the cluster to a volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>MinIOPS</maml:name> <maml:description> <maml:para>The minimum number of sustained IOPS that are provided by the cluster to a volume.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Sets the default Quality of Service (QoS) values (measured in inputs and outputs per second, or IOPS) for all volumes not yet created.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para>SetDefaultQoS enables you to configure the default Quality of Service (QoS) values (measured in inputs and outputs per second, or IOPS) for all volumes not yet created.</maml:para> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFDefaultQoS</dev:code> <dev:remarks> <maml:para>Outputs currently set QoS values.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFDefaultQoS -MinIOPS 100 -MaxIOPS 17500 -BurstIOPS 17500</dev:code> <dev:remarks> <maml:para>Sets default QoS values to specified values then outputs them.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SFGroupSnapshot</command:name> <maml:description> <maml:para>[Cluster] Modifies a point-in-time snapshot of a group of volumes.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFGroupSnapshot</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Modifies a point-in-time snapshot of a group of volumes.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="1" aliases="None"> <maml:name>EnableRemoteReplication</maml:name> <maml:description> <maml:para>Use to enable the snapshot created to be replicated to a remote SolidFire cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="2" aliases="None"> <maml:name>ExpirationTime</maml:name> <maml:description> <maml:para>Use to set the time when the snapshot should be removed. Must be an ISO-8601 date string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>GroupSnapshotID</maml:name> <maml:description> <maml:para>Unique ID(s) of the Group Snapshot.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Modifies a point-in-time snapshot of a group of volumes.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GroupSnapshot</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GroupSnapshot.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFGroupSnapshot -GroupSnapshotID 3 -EnableRemoteReplication:$false</dev:code> <dev:remarks> <maml:para>Disables Remote Replication on specified GroupSnapshot.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFGroupSnapshot -GroupSnapshotID 2,3 -EnableRemoteReplication:$true -ExpirationTime 2018-05-31T16:32:16</dev:code> <dev:remarks> <maml:para>Enables Remote Replication and sets ExpirationTime on both GroupSnapshots 2 and 3.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SFInitiator</command:name> <maml:description> <maml:para>Sets the attributes of an existing initiator.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFInitiator</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Sets the attributes of an existing initiator.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Alias</maml:name> <maml:description> <maml:para>The friendly name to assign to this initiator.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>A set of Hashtable attributes assigned to this initiator.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">hashtable</command:parameterValue> <dev:type> <maml:name>hashtable</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="Named" aliases="None"> <maml:name>InitiatorID</maml:name> <maml:description> <maml:para>The numeric ID of the initiator to modify.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>VolumeAccessGroupID</maml:name> <maml:description> <maml:para>The ID of the volume access group into to which this newly created initiator will be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Sets the attributes of an existing initiator.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFInitiator -InitiatorID 11 -Alias Initiator11 -Confirm:$false</dev:code> <dev:remarks> <maml:para>Sets the Initiator's Alias to the given value with no confirmation prompt. In this case, InitiatorID: '11', and Alias: 'Initiator11'. </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFInitiator -InitiatorID 7 -VolumeAccessGroupID 1 -Confirm:$false</dev:code> <dev:remarks> <maml:para>Adds initiator 11 to the given VolumeAccessGroup using ID with no confirmation prompt. In this case, InitiatorID: '7', and VolumeAccessGroupID: '1'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SFLdapAuthentication</command:name> <maml:description> <maml:para>[Cluster] Enables or disables LDAP configuration.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFLdapAuthentication</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Enables or disables LDAP configuration.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>AuthType</maml:name> <maml:description> <maml:para>Identifies which user authentication method will be used. Must be one of the following: DirectBind, SearchAndBind.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="0" aliases="None"> <maml:name>Disable</maml:name> <maml:description> <maml:para>Use this parameter to disable LDAP authentication and remove all LDAP configuration settings. All other parameters will be ignored.</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>GroupSearchBaseDN</maml:name> <maml:description> <maml:para>The base DN of the tree to start the group search.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="9" aliases="None"> <maml:name>GroupSearchCustomFilter</maml:name> <maml:description> <maml:para>For use with the CustomFilter search type, an LDAP filter to use to return the DNs of a user's groups. The string can have placeholder text of %USERNAME% and %USERDN% to be replaced with their username and full userDN as needed. REQUIRED for CustomFilter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="2" aliases="None"> <maml:name>GroupSearchType</maml:name> <maml:description> <maml:para>Controls the default group search filter used, must be one of the following: NoGroups, ActiveDirectory MemberDN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="5" aliases="None"> <maml:name>SearchBindDN</maml:name> <maml:description> <maml:para>A fully qualified DN to log in with to perform an LDAP search for the user. REQUIRED for SearchAndBind.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="6" aliases="None"> <maml:name>SearchBindPassword</maml:name> <maml:description> <maml:para>The password for the SearchBindDN account used for searching. REQUIRED for SearchAndBind.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="3" aliases="None"> <maml:name>ServerURIs</maml:name> <maml:description> <maml:para>An array of LDAP server URIs (examples: ldap://1.2.3.4 and ldaps://1.2.3.4:123)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="8" aliases="None"> <maml:name>UserDNTemplate</maml:name> <maml:description> <maml:para>A string that will be used to form a fully qualified user DN. The string should have the placeholder text '%USERNAME%' which will be replaced with the username of the authenticating user. REQUIRED for DirectBind.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="4" aliases="None"> <maml:name>UserSearchBaseDN</maml:name> <maml:description> <maml:para>The base DN of the tree to start the search. REQUIRED for SearchAndBind.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="7" aliases="None"> <maml:name>UserSearchFilter</maml:name> <maml:description> <maml:para>The LDAP filter to use. The string should have the placeholder text '%USERNAME%' which will be replaced with the username of the authenticating user. REQUIRED for SearchAndBind.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String System.String[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Enables or disables LDAP configuration.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>LdapConfiguration</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_LdapConfiguration.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFLdapAuthentication -Disable</dev:code> <dev:remarks> <maml:para>Disables the LDAP authentication and remove all LDAP configuration settings. All other parameters will be ignored. </maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SFLoginSessionInfo</command:name> <maml:description> <maml:para>[Cluster] Sets remote logging from the nodes in the storage cluster to a centralized log server or servers.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFLoginSessionInfo</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Sets remote logging from the nodes in the storage cluster to a centralized log server or servers.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="0" aliases="None"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Cluster authentication expiration period. Formatted in HH:mm:ss.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Sets remote logging from the nodes in the storage cluster to a centralized log server or servers.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>LoginSessionInfo</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_LoginSessionInfo.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFLoginSessionInfo -Timeout 00:35:00</dev:code> <dev:remarks> <maml:para>Sets the timeout period to specified amount.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SFLunAssignment</command:name> <maml:description> <maml:para>[Cluster] Defines custom LUN assignments for specific volumes.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFLunAssignment</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Defines custom LUN assignments for specific volumes.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>LunAssignment</maml:name> <maml:description> <maml:para>Enter a LunAssignment</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">LunAssignment[]</command:parameterValue> <dev:type> <maml:name>LunAssignment[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeAccessGroup</maml:name> <maml:description> <maml:para>Enter a volume access group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">VolumeAccessGroup</command:parameterValue> <dev:type> <maml:name>VolumeAccessGroup</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeAccessGroupID</maml:name> <maml:description> <maml:para>Enter a volume access group ID</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 SolidFire.Element.Api.VolumeAccessGroup SolidFire.Element.Api.LunAssignment[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Defines custom LUN assignments for specific volumes.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>VolumeAccessGroupLunAssignments</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroupLunAssignments.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$vol25 = @{"VolumeID" = 25; "Lun" = 12} Set-SFLunAssignment -VolumeAccessGroupID 5 -LunAssignment @( $vol25 )</dev:code> <dev:remarks> <maml:para>Changes the LUN ID associated with volume ID 25 in volume access group 5 to "12". This example builds the hash table associated with the LUN assignments and then uses that variable in the cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFLunAssignment -VolumeAccessGroupID 5 -LunAssignment @( @{"VolumeID" = 25; "Lun" = 12} )</dev:code> <dev:remarks> <maml:para>Changes the LUN ID associated with volume ID 25 in volume access group 5 to 12. This example builds the hash table directly within the LUN assignments array.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SFNetworkConfig</command:name> <maml:description> <maml:para>[Node] Sets the network configuration options for a node.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFNetworkConfig</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Node] Sets the network configuration options for a node.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="2" aliases="None"> <maml:name>Address</maml:name> <maml:description> <maml:para>The IP address to set on the interface. Changing the IP Address on a node can cause a loss of network connectivity. Be prepared to reconnect if this command times out.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>BondMode</maml:name> <maml:description> <maml:para>The bond mode to set for the interface</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="6" aliases="None"> <maml:name>DisconnectAfterRequest</maml:name> <maml:description> <maml:para>Include this switch parameter if you want to disconnect the connection immediately after the SetNetworkConfig request is made.</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="6" aliases="None"> <maml:name>DnsNameservers</maml:name> <maml:description> <maml:para>The DNS nameservers to set on the interface</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="7" aliases="None"> <maml:name>DnsSearch</maml:name> <maml:description> <maml:para>The DNS search domains</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="4" aliases="None"> <maml:name>Gateway</maml:name> <maml:description> <maml:para>The gateway address to set on the interface</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="5" aliases="None"> <maml:name>Mtu</maml:name> <maml:description> <maml:para>The MTU to set on the interface.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="3" aliases="None"> <maml:name>Netmask</maml:name> <maml:description> <maml:para>The Netmask to use for the interface</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Network</maml:name> <maml:description> <maml:para>The interface to set on. Must be one of 'Bond1G' | 'Bond10G'. Changing the BondMode on a node can cause a loss of network connectivity. Caution should be taken.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="8" aliases="None"> <maml:name>Status</maml:name> <maml:description> <maml:para>The interface status ('UpAndRunning' | 'Down' | 'Up')</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String System.Int64 System.String[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Node] Sets the network configuration options for a node.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>Network</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/v1.0/html/T_SolidFire_Element_Api_Network.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFNetworkConfig -Network Bond10G -Address 10.10.10.10 -Netmask 255.255.255.0 -Gateway 10.10.10.254</dev:code> <dev:remarks> <maml:para>Sets a static IP address for the Bond10G interface on the node including specifying an optional gateway.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFNetworkConfig -Network Bond1G -Address 10.10.1.10 -Netmask 255.255.255.0 -Gateway 10.10.1.254 -DnsNameservers 10.10.100.1,10.10.100.2 -DnsSearch test.solidfire.net</dev:code> <dev:remarks> <maml:para>Sets a static IP address for the Bond1G interface on the node. This also specifies DNS servers and the DNS search domain.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SFNtpInfo</command:name> <maml:description> <maml:para>[Cluster] Configures the NTP on cluster nodes.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFNtpInfo</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Configures the NTP on cluster nodes.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>BroadcastClient</maml:name> <maml:description> <maml:para>Enable every node in the cluster as a broadcast client. Default is false.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Servers</maml:name> <maml:description> <maml:para>List of NTP servers to add to each node's NTP configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[] System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Configures the NTP on cluster nodes.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GetNtpInfoResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetNtpInfoResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFNtpInfo -Servers "time.nist.gov","time.windows.com" -BroadcastClient:$false</dev:code> <dev:remarks> <maml:para>Configures two NTP servers and turns off the broadcast client feature of NTP on the cluster.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SFRemoteLoggingHost</command:name> <maml:description> <maml:para>[Cluster] Configures remote logging from the nodes in the storage cluster to a centralized log server or servers.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFRemoteLoggingHost</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Configures remote logging from the nodes in the storage cluster to a centralized log server or servers.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>RemoteHosts</maml:name> <maml:description> <maml:para>List of LoggingServer hosts to send log messages to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">LoggingServer[]</command:parameterValue> <dev:type> <maml:name>LoggingServer[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>SolidFire.Element.Api.LoggingServer[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Configures remote logging from the nodes in the storage cluster to a centralized log server or servers.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>LoggingServer[]</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_LoggingServer.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$rh = Get-SFRemoteLoggingHost Set-SFRemoteLoggingHost -RemoteHosts $rh -Confirm:$false</dev:code> <dev:remarks> <maml:para>Sets the RemoteLoggingHost with a LoggingServer with no confirmation prompt.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SFSchedule</command:name> <maml:description> <maml:para>[Cluster] Modifies a schedule which creates a snapshot of a volume.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFSchedule</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Modifies a schedule which creates a snapshot of a volume.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="9" aliases="None"> <maml:name>EnableRemoteReplication</maml:name> <maml:description> <maml:para>Include snapshots in replication when paired. Default is false.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="3" aliases="None"> <maml:name>Frequency</maml:name> <maml:description> <maml:para>Used to indicate the frequency at which the snapshot will be made.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="5" aliases="None"> <maml:name>Paused</maml:name> <maml:description> <maml:para>Use to pause the schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="8" aliases="None"> <maml:name>Recurring</maml:name> <maml:description> <maml:para>Indicates if the schedule will be recurring or not. Default is true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="10" aliases="None"> <maml:name>RetentionDays</maml:name> <maml:description> <maml:para>Number of days to retain snapshots created by this schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">uint64</command:parameterValue> <dev:type> <maml:name>uint64</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="11" aliases="None"> <maml:name>RetentionHours</maml:name> <maml:description> <maml:para>Number of hours to retain snapshots created by this schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">uint64</command:parameterValue> <dev:type> <maml:name>uint64</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="12" aliases="None"> <maml:name>RetentionMinutes</maml:name> <maml:description> <maml:para>Number of minutes to retain snapshots created by this schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">uint64</command:parameterValue> <dev:type> <maml:name>uint64</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="6" aliases="None"> <maml:name>RunNextInterval</maml:name> <maml:description> <maml:para>Choose to run this Schedule the next time the scheduler is active.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>ScheduleID</maml:name> <maml:description> <maml:para>Unique ID of the schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="2" aliases="None"> <maml:name>ScheduleName</maml:name> <maml:description> <maml:para>Unique name for the schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="7" aliases="None"> <maml:name>SnapshotName</maml:name> <maml:description> <maml:para>Name of the new snapshot.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="13" aliases="None"> <maml:name>StartingDate</maml:name> <maml:description> <maml:para>Date/Time after which the schedule will be run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="4" aliases="None"> <maml:name>ToBeDeleted</maml:name> <maml:description> <maml:para>Indicates if the schedule is marked for deletion.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="1" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>Volume IDs to be included in the resulting snapshots. VolumeID values will replace ScheduleInfo.Volume values if an existing Schedule is piped in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Modifies a schedule which creates a snapshot of a volume.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>Schedule</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Schedule.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFSchedule -ScheduleID 4 -ScheduleName newName -VolumeID 8</dev:code> <dev:remarks> <maml:para>Sets specified schedule's name to "newName" and changes which volume it targets.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFSchedule -ScheduleID 13 -Frequency DaysOfMonth -DaysOfMonthDays 1,15</dev:code> <dev:remarks> <maml:para>Sets schedule with ID 13 to run the 1st and 15tht of the month. NOTE: parameter "DaysOfMonthDays" will only appear if "DaysOfMonth" has already been chosen.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFSchedule -ScheduleID 14 -Frequency DaysOfWeek -DaysOfWeekDays Monday,Friday -RunNextInterval:$true -RetentionDays 120</dev:code> <dev:remarks> <maml:para>Sets schedule with ID 14 to run on Monday and Friday. Also sets it to run on the next interval anSd sets the retention to 120 days. NOTE: parameter "DaysOfWeekDays" will only appear if "DaysOfWeek" has already been chosen.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFSchedule -ScheduleID 15 -Frequency TimeInterval -TimeIntervalDays 1 -StartingDate 2017-06-05T12:22:40</dev:code> <dev:remarks> <maml:para>Sets schedule with ID 15 to a TimeInterval of 1 day and also sets the starting date. NOTE: parameters "TimeIntervalDays","TimeIntervalHours", and "TimeIntervalMinutes" will only appear if "TimeInterval" has already been chosen.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SFSnapshot</command:name> <maml:description> <maml:para>[Cluster] Modifies a point-in-time snapshot of a volume.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFSnapshot</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Modifies a point-in-time snapshot of a volume.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="1" aliases="None"> <maml:name>EnableRemoteReplication</maml:name> <maml:description> <maml:para>Use to enable the snapshot created to be replicated to a remote SolidFire cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="2" aliases="None"> <maml:name>ExpirationTime</maml:name> <maml:description> <maml:para>Use to set the time when the snapshot should be removed. Must be an ISO-8601 date string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>SnapshotID</maml:name> <maml:description> <maml:para>ID(s) of the snapshots to modify.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Modifies a point-in-time snapshot of a volume.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>Snapshot</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Snapshot.htm</maml:uri> </dev:type> </command:returnValue> <command:returnValue> <maml:description> <maml:para>Set-SFSnapshot is used to change the attributes currently assigned to a snapshot. Use this API method to enable the snapshots created on the Read/Write (source) volume to be remotely replicated to a target SolidFire storage system.</maml:para> </maml:description> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFSnapshot -SnapshotID 4 -EnableRemoteReplication $true</dev:code> <dev:remarks> <maml:para>EnableRemoteReplication on Snapshot with specified ID. In this case, SnapshotID: 4.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFSnapshot -SnapshotID 4 -ExpirationTime 2017-12-30T12:30:45</dev:code> <dev:remarks> <maml:para>Sets specified snapshot to be removed at given ISO-8601 time.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SFSnmpAcl</command:name> <maml:description> <maml:para>[Cluster] Configures SNMP access permissions on the cluster node.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFSnmpAcl</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Configures SNMP access permissions on the cluster node.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Networks</maml:name> <maml:description> <maml:para>List of networks and what type of access they have to the SNMP servers running on the cluster nodes. See SNMP Network Object for possible 'networks' values. SNMP v2 only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SnmpNetwork[]</command:parameterValue> <dev:type> <maml:name>SnmpNetwork[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="3" aliases="None"> <maml:name>UsmUsers</maml:name> <maml:description> <maml:para>If SNMP v3 is enabled, this value must be passed in place of the 'networks' parameter. SNMP v3 only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SnmpV3UsmUser[]</command:parameterValue> <dev:type> <maml:name>SnmpV3UsmUser[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>SolidFire.Element.Api.SnmpNetwork[] SolidFire.Element.Api.SnmpV3UsmUser[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Configures SNMP access permissions on the cluster node.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GetSnmpACLResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpACLResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$newAcl = Add-SFSnmpUsmUser -Access "rouser" -Name "testuser" -Password "testpass" -Passphrase "testphrase" -SecLevel "noauth" Set-SFSnmpAcl -UsmUser $newAcl</dev:code> <dev:remarks> <maml:para>Adds a new USM user to the SNMPv3 configuration on the cluster.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$newAcl = Add-SFSnmpNetwork -Access "ro" -Cidr 1 -Community "Community" -Network "network" Set-SFSnmpAcl -Networks $newAcl</dev:code> <dev:remarks> <maml:para>Adds a single new network to the SNMP configuration on the cluster.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SFSnmpInfo</command:name> <maml:description> <maml:para>[Cluster] Configures SNMP v2 and v3 on the cluster nodes.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFSnmpInfo</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Configures SNMP v2 and v3 on the cluster nodes.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>If set to 'true', then SNMP is enabled on each node in the cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>Networks</maml:name> <maml:description> <maml:para>List of networks and what type of access they have to the SNMP servers running on the cluster nodes. See SNMP Network Object for possible 'networks' values. SNMP v2 only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SnmpNetwork[]</command:parameterValue> <dev:type> <maml:name>SnmpNetwork[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="2" aliases="None"> <maml:name>SnmpV3Enabled</maml:name> <maml:description> <maml:para>If set to 'true', then SNMP v3 is enabled on each node in the cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="3" aliases="None"> <maml:name>UsmUsers</maml:name> <maml:description> <maml:para>If SNMP v3 is enabled, this value must be passed in place of the 'networks' parameter. SNMP v3 only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SnmpV3UsmUser[]</command:parameterValue> <dev:type> <maml:name>SnmpV3UsmUser[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>SolidFire.Element.Api.SnmpNetwork[] System.Boolean SolidFire.Element.Api.SnmpV3UsmUser[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Configures SNMP v2 and v3 on the cluster nodes.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>GetSnmpInfoResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpInfoResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$n = Get-SFSnmpInfo Set-SFSnmpInfo -Network $n.Networks -Enabled:$true -Confirm:$false</dev:code> <dev:remarks> <maml:para>Sets SNMP to enabled on all networks with no confirmation prompt.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$n = Get-SFSnmpInfo $user = Add-SFSnmpUsmUser -Name admin -Access rouser -Password password -Passphrase passphrase -SecLevel auth Set-SFSnmpInfo -Networks $n.Networks -Enabled:$true -SnmpV3Enabled:$true -UsmUsers $user.UsmUsers -Confirm:$false</dev:code> <dev:remarks> <maml:para>Creates a UsmUser. Sets SNMPv3 to enabled on all networks and passes the recently created UsmUser with no confirmation prompt.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SFSnmpTrapInfo</command:name> <maml:description> <maml:para>[Cluster] Enables and disables generation of SolidFire SNMP notifications (traps) and specifies the set of network host computers that receive notifications.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFSnmpTrapInfo</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Enables and disables generation of SolidFire SNMP notifications (traps) and specifies the set of network host computers that receive notifications.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="3" aliases="None"> <maml:name>ClusterEventTrapsEnabled</maml:name> <maml:description> <maml:para>If set to true, a corresponding solidFireClusterEventNotification is sent to the configured list of trap recipients when a cluster event is logged.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="2" aliases="None"> <maml:name>ClusterFaultResolvedTrapsEnabled</maml:name> <maml:description> <maml:para>If set to true, a corresponding solidFireClusterFaultResolvedNotification is sent to the configured list of trap recipients when a cluster fault is resolved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>ClusterFaultTrapsEnabled</maml:name> <maml:description> <maml:para>If set to true, a corresponding solidFireClusterFaultNotification is sent to the configured list of trap recipients when a cluster fault is logged.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>TrapRecipients</maml:name> <maml:description> <maml:para>List of hosts that are to receive the traps generated by the Cluster Master. At least one object is required if any one of the trap types is enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SnmpTrapRecipient[]</command:parameterValue> <dev:type> <maml:name>SnmpTrapRecipient[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>SolidFire.Element.Api.SnmpTrapRecipient[] System.Boolean </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Enables and disables generation of SolidFire SNMP notifications (traps) and specifies the set of network host computers that receive notifications.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SFSnmpTrapInfoResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_GetSnmpTrapInfoResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFSnmpTrapInfo -TrapRecipients "10.11.12.13","14.15.16.17" -ClusterFaultTrapsEnabled:$true -ClusterFaultResolvedTrapsEnabled:$true -ClusterEventTrapsEnabled:$false</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SFStorageContainer</command:name> <maml:description> <maml:para>Modifies an existing storage container.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFStorageContainer</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Modifies an existing storage container.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>InitiatorSecret</maml:name> <maml:description> <maml:para>The secret for CHAP authentication for the initiator</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="Named" aliases="None"> <maml:name>StorageContainerID</maml:name> <maml:description> <maml:para>The ID of the storage container you wish to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">guid</command:parameterValue> <dev:type> <maml:name>guid</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>TargetSecret</maml:name> <maml:description> <maml:para>The secret for CHAP authentication for the target</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Guid </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Modifies an existing storage container.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para>Modifies an existing storage container.</maml:para> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$containers = Get-SFStorageContainer Set-SFStorageContainer -StorageContainerID $containers[3].StorageContainerID -InitiatorSecret abc123def567 -TargetSecret xyz246wasd678</dev:code> <dev:remarks> <maml:para>Sets the InitiatorSecret and TargetSecret of the specified Storage Container.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SFVirtualNetwork</command:name> <maml:description> <maml:para>[Cluster] Modifies various attributes of a VirtualNetwork object.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFVirtualNetwork</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Modifies various attributes of a VirtualNetwork object.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue)" position="2" aliases="None"> <maml:name>AddressBlocks</maml:name> <maml:description> <maml:para>New addressBlock to set for this Virtual Network object. This may contain new address blocks to add to the existing object or it may omit unused address blocks that need to be removed. Alternatively, existing address blocks may be extended or reduced in size. The size of the starting addressBlocks for a Virtual Network object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">AddressBlock[]</command:parameterValue> <dev:type> <maml:name>AddressBlock[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="5" aliases="None"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>A new list of Name/Value pairs in JSON object format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">hashtable</command:parameterValue> <dev:type> <maml:name>hashtable</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue)" position="1" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>New name for the network.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue)" position="3" aliases="None"> <maml:name>Netmask</maml:name> <maml:description> <maml:para>New netmask for this virtual network.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue)" position="4" aliases="None"> <maml:name>Svip</maml:name> <maml:description> <maml:para>The storage virtual IP address for this virtual network. The svip for Virtual Network cannot be changed. A new Virtual Network must be created in order to use a different svip address.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue)" position="0" aliases="None"> <maml:name>VirtualNetworkID</maml:name> <maml:description> <maml:para>Unique identifier of the virtual network to modify.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue)" position="0" aliases="None"> <maml:name>VirtualNetworkTag</maml:name> <maml:description> <maml:para>A unique virtual network (VLAN) tag. Supported values are 1 to 4095 (the number zero (0) is not supported).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 System.String SolidFire.Element.Api.AddressBlock[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Modifies various attributes of a VirtualNetwork object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para>The modified VirtualNetwork object.</maml:para> </maml:description> <dev:type> <maml:name>VirtualNetwork</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VirtualNetwork.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFVirtualNetwork -VirtualNetworkID 5 -Name "NewName"</dev:code> <dev:remarks> <maml:para>Changes the name of an existing virtual network.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$origVN = Get-SFVirtualNetwork -VirtualNetworkID 5 $AddBlocks = $origVN.AddressBlocks $AddBlocks += @{"start"="10.10.10.201";"size"="5"} Set-SFVirtualNetwork -VirtualNetworkID $origVN.VirtualNetworkID -AddressBlocks $AddBlocks</dev:code> <dev:remarks> <maml:para>Adds an address block to an existing virtual network.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SFVolume</command:name> <maml:description> <maml:para>[Cluster] Modifies settings of an existing volume.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFVolume</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Modifies settings of an existing volume.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="2" aliases="None"> <maml:name>Access</maml:name> <maml:description> <maml:para>Access allowed 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></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="1" aliases="None"> <maml:name>AccountID</maml:name> <maml:description> <maml:para>Account ID to which the volume is reassigned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="3" aliases="None"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>Attributes to set</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">hashtable</command:parameterValue> <dev:type> <maml:name>hashtable</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="7" aliases="None"> <maml:name>BurstIOPS</maml:name> <maml:description> <maml:para>The maximum 4KB IOPS allowed for a short time</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="9" aliases="None"> <maml:name>GB</maml:name> <maml:description> <maml:para>Switch used to interpret total size as GB</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="10" aliases="None"> <maml:name>GiB</maml:name> <maml:description> <maml:para>Switch used to interpret total size as GiB</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="6" aliases="None"> <maml:name>MaxIOPS</maml:name> <maml:description> <maml:para>The desired maximum 4KB IOPS to guarantee</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="5" aliases="None"> <maml:name>MinIOPS</maml:name> <maml:description> <maml:para>The desired minimum 4KB IOPS to guarantee</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="0" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>VolumeName(s) for the volume(s) to be modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="4" aliases="None"> <maml:name>SetCreateTime</maml:name> <maml:description> <maml:para>Identify the time at which the volume was created</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="8" aliases="None"> <maml:name>TotalSize</maml:name> <maml:description> <maml:para>New size of the volume in GB. You can only increase a volumes size</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>VolumeID(s) for the volume(s) to be modified</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Modifies settings of an existing volume.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>Volume</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_Volume.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFVolume -VolumeID 29 -AccountID 12</dev:code> <dev:remarks> <maml:para>Move a volume from one account to another.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFVolume -VolumeID 13 -TotalSize 150 -GB</dev:code> <dev:remarks> <maml:para>Increase the size of a specified volume to 150 GB. Note that you can only increase a volume's size this way. To decrease a volume's size you must create a clone of the volume and decrease the size during the clone process.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFVolume -Name "VMware*" | Set-SFVolume -MinIOPS 1000 -MaxIOPS 2000 -BurstIOPS 5000</dev:code> <dev:remarks> <maml:para>Change the QoS settings for all volumes with names that begin with "VMware".</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SFVolumeAccessGroup</command:name> <maml:description> <maml:para>[Cluster] Configures the name or attributes of a VAG.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFVolumeAccessGroup</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Configures the name or attributes of a VAG.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="2" aliases="None"> <maml:name>Attributes</maml:name> <maml:description> <maml:para>Attributes to set</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">hashtable</command:parameterValue> <dev:type> <maml:name>hashtable</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Initiators</maml:name> <maml:description> <maml:para>List of initiators to include in the volume access group. If unspecified, the access group's configured initiators will not be modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="1" aliases="None"> <maml:name>Name</maml:name> <maml:description> <maml:para>The new name for this volume access group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>VirtualNetworkID</maml:name> <maml:description> <maml:para>The ID of the SolidFire Virtual Network ID to associate the volume access group with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>VirtualNetworkTags</maml:name> <maml:description> <maml:para>The ID of the VLAN Virtual Network Tag to associate the volume access group with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeAccessGroupID</maml:name> <maml:description> <maml:para>The ID of the volume access group to modify</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Volumes</maml:name> <maml:description> <maml:para>List of volumes to initially include in the volume access group. If unspecified, the access group's volumes will not be modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Configures the name or attributes of a VAG.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>VolumeAccessGroup</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_VolumeAccessGroup.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFVolumeAccessGroup -VolumeAccessGroupID 3 -Name NewVolumeAccessGroupName</dev:code> <dev:remarks> <maml:para>Changes the name of the specified volume access group.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$inits = Get-SFInitiator -Alias '' Set-SFVolumeAccessGroup -VolumeAccessGroupID 1 -Initiators $inits</dev:code> <dev:remarks> <maml:para>Adds all initators with no alias to VolumeAccessGroup 1.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-SFVolumePair</command:name> <maml:description> <maml:para>[Cluster] Pauses or restarts replication between a pair of volumes.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFVolumePair</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Pauses or restarts replication between a pair of volumes.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="2" aliases="None"> <maml:name>Mode</maml:name> <maml:description> <maml:para>Volume replication mode.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="1" aliases="None"> <maml:name>PausedManual</maml:name> <maml:description> <maml:para>Pause replication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">bool</command:parameterValue> <dev:type> <maml:name>bool</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>List of IDs of active paired volumes to be modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">long[]</command:parameterValue> <dev:type> <maml:name>long[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64[] System.String </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Pauses or restarts replication between a pair of volumes.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>ModifyVolumePairResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_ModifyVolumePairResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFVolumePair -VolumeID 8,9 -Mode Sync -PausedManual:$true -Confirm:$false</dev:code> <dev:remarks> <maml:para>Sets the Mode to 'Synx' and pauses data replication with no confirmation prompt.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-SFClusterPairing</command:name> <maml:description> <maml:para>[Cluster] Creates an encoded key from a cluster that is used to pair with another cluster.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Start</command:verb> <command:noun>SFClusterPairing</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Creates an encoded key from a cluster that is used to pair with another cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Creates an encoded key from a cluster that is used to pair with another cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>StartClusterPairingResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_StartClusterPairingResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$key = Start-SFClusterPairing Complete-SFClusterPairing -ClusterPairingKey $key.ClusterPairingKey</dev:code> <dev:remarks> <maml:para>Gets ClusterPairingKey object.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-SFVolumeBackup</command:name> <maml:description> <maml:para>[Cluster] Initializes a backup (also known as a bulk volume read) session on a specified volume.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Start</command:verb> <command:noun>SFVolumeBackup</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Initializes a backup (also known as a bulk volume read) session on a specified volume.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="2" aliases="None"> <maml:name>BackupTo</maml:name> <maml:description> <maml:para>The target on which to store the backup of volume data. Can be: SolidFire, Swift, or S3.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>Format</maml:name> <maml:description> <maml:para>The format of the volume data. Can be: uncompressed or native.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="2" aliases="None"> <maml:name>SnapshotID</maml:name> <maml:description> <maml:para>The ID of a previously created snapshot used for bulk volume reads.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>The ID of the volume to be read.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 System.String </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Initializes a backup (also known as a bulk volume read) session on a specified volume.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>StartBulkVolumeReadResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_StartBulkVolumeReadResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Start-SFVolumeBackup -VolumeID 5 -SnapshotID 4 -Format native -BackupTo SolidFire -Mvip 10.117.61.129 -Username admin -Password admin -BulkVolumeWriteKey abc</dev:code> <dev:remarks> <maml:para>Backs up specified volume in native format, along with using a snapshot, to SolidFire. Requires Mvip, login information, and BulkVolumeWriteKey.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Start-SFVolumeBackup -VolumeID 7 -Format uncompressed -BackupTo S3 -Hostname 10.117.61.125 -AccessKeyID abc -SecretAccessKey 123 -Bucket 5</dev:code> <dev:remarks> <maml:para>Backs up specified volume uncompressed to S3. Requires Hostname, AccessKeyID, SecretAccessKey, and Bucket number.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Start-SFVolumeBackup -VolumeID 7 -Format uncompressed -BackupTo Swift -Url 10.117.63.128:8443 -Username admin -AuthenticationKey abc -Container 5</dev:code> <dev:remarks> <maml:para>Backs up specified volume uncompressed to Swift. Requires URL, Username, AuthenticationKey, and Container.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-SFVolumePairing</command:name> <maml:description> <maml:para>[Cluster] Creates an encoded key from a volume that is used to pair with another volume.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Start</command:verb> <command:noun>SFVolumePairing</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Creates an encoded key from a volume that is used to pair with another volume.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>Mode</maml:name> <maml:description> <maml:para>The mode of the volume on which to start the pairing process.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>The ID of the volume on which to start the pairing process.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 System.String </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Creates an encoded key from a volume that is used to pair with another volume.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>StartVolumePairingResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help//html/T_SolidFire_Element_Api_StartVolumePairingResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$vol = Start-SFVolumePairing -VolumeID 8 -Mode Async Complete-SFVolumePairing -VolumeID 9 -VolumePairingKey $vol.VolumePairingKey</dev:code> <dev:remarks> <maml:para>Saved the pairing key from the Start command, while setting Mode to "Async", and uses it to complete pairing with another volume.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-SFVolumeRestore</command:name> <maml:description> <maml:para>[Cluster] Initializes a restore (also known as a bulk volume write) session on a specified volume.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Start</command:verb> <command:noun>SFVolumeRestore</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Initializes a restore (also known as a bulk volume write) session on a specified volume.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="None"> <maml:name>Format</maml:name> <maml:description> <maml:para>The format of the volume data. Can be: uncompressed or native.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="false" position="2" aliases="None"> <maml:name>RestoreFrom</maml:name> <maml:description> <maml:para>The source of object data that was created from a previous backup. Can be: SolidFire, Swift, or S3.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="None"> <maml:name>VolumeID</maml:name> <maml:description> <maml:para>The ID of the volume to be read.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 System.String </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Initializes a restore (also known as a bulk volume write) session on a specified volume.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>StartBulkVolumeWriteResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_StartBulkVolumeWriteResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Start-SFVolumeRestore -VolumeID 7 -Format native -RestoreFrom SolidFire -Confirm:$false</dev:code> <dev:remarks> <maml:para>Starts a volume restore on specified volume with native format. Uses "SolidFire" as RestoreFrom location and has no confirmation prompt.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Start-SFVolumeRestore -VolumeID 9 -Format uncompressed -RestoreFrom Swift -Confirm:$false</dev:code> <dev:remarks> <maml:para>Starts a volume restore on specified volume with "uncompressed" format. Uses "Swift" as RestoreFrom location and has no confirmation prompt.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Stop-SFClone</command:name> <maml:description> <maml:para>Cancels a currently running clone operation. This method does not return anything.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>SFClone</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Cancels a currently running clone operation. This method does not return anything.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="Named" aliases="None"> <maml:name>CloneID</maml:name> <maml:description> <maml:para>The id of the clone you wish to stop. This should have been returned when you first made the object</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Cancels a currently running clone operation. This method does not return anything.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para>Cancels a currently running clone operation. This method does not return anything.</maml:para> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Stop-SFClone -CloneID 5</dev:code> <dev:remarks> <maml:para>Stops specified clone by given CloneID.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Stop-SFGroupClone</command:name> <maml:description> <maml:para>Stops an ongoing CloneMultipleVolumes process for a group of clones.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>SFGroupClone</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Stops an ongoing CloneMultipleVolumes process for a group of clones.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="Named" aliases="None"> <maml:name>GroupCloneID</maml:name> <maml:description> <maml:para>group clone ID for the ongoing clone process.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64 </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Stops an ongoing CloneMultipleVolumes process for a group of clones.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para>CancelGroupClone enables you to stop an ongoing CloneMultipleVolumes process for a group of clones. When you cancel a group clone operation, the system completes and removes the operation's associated asyncHandle. This method does not return anything.</maml:para> </maml:description> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Stop-SFGroupClone -GroupCloneID 5</dev:code> <dev:remarks> <maml:para>Stops specified GroupClone by given GroupCloneID.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Test-SFConnectEnsemble</command:name> <maml:description> <maml:para>[Node] Verifies connectivity with a specified database ensemble.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Test</command:verb> <command:noun>SFConnectEnsemble</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Node] Verifies connectivity with a specified database ensemble.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Ensemble</maml:name> <maml:description> <maml:para>An array of ensemble node CIPs for connectivity testing</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Node] Verifies connectivity with a specified database ensemble.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>TestConnectEnsembleResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_TestConnectEnsembleResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Test-SFConnectEnsemble</dev:code> <dev:remarks> <maml:para>Tests connectivity with current cluster's ensemble.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Test-SFConnectEnsemble -Ensemble 10.117.61.125</dev:code> <dev:remarks> <maml:para>Tests connectivity with specified ensemble.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Test-SFConnectMvip</command:name> <maml:description> <maml:para>[Node] Tests the management connection to the cluster. The test pings the MVIP and executes a simple API method to verify connectivity.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Test</command:verb> <command:noun>SFConnectMvip</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Node] Tests the management connection to the cluster. The test pings the MVIP and executes a simple API method to verify connectivity.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Mvip</maml:name> <maml:description> <maml:para>Use this to test the management connection of a different MVIP. This is not needed to test the connection to the target cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Node] Tests the management connection to the cluster. The test pings the MVIP and executes a simple API method to verify connectivity.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>TestConnectMvipResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_TestConnectMvipResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Test-SFConnectMvip</dev:code> <dev:remarks> <maml:para>Verifies the MVIP connectivity of current cluster.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Test-SFConnectMvip -Mvip 10.117.61.125</dev:code> <dev:remarks> <maml:para>Verifies the connectectivity of specified MVIP.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Test-SFConnectSvip</command:name> <maml:description> <maml:para>[Node] Tests the storage connection to the cluster. The test pings the SVIP and executes a simple API method to verify connectivity.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Test</command:verb> <command:noun>SFConnectSvip</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Node] Tests the storage connection to the cluster. The test pings the SVIP and executes a simple API method to verify connectivity.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Svip</maml:name> <maml:description> <maml:para>Use this to test the storage connection of a different SVIP. This is not needed to test the connection to the target cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Node] Tests the storage connection to the cluster. The test pings the SVIP and executes a simple API method to verify connectivity.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>TestConnectSvipResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_TestConnectSvipResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Test-SFConnectSvip</dev:code> <dev:remarks> <maml:para>Verifies the SVIP connectivity of current cluster.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Test-SFConnectSvip -Mvip 10.117.61.125</dev:code> <dev:remarks> <maml:para>Verifies the connectectivity of specified SVIP.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Test-SFDrives</command:name> <maml:description> <maml:para>[Node] Run a hardware validation on all drives on the node.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Test</command:verb> <command:noun>SFDrives</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>You can use the TestDrives API method to run a hardware validation on all drives on the node. This method detects hardware failures on the drives (if present) and reports them in the results of the validation tests. You can only use the TestDrives method on nodes that are not Active in a cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>You can use the TestDrives API method to run a hardware validation on all drives on the node. This method detects hardware failures on the drives (if present) and reports them in the results of the validation tests. You can only use the TestDrives method on nodes that are not Active in a cluster.</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Minutes</maml:name> <maml:description> <maml:para>Specifies the number of minutes to run the test.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>You can use the TestDrives API method to run a hardware validation on all drives on the node. This method detects hardware failures on the drives (if present) and reports them in the results of the validation tests. You can only use the TestDrives method on nodes that are not Active in a cluster.</maml:para> </maml:description> <dev:type> <maml:name>switch</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can use the TestDrives API method to run a hardware validation on all drives on the node. This method detects hardware failures on the drives (if present) and reports them in the results of the validation tests. You can only use the TestDrives method on nodes that are not Active in a cluster.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>TestDrivesResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_TestDrivesResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Test-SFDrives -Minutes 20</dev:code> <dev:remarks> <maml:para>Test the drives on the node for up to 20 minutes.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Test-SFLdapAuthentication</command:name> <maml:description> <maml:para>[Cluster] Verifies LDAP authentication configuration.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Test</command:verb> <command:noun>SFLdapAuthentication</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Verifies LDAP authentication configuration.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="2" aliases="None"> <maml:name>LdapConfiguration</maml:name> <maml:description> <maml:para>An LdapConfiguration object to be tested. Optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">LdapConfiguration</command:parameterValue> <dev:type> <maml:name>LdapConfiguration</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue)" position="1" aliases="None"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password for the username to be tested.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="" globbing="" pipelineInput="true (ByValue)" position="0" aliases="None"> <maml:name>Username</maml:name> <maml:description> <maml:para>The distinguished user name for the new LDAP cluster admin.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Verifies LDAP authentication configuration.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>TestLdapConfigurationResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_TestLdapAuthenticationResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Test-SFLdapAuthentication -Username admin -Password admin</dev:code> <dev:remarks> <maml:para>Tests the LDAP Authentication with login credentials.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$data = Get-SFLdapConfiguration Test-SFLdapAuthentication -Username admin -Password admin -LdapConfiguration $data</dev:code> <dev:remarks> <maml:para>Gets the SFLdapConfiguration and uses it to test the LdapConfiguration with given login credentials.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Test-SFPing</command:name> <maml:description> <maml:para>[Node] Validates the connection to all nodes in the cluster on both 1G and 10G interfaces using ICMP packets.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Test</command:verb> <command:noun>SFPing</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Node] Validates the connection to all nodes in the cluster on both 1G and 10G interfaces using ICMP packets.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Attempts</maml:name> <maml:description> <maml:para>Specifies the number of times the system should repeat the test ping. Default is 5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Hosts</maml:name> <maml:description> <maml:para>Specify address or hostnames of devices to ping.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>PacketSize</maml:name> <maml:description> <maml:para>Specify the number of bytes to send in the ICMP packet sent to each IP. Number be less than the maximum MTU specified in the network configuration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>PingTimeoutMsec</maml:name> <maml:description> <maml:para>Specify the number of milliseconds to wait for each individual ping response. Default is 500ms.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>TotalTimeoutSec</maml:name> <maml:description> <maml:para>Specifies the length of time the ping should wait for a system response before issuing the next ping attempt or ending the process.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="False">long</command:parameterValue> <dev:type> <maml:name>long</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Node] Validates the connection to all nodes in the cluster on both 1G and 10G interfaces using ICMP packets.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>TestPingResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_TestPingResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Test-SFPing</dev:code> <dev:remarks> <maml:para>Default output.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Test-SFPing -Attempts 1 -Hosts 10.117.61.129, 10.117.61.125</dev:code> <dev:remarks> <maml:para>Validates specified nodes with only 1 allowed attempt.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Test-SFPing -PacketSize 100 -TotalTimeoutSec 5 -PingTimeoutMsec 100</dev:code> <dev:remarks> <maml:para>Validates all nodes with specified PacketSize, total timeout, and ping timeout.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Test-SFSendSnmpTrap</command:name> <maml:description> <maml:para>[Cluster] Sends SNMP test signal to active trap targets.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Test</command:verb> <command:noun>SFSendSnmpTrap</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>[Cluster] Sends SNMP test signal to active trap targets.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>SFConnection</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">SFConnection[]</command:parameterValue> <dev:type> <maml:name>SFConnection[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="" globbing="" pipelineInput="false" position="Named" aliases="None"> <maml:name>Target</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="True">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri></maml:uri> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>[Cluster] Sends SNMP test signal to active trap targets.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SnmpSendTestTrapsResult</maml:name> <maml:uri>http://solidfire.github.io/sdk-dotnet/help/html/T_SolidFire_Element_Api_SnmpSendTestTrapsResult.htm</maml:uri> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Test-SFSendSnmpTrap</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> </helpItems> |