Set-HpcIScsiStorageArray

Set-HpcIScsiStorageArray

Sets the name, description, or IP address of the specified Internet SCSI (iSCSI) storage array for an HPC cluster.

Syntax

Parameter Set: Default
Set-HpcIScsiStorageArray -HpcIScsiStorageArray <HpcIScsiStorageArray> [-Description <String> ] [-IpAddress <String> ] [-Name <String> ] [-Scheduler <String> ] [ <CommonParameters>]

Detailed Description

Sets the name, description, or IP address of the specified iSCSI storage array for an HPC cluster.

Parameters

-Description<String>

Specifies a new description for the iSCSI storage array.

Aliases

none

Required?

false

Position?

named

Default Value

the current description for the iSCSI storage array

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-HpcIScsiStorageArray<HpcIScsiStorageArray>

Specifies the iSCSI storage array in the HPC cluster for which you want to set the name or description. Use the Get-HpcIScsiStorageArray cmdlet to get an HpcIScsiStorageArray for an iSCSI storage array in an HPC cluster.

Aliases

none

Required?

true

Position?

named

Default Value

no default

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Name<String>

Specifies a new name for the iSCSI storage array. The maximum length of the name is 400 characters.

Aliases

none

Required?

false

Position?

named

Default Value

the current name for the iSCSI storage array

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Scheduler<String>

Specifies the host name or the IP address of the head node for the HPC cluster that contains the storage array for which you want to set the name or description. The value must be a valid computer name or IP address. If you do not specify the Scheduler parameter, this cmdlet uses the scheduler on the head node that the CCP_SCHEDULER environment variable specifies. To set this environment variable, run the following cmdlet:

Set-Content Env:CCP_SCHEDULER <head_node_name>

Aliases

none

Required?

false

Position?

named

Default Value

%CCP_SCHEDULER%

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IpAddress<String>

Specifies a new IP address for the iSCSI storage array.

Aliases

none

Required?

false

Position?

named

Default Value

the current IP address

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • An HpcIScsiStorageArray object

Outputs

The output type is the type of the objects that the cmdlet emits.

  • None

Notes

  • Although the HpcIScsiStorageArray parameter accepts pipeline input, this cmdlet can only successfully set the name or IP address for the first HpcIScsiStorageArray object that is received through the pipeline, because multiple storage arrays cannot have the same name or IP address. So, if you redirect the output of a Get-HpcIScsiStorageArray cmdlet that gets multiple HpcIScsiStorageArray objects to the Set-HpcIScsiStorageArray cmdlet, you should not specify the Name or IpAddress parameters for the Set-HpcIScsiStorageArray cmdlet.

  • You must be a cluster administrator to run this cmdlet successfully.

  • This parameter was introduced in HPC Pack 2008 R2. It is not supported in previous versions.

Examples

EXAMPLE 1

Gets an HpcIScsiStorageArray object for the iSCSI storage array that has a management IP address of 10.0.0.10, and then redirects this object as input to the Set-HpcIScsiStorageArray cmdlet to set the description for the storage array to First Storage Array.

PS C:\>Get-HpcIScsiStorageArray –IpAddresses 10.0.0.10 | Set-HpcIScsiStorageArray –Description "First Storage Array"

EXAMPLE 2

Gets an HpcIScsiStorageArray object for the iSCSI storage array that has a management IP address of 10.0.0.11, and then saves the object in a variable. The example uses this variable to specify the iSCSI storage array in the Set-HpcIScsiStorageArray cmdlet and to set the name and description for the iSCSI storage array.

PS C:\>$sa = Get-HpcIScsiStorageArray –IpAddresses 10.0.0.11Set-HpcIScsiStorageArray –HpcIScsiStorageArray $sa –Name "Storage Array 2" –Description "Second Storage Array"

Add-HpcIScsiStorageArray

Get-HpcIScsiStorageArray