NAME
Set-DcsPortProperties
SYNOPSIS
Sets the alias or description of a server or client (host) port.
SYNTAX
Set-DcsPortProperties [ -Machine <String> ] -Port <Object> [ -NewName <String> ] [ -Description <String> ] [ -Connection <String> ] [ -PipelineVariable <String> ]
DESCRIPTION
Sets the alias or description of a server or client (host) port.
PARAMETERS
- -Machine<String>
- Computer name or ID that identifies a server, or the name or ID that identifies a client. The computer name of the server 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 set or change. To uniquely identify the port by name, the machine must be specified.
-
- Required: true
- Position: named
- Default value:
- Accept pipeline input: true (ByValue)
- Accept wildcard characters: false
-
- -NewName<String>
- Use this parameter to change the name (alias) for the port. Specify the new name.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -Description<String>
- Use this parameter to set a description of the port. To remove the description, use an empty string as the value; for example "".
-
- 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
-
INPUTS
ScsiPortData : Object that identifies and describes the port.
OUTPUTS
ScsiPortData : Object that identifies and describes the port.
NOTES
To view the properties of the port such as port group, use Get-DcsPort. To set preferred server, use Set-DcsClientProperties, To set other server port properties see Set-DcsServerPortProperties.
EXAMPLES
Set-DcsPortProperties -Machine SSVVM01 -Port "Server iSCSI Port 2" -NewName "Server iSCSI Port FE MR" -Description "Zone 1, FE/MR"
Changes the name of the port "Server iSCSI Port 2" on server "SSVVM01" to "Server iSCSI Port FE MR" and adds a description "Zone 1, FE/MR".
| IdInfo | : | DataCore.Executive.iSCSI.iScsiPortIdInfo |
| PortConfigInfo | : | DataCore.Executive.iSCSI.PortConfigInfo |
| IScsiPortStateInfo | : | DataCore.Executive.iSCSI.iScsiPortStateInfo |
| iSCSINodes | : | {iqn.1991-05.com.microsoft:ssvvm02.datacoresoftware.com, |
| iqn.1991-05.com.microsoft | : | ssvvm06.datacoresoftware.com, |
| iqn.1991-05.com.microsoft | : | hostvm1.datacoresoftware.com} |
| CapabilityInfo | : | DataCore.Executive.iSCSI.iScsiPortCapabilityInfo |
| PresenceStatus | : | Present |
| PhysicalName | : | MAC:00-15-5D-13-89-05 |
| ServerPortProperties | : | DataCore.Executive.ServeriScsiPortPropertiesData |
| RoleCapability | : | Frontend, Mirror |
| AluaId | : | 1029 |
| PortName | : | iqn.2000-08.com.datacore:ssvvm01-2 |
| Alias | : | Server iSCSI Port FE MR |
| Description | : | Zone 1, FE/MR |
| PortType | : | iSCSI |
| PortMode | : | Target |
| HostId | : | F51570F9-23FD-43C9-BE56-563D26220F18 |
| Connected | : | True |
| Sequencenumber | : | 9394 |
| Id | : | d0618002-4ce6-41e7-8493-77b558a9c2cc |
| Caption | : | Server iSCSI Port FE MR |
| ExtendedCaption | : | Server iSCSI Port FE MR on SSVVM01 |
| Internal | : | False |