Fabric Manager:Get FC Endpoints By Fabric

Search (SHIFT+S)



Get FC Endpoints By Fabric

GET /vdc/network-systems/{id}/fc-endpoints/

This returns the cached fiber channel connectivity information of a given fabric id between the network system and external systems, such as host initiators or storage array ports. If fabric id is not specified, get all connections of the network system. The connectivity information is periodically updated, or can be refreshed on demand using a POST /vdc/network-systems/{id}/refresh.

idthe URN of a ViPR Network System

Query Parameters

fabric-idThe name of the VSAN or fabric as returned by /vdc/network-systems/{id}/san-fabrics or the VSAN or fabric WWN

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN
  • SYSTEM_MONITOR

Response Body

A list of FCEndpoint structures, each containing information about one connection.

Field Description Type Notes
<fc_endpoints>
<fc_endpoint>     0-* Elements
<fabric_id> The VSAN (Virtual Storage Area Network) ID. String
<fabric_wwn> The WWN (World Wide Name) of the VSAN (Virtual Storage Area Network). String
<fcid> The FC (Fibre Channel) ID. String
<networkDevice>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</networkDevice>      
<remote_node_name> The name of the remote node of the connection (WWNN). String
<remote_port_name> The name of the remote port of the connection (WWPN). String
<remote_port_alias> The alias of the remote port of the connection String
<switch_interface> The name of the switch (local) interface of the port. String
<switch_name> The hostname of the switch the port is in. String
<switch_port_name> The name of the local port. String
<name> The name assigned to this resource in ViPR. The resource name is set by a user and can be changed at any time. It is not a unique identifier. String
<id> An identifier that is generated by ViPR when the resource is created. The resource ID is guaranteed to be unique and immutable across all virtual data centers for all time. URI Valid Values:
  •  urn:storageos:resource-type:UUID:
<link> A hyperlink to the details for this resource
<creation_time> A timestamp that shows when this resource was created in ViPR DateTime Valid Values:
  •  YYYY-MM-DDTHH:mm:ssZ
<tags> Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search.
<tag> String 0-* Elements
</tags>
<inactive> Whether or not the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ViPR database. Boolean Valid Values:
  •  true
  •  false
<global> Boolean
<remote> Boolean
<vdc>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</vdc>      
<internal> Whether or not the resource is an internal resource. Boolean Valid Values:
  •  true
  •  false
</fc_endpoint>      
</fc_endpoints>

Examples

Request
GET https://192.168.0.0:4443/vdc/network-systems/rn:storageos:FCEndpoint:00ece5b8-567e-4f17-aeb7-a17f5af0f75a:/fc-endpoints HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
Response
HTTP/1.1 200 OK
Content-Type: application/xml

<fc_endpoints>
       <fc_endpoint>
              <creation_time>1380666661215</creation_time>
              <id>urn:storageos:FCEndpoint:00ece5b8-567e-4f17-aeb7-a17f5af0f75a:
              </id>
              <inactive>false</inactive>
              <link
                     href="/vdc/fc-port-connections/urn:storageos:FCEndpoint:00ece5b8-567e-4f17-aeb7-a17f5af0f75a:"
                     rel="self" />
              <tags />
              <fabric_id>losam082-fabric</fabric_id>
              <fabric_wwn>10:00:00:27:F8:58:F6:BD</fabric_wwn>
              <networkDevice>
                     <id>urn:storageos:NetworkSystem:205a419f-0d63-4925-80cc-0f44b017ad69:
                     </id>
                     <link
                           href="/vdc/network-systems/urn:storageos:NetworkSystem:205a419f-0d63-4925-80cc-0f44b017ad69:"
                           rel="self" />
              </networkDevice>
              <remote_node_name>50:01:24:80:00:69:F7:77</remote_node_name>
              <remote_port_name>50:01:24:81:00:69:F7:77</remote_port_name>
              <switch_interface>slot12 port14</switch_interface>
              <switch_name>losam018_10</switch_name>
              <switch_port_name>20:7E:00:27:F8:58:F6:BD</switch_port_name>
       </fc_endpoint>
       <fc_endpoint>
              <creation_time>1380666661216</creation_time>
              <id>urn:storageos:FCEndpoint:04449410-1d75-4238-bc45-2c1f3594e7a9:
              </id>
              <inactive>false</inactive>
              <link
                     href="/vdc/fc-port-connections/urn:storageos:FCEndpoint:04449410-1d75-4238-bc45-2c1f3594e7a9:"
                     rel="self" />
              <tags />
              <fabric_id>VPlex_LGL6221_FID_40</fabric_id>
              <fabric_wwn>10:00:00:27:F8:58:F6:C2</fabric_wwn>
              <networkDevice>
                     <id>urn:storageos:NetworkSystem:205a419f-0d63-4925-80cc-0f44b017ad69:
                     </id>
                     <link
                           href="/vdc/network-systems/urn:storageos:NetworkSystem:205a419f-0d63-4925-80cc-0f44b017ad69:"
                           rel="self" />
              </networkDevice>
              <remote_node_name>50:00:14:40:47:30:71:23</remote_node_name>
              <remote_port_name>50:00:14:42:90:71:23:00</remote_port_name>
              <switch_interface>slot4 port30</switch_interface>
              <switch_name>switch_40</switch_name>
              <switch_port_name>20:BE:00:27:F8:58:F6:C2</switch_port_name>
       </fc_endpoint>
</fc_endpoints>
Notes: