NAME
Get-DcsPort
SYNOPSIS
Returns the port data for SCSI ports.
SYNTAX
Get-DcsPort [ -Type <String[]> ] [ -Machine <Object> ] [ -MachineType <String> ] [ -Port <Object> ] [ -Connection <String> ] [ -PipelineVariable <String> ]
Get-DcsPort [ -Type <String[]> ] [ -Unassigned] [ -Port <Object> ] [ -Connection <String> ] [ -PipelineVariable <String> ]
DESCRIPTION
Returns the port data for SCSI ports. Filtering parameters may be specified to narrow the scope of the data returned. If no parameters are specified, data for all SCSI ports for all servers and all associated clients in the server group of the default connection will be returned.
PARAMETERS
- -Type<String[]>
- Type of SCSI port. Parameter values are "iSCSI", "FibreChannel", and "LooPBack". If one or more types are specified, only data for those port types will be returned. If not specified, data for all types will be returned.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -Machine<Object>
- Computer name or ID that identifies a server or client (host) machine. The computer name for a server must be unique or the names must be fully qualified. If a machine is specified, only data involving that machine will be returned.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -MachineType<String>
- This parameter is used to limit the return of data by the type of machine. Possible values include "Servers", "Clients" (host), or "All".
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -Port<Object>
- ScsiPortData object, name, or ID that identifies a port. To uniquely identify a port by name, the server must be specified. If a port is specified, only data for that port will be returned.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: true (ByValue)
- 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
-
- -Unassigned<SwitchParameter>
- Use this parameter to only return ports that are not assigned to a client (host). If this parameter not specified, all assigned and unassigned ports will be returned. If specifying this parameter, omit the MachineType parameter when invoking this cmdlet.
-
- 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 Get-DcsPortConnection, Get-DcsiSCSISession. To set port properties, see Set-DcsServerPortProperties or Set-DcsPortProperties.
EXAMPLES
-------------- Example 1 Returns data for a port specified by name --------------
Get-DcsPort -Port "Microsoft iSCSI Initiator"
Returns data for all ports named "Microsoft iSCSI Initiator" in the server group.
| InitiatorPortals | : | {fe80::2de4:e3b4:87d0:b299, fe80::d86e:28b1:6c8e:ee36, fe80::ac9f:4abc:8e7:447a, fe80::f13e:c21d:f0b8:c2e...} |
| iSnsServer | : | {} |
| TargetPortals | : | {DataCore.Executive.iScsiTargetPortalData} |
| PresenceStatus | : | Present |
| PhysicalName | : | MSFT-05-1991 |
| ServerPortProperties | : | DataCore.Executive.ServerPortPropertiesData |
| RoleCapability | : | Backend, Mirror |
| PortName | : | iqn.1991-05.com.microsoft.ssv1.datacoresoftware.com |
| Alias | : | Microsoft iSCSI Initiator |
| Description | : | |
| PortType | : | iSCSI |
| PortMode | : | Initiator |
| HostId | : | A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3 |
| Connected | : | True |
| Id | : | A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3:MSFT-05-1991 |
| Caption | : | Microsoft iSCSI Initiator |
| ExtendedCaption | : | Microsoft iSCSI Initiator on SSV1 |
| Internal | : | False |
| InitiatorPortals | : | {fe80::4845:95ea:39c3:6fa6, fe80::706f:1642:d9f4:d1b7, fe80::6181:9311:6644:c8d2, fe80::2920:ddc6:93a7:45df...} |
| iSnsServer | : | {} |
| TargetPortals | : | {DataCore.Executive.iScsiTargetPortalData, DataCore.Executive.iScsiTargetPortalData, DataCore.Executive.iScsiTargetPortalData, DataCore.Executive.iScsi TargetPortalData...} |
| PresenceStatus | : | Present |
| PhysicalName | : | MSFT-05-1991 |
| ServerPortProperties | : | DataCore.Executive.ServerPortPropertiesData |
| RoleCapability | : | Backend, Mirror |
| PortName | : | iqn.1991-05.com.microsoft:ssv2.datacoresoftware.com |
| Alias | : | Microsoft iSCSI Initiator |
| Description | : | |
| PortType | : | iSCSI |
| PortMode | : | Initiator |
| HostId | : | 781D998D-3920-46BB-9F26-88BC591772B6 |
| Connected | : | True |
| Id | : | 781D998D-3920-46BB-9F26-88BC591772B6:MSFT-05-1991 |
| Caption | : | Microsoft iSCSI Initiator |
| ExtendedCaption | : | Microsoft iSCSI Initiator on SSV2 |
| Internal | : | False |
-------------- Example 2 Returns server port properties for a specific port --------------
(Get-DcsPort -Machine "SSVVM04" -Port "Server iSCSI Port 1").ServerPortProperties
Returns server port properties for the port named Server iSCSI Port 1 on the server named SSVVM04.
| Active | : | True |
| Alias | : | |
| Authentication | : | CHAP |
| AutoLoginMode | : | Default |
| DisablePortWhileStopped | : | True |
| Discovery | : | DataCore.Executive.iSCSI.DiscoveryConfig |
| InstanceName | : | MAC:00-15-5D-13-89-10 |
| ISID | : | 140737488355328 |
| MaxActiveICommands | : | 0 |
| MaxActiveTCommands | : | 256 |
| NodeName | : | iqn.2000-08.com.datacore:ssvvm04-1 |
| IScsiPortalsConfig | : | {DataCore.Executive.iSCSI.iScsiPortalConfigInfo} |
| RecoveryLevel | : | Default |
| ScsiMode | : | Target |
| SessionParams | : | DataCore.Executive.iSCSI.SessionParams |
| TPGT | : | 1 |
| Role | : | Frontend, Mirror |
| PortGroup | : | Zone 1 |
-------------- Example 3 Returns data for all unassigned ports of a specified type --------------
Get-DcsPort -Type iSCSI -Unassigned
Returns data for all iSCSI ports that are currently unassigned. There are four ports.
| HostId | : | |
| PortName | : | iqn.1991-05.com.microsoft:host1.datacoresoftware.com |
| Alias | : | |
| Description | : | |
| PortType | : | iSCSI |
| PortMode | : | Initiator |
| Connected | : | True |
| Id | : | iqn.1991-05.com.microsoft:host1.datacoresoftware.com |
| Caption | : | iqn.1991-05.com.microsoft:host1.datacoresoftware.com |
| ExtendedCaption | : | iqn.1991-05.com.microsoft:host1.datacoresoftware.com |
| Internal | : | False |
| HostId | : | |
| PortName | : | iqn.1991-05.com.microsoft:host4.datacoresoftware.com |
| Alias | : | |
| Description | : | |
| PortType | : | iSCSI |
| PortMode | : | Initiator |
| Connected | : | True |
| Id | : | iqn.1991-05.com.microsoft:host4.datacoresoftware.com |
| Caption | : | iqn.1991-05.com.microsoft:host4.datacoresoftware.com |
| ExtendedCaption | : | iqn.1991-05.com.microsoft:host4.datacoresoftware.com |
| Internal | : | False |
| HostId | : | |
| PortName | : | iqn.2000-08.com.datacore:vm-host-ex-1 |
| Alias | : | |
| Description | : | |
| PortType | : | iSCSI |
| PortMode | : | Target |
| Connected | : | True |
| Id | : | iqn.2000-08.com.datacore:vm-host-ex-1 |
| Caption | : | iqn.2000-08.com.datacore:vm-host-ex-1 |
| ExtendedCaption | : | iqn.2000-08.com.datacore:vm-host-ex-1 |
| Internal | : | False |
| HostId | : | |
| PortName | : | iqn.1991-05.com.microsoft:host2.datacoresoftware.com |
| Alias | : | |
| Description | : | |
| PortType | : | iSCSI |
| PortMode | : | Initiator |
| Connected | : | True |
| Id | : | iqn.1991-05.com.microsoft:host2.datacoresoftware.com |
| Caption | : | iqn.1991-05.com.microsoft:host2.datacoresoftware.com |
| ExtendedCaption | : | iqn.1991-05.com.microsoft:host2.datacoresoftware.com |
| Internal | : | False |