Storage Port:Get Storage Port

Search (SHIFT+S)



Get Storage Port

GET /vdc/storage-ports/{id}

Gets the data for a storage port.

idthe URN of a ViPR storage port.

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN
  • SYSTEM_MONITOR

Response Body

A StoragePortRestRep reference specifying the data for the storage port with the passed id.

Field Description Type Notes
<storage_port>
<avg_band_width> The average bandwidth through the port (Gbps) Long
<ip_address> The port's IP address (for IP-based transport) String
<port_endpoint_id> ID of the endpoint with which this port is associated. String
<port_group> The name of this port's group. A port group is a mapping that is configured on a storage system between a collection of ports, a collection of volumes and a collection of hosts that use those volumes. This name is what the storage system uses to identify the port group. mapped known by Vipr to this port String
<port_name> The native name of the port. This name consists of identifiers that are used by the hosting storage system. It may also follow a naming convention that is in common use for that make and model of storage system. String
<port_alias> The alias represents port's wwn id String
<port_network_id> The network address of the port. When Fibre-Channel (FC) is the transport protocol, the address is a World Wide Name (WWN). If the port is using an IP-based protocol, this is an IP address, or name of the port that a storage system uses to identify the port. String
<port_speed_gbps> The port's clock speed (Gbps) Long
<port_type> How the port connects its storage controller to its network String Valid Values:
  •  backend = connects a VPLEX storage controller to another array
  •  frontend = connects the storage controller to the hosts
<static_load> The number of exports on the storage port Long
<storage_system>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</storage_system>      
<tcp_port_number> The port's TCP port number (for IP-based transport) Long Valid Values:
  •  1-65535
<transport_type> The protocol that this port uses to transport disk commands and responses across its network String Valid Values:
  •  FC = Fibre-Channel
  •  IP
<network>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</network>      
<registration_status> Whether or not this port is registered with ViPR. A port must be registered before it can be managed by ViPR. String Valid Values:
  •  REGISTERED
  •  UNREGISTERED
<operational_status> The operational status of the port String Valid Values:
  •  OK
  •  NOT_OK
  •  UNKNOWN
<compatibility_status> Whether or not this storage port is compatible with ViPR String Valid Values:
  •  COMPATIBLE
  •  INCOMPATIBLE
  •  UNKNOWN
<allocation_metric> The metric for the Storage Port Allocator. Lower metric numbers are preferred over higher metric numbers for allocation. Double
<port_percent_busy> The port percent busy as computed by the kbytes transferred per a given unit of time versus the maximum number of kbytes that could be transferred as computed from the port speed. Double
<cpu_percent_busy> The number of non-idle ticks for the cpu that is hosting the port versus the total number of possible ticks. Double
<initiator_load> The number of Initiators known by ViPR to be mapped to this port. Long
<volume_load> The number of Volumes known by ViPR to be accessible via this port. Long
<allocation_disqualified> True if at least one of the port metrics is above its limit value. This will prevent allocation of the port. Boolean
<discovery_status> Whether or not this storage pool is visible in discovery String Valid Values:
  •  VISIBLE
  •  NOTVISIBLE
<assigned_varrays> The virtual arrays to which this resource has been explicitly assigned by a user. String 0-* Elements
<connected_varrays> The virtual arrays that are associated with this resource due to network connectivity. For example, a storage port would be connected to a virtual array if the port is in a network assigned to the virtual array. Similarly, the storage pools on that storage port's storage system would also be connected to the virtual array. String 0-* Elements
<tagged_varrays> The virtual arrays that are associated with this resource for the purpose of searching for resources that are associated with a virtual array. If a resource is explicitly assigned to one or more virtual arrays, those virtual arrays are the tagged virtual arrays. If there are no explicit assignments for the resource, all of the connected virtual arrays are the tagged virtual arrays. String 0-* Elements
<native_guid> The native unique identifier for this resource

Network Transport Types:

  • FC = Fibre-Channel

Network System Types:

  • BROCADE
  • MDS

Storage System Types:

  • CELERRA = VNX File
  • CLARIION = VNX Block
  • ISILON
  • NETAPP
  • SYMMETRIX
String Valid Values:
  •  Network : transport-type+network-system-type+fabric-WWN
  •  NetworkSystem: network-system-type+management-IP-address+management-port
  •  StoragePool : storage-system-type+storage-system-serial-number+POOL+pool-native-id
  •  StoragePort : storage-system-type+storage-system-serial-number+PORT+port-network-id
  •  StorageSystem: storage-system-type+serial-number
  •  StorageTier, Auto-Tiering: storage-system-type+storage-system-serial-number+FASTPOLICY+policy-name
  •  StorageTier, VMAX: storage-system-type+storage-system-serial-number+TIER+tier-name
  •  StorageTier, VNX: storage-system-type+storage-system-serial-number+TIER+pool-name+tier-name
<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
</storage_port>

Examples

Request
GET https://192.168.0.0:4443/vdc/storage-ports/urn:storageos:StoragePort:06897e96-10ef-4aa3-a207-769ad63ffa2b: HTTP/1.1

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<storage_port>
    <creation_time>1379168886761</creation_time>
    <id>urn:storageos:StoragePort:06897e96-10ef-4aa3-a207-769ad63ffa2b:</id>
    <inactive>false</inactive>
    <link href="/vdc/storage-systems/urn:storageos:StorageSystem:c4ca726b-d108-49b5-8d79-ba060cc8775b:/storage-ports/urn:storageos:StoragePort:06897e96-10ef-4aa3-a207-769ad63ffa2b:" rel="self"/>
    <name>CLARIION+APM00112900836+PORT+iqn.1992-04.com.emc:cx.apm00112900836.a5</name>
    <tags/>
    <native_guid>CLARIION+APM00112900836+PORT+iqn.1992-04.com.emc:cx.apm00112900836.a5</native_guid>
    <ip_address>192.168.0.0</ip_address>
    <operational_status>OK</operational_status>
    <port_endpoint_id>iqn.1992-04.com.emc:cx.apm00112900836.a5,t,0x0001</port_endpoint_id>
    <port_group>SP_A</port_group>
    <port_name>SP_A:5</port_name>
    <port_network_id>iqn.1992-04.com.emc:cx.apm00112900836.a5</port_network_id>
    <port_speed_gbps>1</port_speed_gbps>
    <port_type>frontend</port_type>
    <registration_status>REGISTERED</registration_status>
    <storage_system>
        <id>urn:storageos:StorageSystem:c4ca726b-d108-49b5-8d79-ba060cc8775b:</id>
        <link href="/vdc/storage-systems/urn:storageos:StorageSystem:c4ca726b-d108-49b5-8d79-ba060cc8775b:" rel="self"/>
    </storage_system>
    <tcp_port_number>3260</tcp_port_number>
    <transport_type>IP</transport_type>
</storage_port>
Notes: