Operation: get-port

Home  Previous  Next

The get-port operation lists all the ports of the controllers of the specified storage system along with their main characteristics (speed and WWN notably). These ports are sometimes called "Target Ports".

Storage Groups define which hosts can access which LUNs through which controller port. It is therefore necessary to know the ports of the storage system before assigning LUNs to hosts.

Adapter Request Elements for 'get-port' Operation

 

Definition

Required

operation-name

Specifies the name of the operation you want to perform.

Valid value: get-port.

Yes

arguments

Parent element for <argument> element.

Yes

argument

Specifies a list of arguments that is required for this operation

Yes

target

Specifies the connection information for an EMC SMI-S Provider.

Valid value: The value specified for <target> element must be the same as the value that has been specified for the name attribute of <config> element in the adapter configuration. You can skip this element. In this case the request will be executed on the first defined adapter configuration. You can leave this element empty. In this case the request will be executed on the first defined adapter configuration.
Default value: The first defined adapter configuration.

No

timeout-secs

Specifies the time in seconds after which the attempt to connect to the EMC SMI-S Provider times out. The "timeout-secs" specified in adapter request overrides the value specified in adapter configuration.

Valid value: A numeric value which specifies the time in seconds.
Default Value: 180, if no "timeout-secs" is provided in adapter configuration.

No

You can specify one or more of the following elements to retrieve specific information. If none of the elements is specified, then all the details are fetched.

storage-system-name

Specifies the user defined storage system name.

Valid value: Please refer to the get-storage-system operation to list the valid values of this field.
Default value: None.

Yes

port-name

Specifies the user defined port name.

Valid value: Please refer to the get-port operation to list the valid values of this field.
Default value: None.

No

port-type

Returns the complete information of requested port type. When the "port-type" element is not present, the command reports on all ports.

Valid value: FC or Ethernet.
Default value: None.

No

Sample Adapter Request for 'get-port' Operation

<emc-storage-request>

    <operation-name>get-port</operation-name>

    <arguments>

      <argument>

        <storage-system-name>AMS2100.83011628</storage-system-name>

        <port-name />

  <port-type />

      </argument>

    </arguments>

</emc-storage-request>

Adapter Response Elements for 'get-port' Operation

 

Description

storage-system-name

Name of the storage system.

port-name

Name of the port.

port-type

Type of port.

Possible values: FC or Ethernet

port-wwn

WWN that belongs to the port.

port-speed

Port connection speed.

controller

Name of the controller.

operational-status

Operational status of the storage system.

operational-status-description

Additional information about the operational status of the port.

Sample Adapter Response for 'get-port' Operation

<emc-storage-response>

  <metadata>

    <status>success</status>

    <response-count>1</response-count>

  </metadata>

  <responses>

    <response>

      <metadata>

        <status>success</status>

        <execution-milliseconds>514</execution-milliseconds>

        <line-count>192</line-count>

        <port-count>24</port-count>

        <target>locke-2</target>

        <config-name>default</config-name>

      </metadata>

      <output>

        <ports>

          <port>

            <storage-system-name>CLARiiON+CKM00083900053</storage-system-name>

            <port-name>SP_A:0</port-name>

            <port-type>FC</port-type>

            <port-wwn>500601603CE010D5</port-wwn>

            <port-speed>0</port-speed>

            <controller>SP_A</controller>

            <operational-status>10,2</operational-status>

            <operational-status-description>Stopped, OK</operational-status-description>

          </port>

          <port>

            <storage-system-name>CLARiiON+CKM00083900053</storage-system-name>

            <port-name>SP_A:1</port-name>

            <port-type>FC</port-type>

            <port-wwn>500601613CE010D5</port-wwn>

            <port-speed>0</port-speed>

            <controller>SP_A</controller>

            <operational-status>10,2</operational-status>

            <operational-status-description>Stopped, OK</operational-status-description>

          </port>

          <port>

            <storage-system-name>SYMMETRIX+000294901120</storage-system-name>

            <port-name>FA-7F:0</port-name>

            <port-type>FC</port-type>

            <port-wwn>50000974C0118158</port-wwn>

            <port-speed>0</port-speed>

            <controller>FA-7F</controller>

            <operational-status>2</operational-status>

            <operational-status-description>OK</operational-status-description>

          </port>

          <port>

            <storage-system-name>SYMMETRIX+000294901120</storage-system-name>

            <port-name>FA-7F:1</port-name>

            <port-type>FC</port-type>

            <port-wwn>50000974C0118159</port-wwn>

            <port-speed>0</port-speed>

            <controller>FA-7F</controller>

            <operational-status>2</operational-status>

            <operational-status-description>OK</operational-status-description>

          </port>

          <port>

            <storage-system-name>CLARiiON+CKM00083900053</storage-system-name>

            <port-name>SP_A:2</port-name>

            <port-type>Ethernet</port-type>

            <port-iqn>iqn.1992-04.com.emc:cx.ckm00083900053.a2</port-iqn>

            <port-ipaddress>172.16.10.80</port-ipaddress>

            <controller>SP_A</controller>

            <operational-status>2</operational-status>

            <operational-status-description>OK</operational-status-description>

          </port>

          <port>

            <storage-system-name>CLARiiON+CKM00083900053</storage-system-name>

            <port-name>SP_A:3</port-name>

            <port-type>Ethernet</port-type>

            <port-iqn>iqn.1992-04.com.emc:cx.ckm00083900053.a3</port-iqn>

            <port-ipaddress>172.16.10.81</port-ipaddress>

            <controller>SP_A</controller>

            <operational-status>10,2</operational-status>

            <operational-status-description>Stopped, OK</operational-status-description>

          </port>

        </ports>

      </output>

    </response>

  </responses>

</emc-storage-response>