NAME

Set-DcsServerPortProperties

SYNOPSIS

Sets the properties of a Fibre Channel or iSCSI target server port and reinitializes the port. Port group can be set. (To change the alias or description of a port, see Set-DcsPortProperties cmdlet.)

SYNTAX

Set-DcsServerPortProperties   [ -Server <String> ]   -Port <Object>   [ -NodeName <String> ]   [ -SCSIMode <String> ]   [ -PortRole <String[]> ]   [ -PortGroup <String> ]   [ -MaxActiveInitiatorCommands <UInt32> ]   [ -MaxActiveTargetCommands <UInt32> ]   [ -DisablePortWhileStopped <Boolean> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Set-DcsServerPortProperties   [ -Server <String> ]   -Port <Object>   [ -NodeName <String> ]   [ -SCSIMode <String> ]   [ -PortRole <String[]> ]   [ -PortGroup <String> ]   [ -MaxActiveInitiatorCommands <UInt32> ]   [ -MaxActiveTargetCommands <UInt32> ]   [ -DisablePortWhileStopped <Boolean> ]   [ -PortName <String> ]   [ -ConnectionMode <String> ]   [ -DataRateMode <String> ]   [ -HardAssignedId <UInt32> ]   [ -HardIdMode <String> ]   [ -UseSoftWWN <Boolean> ]   [ -PortDownTimeout <UInt32> ]   [ -VmIdMode <String> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Set-DcsServerPortProperties   [ -Server <String> ]   -Port <Object>   [ -NodeName <String> ]   [ -SCSIMode <String> ]   [ -PortRole <String[]> ]   [ -PortGroup <String> ]   [ -MaxActiveInitiatorCommands <UInt32> ]   [ -MaxActiveTargetCommands <UInt32> ]   [ -DisablePortWhileStopped <Boolean> ]   [ -Authentication <String> ]   [ -AutoLoginMode <String> ]   [ -InstanceName <String> ]   [ -ISID <UInt64> ]   [ -RecoveryLevel <String> ]   [ -TPGT <UInt32> ]   [ -TCPPort <UInt16> ]   [ -IPAddress <String> ]   [ -iSNSServerAddress <String> ]   [ -iSNSDomainName <String> ]   [ -iSNSTCPPort <UInt16> ]   [ -iSNSEnabled <Boolean> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Sets the properties of a Fibre Channel or iSCSI target server port and reinitializes the port. Port group can be set. (To change the alias or description of a port, see Set-DcsPortProperties cmdlet.) CAUTION: Some settings will affect performance. Do not alter settings unless you are familiar with the options and understand the ramifications of the changes.

PARAMETERS

-Server<String>

Computer name or ID of the server. The computer name must be unique or the name must be fully qualified.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Port<Object>

ScsiPortData object, name, or ID that identifies the port. To uniquely identify the port by name, the server must be specified.

Required: true

Position: named

Default value:

Accept pipeline input: true (ByValue)

Accept wildcard characters: false

-NodeName<String>

Use this parameter to change the node name (IQN or WWN) of a port or to set the node name of the Fibre Channel port when using the Soft WWN feature. If changing an IQN, all letters must be entered in lowercase. To use the Soft WWN feature, the parameter UseSoftWWN must be enabled.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-SCSIMode<String>

Use this parameter to set a SCSI mode for the port. Parameter values are Initiator, InitiatorTarget, Target, or NonScsi.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-PortRole<String[]>

Use this parameter to set one or more port roles for the port. Port roles regulate the use of ports. Valid values include: "Frontend" allows the port to be used to serve virtual disks to client hosts. "Backend" allows the port to be used to access physical disk storage. "Mirror" allows the port to be used in mirroring virtual disk data between servers. "None" will prohibit use of the port. This value should not be combined with other values in the same operation.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-PortGroup<String>

Use this parameter to set a port group for the server FC port or iSCSI target port. The valid value for this parameter is the name of the port group in quotation marks, for instance "Port group 1". To remove the port from the port group, use an empty string as the value; for example "". Port groups are not valid for iSCSI initiator ports or LooPBack ports.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-MaxActiveInitiatorCommands<UInt32>

Use this parameter to set the maximum number of active outstanding initiator commands. The default setting is dependent on card capabilities and port mode.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-MaxActiveTargetCommands<UInt32>

Use this parameter to set the maximum number of active outstanding target commands. The default setting is dependent on card capabilities and port mode.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-DisablePortWhileStopped<Boolean>

Use this parameter to enable or disable the Disable Port While Stopped function. Specify $true to enable the function or $false to disable the function. When Disable Port While Stopped is enabled, the port is offlined and logged out when the server is stopped. This function is required by some client host operating systems to properly failover. The SCSI mode of the target port should be set to target (see ScsiMode parameter).

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Connection<String>

Alias of the connection to the server group. If not specified, the default connection is used.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-PipelineVariable<String>

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-PortName<String>

Use this parameter to set the soft WWN port name of the Fibre Channel port. To use the Soft WWN feature, the parameter UseSoftWWN must also be enabled.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-ConnectionMode<String>

Use this parameter to set the connection mode (or preferred topology) of the Fibre Channel port. Valid values include: "Default" allows the port to set the connection mode. "P2P" will set the mode as Point to Point only. "LoopThanP2P" will set the mode as Loop being preferred, otherwise Point to Point is used. "P2PThanLoop" will set the mode as Point to Point being preferred, otherwise Loop is used.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-DataRateMode<String>

Use this parameter to set the data rate (link speed) of the Fibre Channel port. Parameter values are Auto, Default, OneGiB, TwoGiB, FourGiB, or EightGiB. "Default" allows the port to set the data rate. "Auto" allows the port to set the data rate by sensing the current data rate on the link (if the port has this capability).

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-HardAssignedId<UInt32>

Use this parameter to set the new loop ID to use for the Fibre Channel port. When specified, the parameter HardIDMode must be enabled.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-HardIdMode<String>

Use this parameter to set whether or not a fixed loop ID should be assigned for the Fibre Channel port. Valid values include: "Default" allows the port to determine if the loop ID should be assigned. If set, the HardAssignedId parameter must be specified. "Enabled" will allow the port to assign a fixed loop ID. If set, the HardAssignedID parameter must be specified. "Disabled" will disabled the fixed loop ID.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-UseSoftWWN<Boolean>

Use this parameter to enable or disable the Soft WWN feature. When enabled, Fibre Channel ports can be identified using a substitute World Wide Name (WWN). When soft WWNs are used, Fibre Channel HBAs can be replaced without having to unserve virtual disks and then reserve virtual disks to hosts again using the WWNs of the new HBAs. Specify $true to enable the Soft WWN feature. If enabled, the parameters NodeName and PortName must also be specified. Specify $false to disable the Soft WWN feature.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-PortDownTimeout<UInt32>

Use this parameter to set the delay time in seconds before a Fibre Channel port is considered offline and will be logged off.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-VmIdMode<String>

Use this parameter to enable or disable support for the Brocade VM Insight switch feature. Enter "Brocade" to enable the feature or "None" to disable the feature.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Authentication<String>

Use this parameter to set the CHAP authentication for the iSCSI target port. Parameter values are "Default", "None", or "CHAP". "Default" will allow the initiator to determine whether to use CHAP. If "Default" or "CHAP" is specified, the target secret will have to be provided (see Add-DcsAccessToken).

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-AutoLoginMode<String>

Use this parameter to designate if the iSCSI port should be automatically logged in. Parameter values include: "Enabled" will allow the port to be automatically logged in. "Disabled" will prevent the port from being automatically logged in. "Default" will allow the port to determine.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-InstanceName<String>

Use this parameter to set the Initiator Instance Name for an iSCSI port.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-ISID<UInt64>

Use this parameter to set the initiator session ID (ISID) for an iSCSI port.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-RecoveryLevel<String>

Use this parameter to set the recovery level of the port. Valid vales include "Default", "ConnectionLost", "DigestFailure", or "SessionFailure".

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-TPGT<UInt32>

Use this parameter to set the Target Portal Group Tag (TPGT) for an iSCSI port.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-TCPPort<UInt16>

Use this parameter to set the TCP port to use to connect to the iSCSI port. The default is 3260, which should be correct for standard environments.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-IPAddress<String>

Use this parameter to set the IP address of the iSCSI port.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-iSNSServerAddress<String>

Use this parameter to set the address of the iSNS server. This parameter is only valid if iSNS is enabled for the iSCSI port. (See the ISNSEnabled parameter.)

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-iSNSDomainName<String>

Use this parameter to set the domain name of the iSNS server. This parameter is only valid if iSNS is enabled for the iSCSI port. (See the ISNSEnabled parameter.)

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-iSNSTCPPort<UInt16>

Use this parameter to set the TCP port to use for the iSNS server. The default port is 3205, which should be correct for standard environments. This parameter is only valid if iSNS is enabled for the iSCSI port. (See the ISNSEnabled parameter.)

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-iSNSEnabled<Boolean>

Use this parameter to designate whether or not iSNS is used. Specify $true if using iSNS or $false if iSNS is not used. When this parameter is specified as $true, the parameters IsnsServerAddress, IsnsDomainName, and IsnsTcpPort must also be specified.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

INPUTS

ScsiPortData : Object that identifies and describes the port.

OUTPUTS

ScsiPortData : Object that identifies and describes the port.

NOTES

Also see Set-DcsPortProperties, Get-DcsPort, Get-DcsPortConnection, Get-DcsFcPortConnection, Set-DcsInitiatorNodeName, Set-DcsInitiatorSecret, Add-DcsAccessToken.

EXAMPLES

Set-DcsServerPortProperties -Server SSV1  -Port "Server iSCSI Port 1" -SCSIMode Target -PortRole "Frontend", "Mirror" -Authentication CHAP -PortGroup "Zone 1"
		

Get-DcsPort -Type iSCSI -MachineType Servers | Set-DcsServerPortProperties -iSNSServerAddress 13.0.0.13 -iSNSDomainName datacoresoftware.com -iSNSEnabled $true
		

Set-DcsServerPortProperties -Server SSV3 -Port "Server iSCSI Port 1" -NodeName "iqn.2000-08.com.datacore:ssv3-1a"