Set-HpcIScsiStorageArray

Set-HpcIScsiStorageArray

Sets an iSCSI storage array for an HPC cluster.

Syntax

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




Detailed Description

The Set-HpcIScsiStorageArray cmdlet sets the name, description, or IP address of the specified Internet SCSI (iSCSI) storage array for an HPC cluster.

Parameters

-ClusterConnectionString<String[]>

Specifies an array of cluster connection strings for the cluster to which you want to add the device drivers. The value format is host1,host2,host3. If you do not specify the ClusterConnectionString parameter, this cmdlet uses the connection string on the head node that the CCP_CONNECTIONSTRING environment variable specifies. To set this environment variable, run the following cmdlet: Set-Content Env: CCP_CONNECTIONSTRING <head_node_name>.

This parameter was introduced in HPC Pack 2016.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Description<String>

Specifies a new description for the iSCSI storage array.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-HpcIScsiStorageArray<HpcIScsiStorageArray>

Specifies the iSCSI storage array in the HPC cluster that you want to modify. 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

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-IpAddress<String>

Specifies a new IP address for the iSCSI storage array.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

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

none

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

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

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

Inputs

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

  • HpcIScsiStorageArray

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: Set the description for an iSCSI storage array

This command 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 its description to First Storage Array.


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

Example 2: Modify an iSCSI storage array stored as a variable

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 second command sets the name and description for the iSCSI storage array in $SA.


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

Related topics

Community Additions

ADD
Show: