NAME
Get-DcsPortConnection
SYNOPSIS
Returns port connection data.
SYNTAX
Get-DcsPortConnection [ -PortConnection <Object> ] [ -Port <String> ] [ -Machine <String> ] [ -ConnectionType <String> ] [ -Connection <String> ] [ -PipelineVariable <String> ]
Get-DcsPortConnection [ -PortConnection <Object> ] [ -PortA <String> ] [ -MachineA <String> ] [ -PortB <String> ] [ -MachineB <String> ] [ -ConnectionType <String> ] [ -Connection <String> ] [ -PipelineVariable <String> ]
DESCRIPTION
Returns port connection data. Filtering parameters may be specified to narrow the scope of the data returned. If no parameters are specified, data for all port connections for all servers in the default connection will be returned.
PARAMETERS
- -PortConnection<Object>
- PortConnectionData object or ID that identifies a port connection. If a port connection is specified, only data for that port connection will be returned.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: true (ByValue)
- Accept wildcard characters: false
-
- -Port<String>
- Name or ID of a port. To uniquely identify a port by name, the machine 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: false
- Accept wildcard characters: false
-
- -Machine<String>
- Computer name or ID for a server, or the name or ID for a client machine. Computer names for servers must be unique or the names must be fully qualified. If a machine is specified, only port connection data for that machine will be returned.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -ConnectionType<String>
- This parameter is used to limit the return of data by the port type. Possible values include "FibreChannel", "iSCSI", or "All". "All" will return connection data for all port types.
-
- 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
-
- -PortA<String>
- Name or ID of a initiator port in a path. To uniquely identify a port by name, the parameter MachineA must be specified. This parameter can be used with PortB to identify two ports in a path. If PortA is specified, only data for that port will be returned.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -MachineA<String>
- Computer name or ID for a server, or the name or ID for a client machine. Computer names for servers must be unique or the names must be fully qualified. If MachineA is specified, only data for that machine will be returned.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -PortB<String>
- Name or ID of a target port in a path. To uniquely identify a port by name, the parameter MachineB must be specified. This parameter can be used with PortA to identify two ports in a path. If PortB is specified, only data for that port will be returned.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -MachineB<String>
- Computer name or ID for a server, or the name or ID for a client machine. Computer names for servers must be unique or the names must be fully qualified. If MachineB is specified, only data for that machine will be returned.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
INPUTS
PortConnectionData : Object that identifies and describes a port connection.
OUTPUTS
PortConnectionData : Object that identifies and describes a port connection.
NOTES
Also see Get-DcsPort.
EXAMPLES
-------------- Example 1 Returns connection data for a port specified by name --------------
Get-DcsPortConnection -Port "Microsoft iSCSI Initiator" -Machine SSV1
Returns data for connections involving the port named "Microsoft iSCSI Initiator" on the machine named "SSV1".
| PortADescriptor | : | DataCore.Executive.iSCSI.SessionDescriptor |
| PortBDescriptor | : | DataCore.Executive.iSCSI.SessionDescriptor |
| Target | : | |
| Connected | : | True |
| PortAId | : | A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3:MSFT-05-1991 |
| PortBId | : | 781D998D-3920-46BB-9F26-88BC591772B6:MAC:00-15-5D-11-E9-22 |
| Id | : | 15d8e3340cdb435d9b2d10b06036e03b |
| Caption | : | Microsoft iSCSI Initiator on SSV1 to Server iSCSI Port 3 on SSV2 |
| ExtendedCaption | : | Microsoft iSCSI Initiator on SSV1 to Server iSCSI Port 3 on SSV2 |
| Internal | : | False |
| PortADescriptor | : | DataCore.Executive.iSCSI.SessionDescriptor |
| PortBDescriptor | : | DataCore.Executive.iSCSI.SessionDescriptor |
| Target | : | |
| Connected | : | True |
| PortAId | : | A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3:MSFT-05-1991 |
| PortBId | : | 781D998D-3920-46BB-9F26-88BC591772B6:MAC:00-15-5D-11-E9-23 |
| Id | : | b47cb891604047569f7036e75193bb01 |
| Caption | : | Microsoft iSCSI Initiator on SSV1 to Server iSCSI Port 4 on SSV2 |
| ExtendedCaption | : | Microsoft iSCSI Initiator on SSV1 to Server iSCSI Port 4 on SSV2 |
| Internal | : | False |
| PortADescriptor | : | DataCore.Executive.iSCSI.SessionDescriptor |
| PortBDescriptor | : | |
| Target | : | |
| Connected | : | True |
| PortAId | : | A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3:MSFT-05-1991 |
| PortBId | : | iqn.2000-08.com.datacore:vm-host-ex-1 |
| Id | : | 2953c2e974414ae5a02bbc09d0fe65f5 |
| Caption | : | Microsoft iSCSI Initiator on SSV1 to iqn.2000-08.com.datacore:vm-host-ex-1 |
| ExtendedCaption | : | Microsoft iSCSI Initiator on SSV1 to iqn.2000-08.com.datacore:vm-host-ex-1 |
| Internal | : | False |
-------------- Example 2 Returns data for two specified ports in a path --------------
Get-DcsPortConnection -PortA "Microsoft iSCSI Initiator" -MachineA SSV1 -PortB "Server iSCSI Port 1" -MachineB SSV2
Returns data for two ports that consist of the endpoints of a path. The endpoints of the path consist of PortA named "Microsoft iSCSI Initiator" on MachineA named "SSV1" to PorTiB named "Server iSCSI Port 1" on MachineB named "SSV2".
| PortADescriptor | : | DataCore.Executive.iSCSI.SessionDescriptor |
| PortBDescriptor | : | DataCore.Executive.iSCSI.SessionDescriptor |
| Target | : | |
| Connected | : | True |
| PortAId | : | fc3a73e9-28f4-4e2f-a8e5-cdc50beb045b |
| PortBId | : | ef2bd94f-e093-4305-994d-435bde2ec455 |
| Id | : | b1c80cb79b5f46569ceee6b5ade324b0 |
| Caption | : | Microsoft iSCSI Initiator on SSV1 to Server iSCSI Port 1 on SSV2 |
| ExtendedCaption | : | Microsoft iSCSI Initiator on SSV1 to Server iSCSI Port 1 on SSV2 |
| Internal | : | False |