EMC ViPR REST API

Search (SHIFT+S)

API Reference


Get Network

GET /vdc/networks/{id}

Get info for network

idthe URN of a ViPR Network

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN
  • SYSTEM_MONITOR

Response Body

Network details

Field Description Type Notes
<network>
<discovered> Indicates whether the network was discovered by a network system or manually created. Valid values: true = network was discovered by a network system false = network was manually created Boolean
<endpoints> List of endpoints associated with the network.
<endpoint> String 0-* Elements
</endpoints>
<endpoints_discovered> List of endpoints associated with the network. Each endpoint is indexed to "true" indicating it was discovered or "false" indicating it was manually added into the network.
<endpoint_discovered>     0-* Elements
<alias> String
<name> String
<value> String
</endpoint_discovered>      
</endpoints_discovered>
<fabric_id> Fabric name or VSAN (Virtual Storage Area Network) ID for the network if discovered by a network system. String
<varray>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</varray>      
<network_systems> List of network systems that manage the network. These are the network systems where the network was discovered. Empty list for manually created network.
<network_system> String 0-* Elements
</network_systems>
<assigned_varrays> List of virtual arrays to which the network is assigned.
<assigned_varray> String 0-* Elements
</assigned_varrays>
<connected_varrays> List of virtual arrays to which the network is implicitly connected because a storage port in the network has been assigned to the virtual array.
<connected_varray> String 0-* Elements
</connected_varrays>
<registration_status> Indicates whether the network and its endpoints can be used for provisioning operation. Only registered networks can be used for provisioning operations. Valid values: UNREGISTERED REGISTERED UNKNOWN String
<transport_type> Transport type for the network. Valid values: IP FC Ethernet. String
<routed_networks> A list of networks that are routed to this network Valid value: FC
<routed_network> String 0-* Elements
</routed_networks>
<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
Valid values: Network NetworkSystem StoragePool StoragePort StorageSystem StorageTier:VMAX StorageTier: VNX
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
<link> A hyperlink to the details for this resource
<creation_time> A timestamp that shows when this resource was created in ViPR DateTime
<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
<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
</network>

Examples

Request
GET https://192.168.0.0:4443/vdc/networks/urn:storageos:Network:a913d1e1-27d2-42b8-9375-5531f0101e39: 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"?>
<network>
    <creation_time>1379169017234</creation_time>
    <id>urn:storageos:Network:a913d1e1-27d2-42b8-9375-5531f0101e39:</id>
    <inactive>false</inactive>
    <link href="/vdc/networks/urn:storageos:Network:a913d1e1-27d2-42b8-9375-5531f0101e39:" rel="self"/>
    <name>FABRIC_losam059-fid3</name>
    <tags/>
    <native_guid>FC+BROCADE+10:00:00:05:1E:56:78:42</native_guid>
    <discovered>true</discovered>
    <endpoints>
        <endpoint>10:00:00:00:C9:51:C1:2F</endpoint>
        <endpoint>10:00:00:00:C9:4E:C0:39</endpoint>
        <endpoint>50:06:01:6C:3E:A0:59:B0</endpoint>
    </endpoints>
    <endpoints_discovered>
        <endpoint_discovered>
            <name>10:00:00:00:C9:51:C1:2F</name>
            <value>true</value>
        </endpoint_discovered>
        <endpoint_discovered>
            <name>10:00:00:00:C9:4E:C0:39</name>
            <value>true</value>
        </endpoint_discovered>
        <endpoint_discovered>
            <name>50:06:01:6C:3E:A0:59:B0</name>
            <value>true</value>
        </endpoint_discovered>
    </endpoints_discovered>
    <fabric_id>losam059-fid3</fabric_id>
    <network_systems>
        <network_system>urn:storageos:NetworkSystem:f8cb0945-ca59-4ad2-b7b7-772587da0d6e:</network_system>
        <network_system>urn:storageos:NetworkSystem:e5ab70ee-91b3-43ce-a6ba-48bd15ffb7f2:</network_system>
    </network_systems>
    <registration_status>REGISTERED</registration_status>
    <transport_type>FC</transport_type>
    <varray>
        <id>urn:storageos:VirtualArray:ae316135-5742-4f40-b4b0-8d38d9604917:</id>
        <link href="/vdc/varrays/urn:storageos:VirtualArray:ae316135-5742-4f40-b4b0-8d38d9604917:" rel="self"/>
    </varray>
</network>