Fabric Manager:Get Network System

Search (SHIFT+S)



Get Network System

GET /vdc/network-systems/{id}

Shows the attributes of the network system.

idthe URN of a ViPR network system.

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN
  • SYSTEM_MONITOR

Response Body

A rest representation of the attributes of the network system.

Field Description Type Notes
<network_system>
<ip_address> The system's management IP address String
<port_number> The system's management port Integer Valid Values:
  •  1-65535
<secondary_ip> The system's backup management IP address String
<serial_number> The system's serial number String
<smis_port_number> The SMI-S management port Integer Valid Values:
  •  1-65535
<smis_provider_ip> The IP address of the SMI-S manager for this system String
<smis_user_name> The login name for SMI-S management String
<smis_use_ssl> Whether or not to use SSL when communicating with the SMI-S manager Boolean Valid Values:
  •  true
  •  false
<uptime> How long the system has been running String
<user_name> The login name for managing the system through its console String
<version> The system's software version String
<last_discovery_status_message> The last discovery status message for this system String
<system_type> A short mnemonic that indicates what kind of system is being represented String Valid Values:
  •  brocade
  •  isilon
  •  netapp
  •  mds = Cisco MDS series switch
  •  rp = RecoverPoint
  •  vmax
  •  vnxblock
  •  vnxfile
  •  vplex
<job_discovery_status> The status of the last discovery job for this system String Valid Values:
  •  CREATED
  •  IN_PROGRESS
  •  COMPLETE
  •  ERROR
<last_discovery_run_time> The timestamp for the last discovery job for this system Long
<last_metering_run_time> The timestamp for the last metric collection job for this system Long
<job_metering_status> The status of the last metric collection job for this system String Valid Values:
  •  CREATED
  •  IN_PROGRESS
  •  COMPLETE
  •  ERROR
<next_discovery_run_time> The timestamp for the next scheduled discovery job for this system Long
<next_metering_run_time> The timestamp for the next scheduled metric collection job for this system Long
<success_discovery_time> The latest timestamp when the system run Discovery successfully Long
<success_metering_time> The latest timestamp when the system run Metering successfully Long
<registration_status> Whether or not the system is registered with ViPR. A system must be registered before it can be managed by ViPR. String Valid Values:
  •  REGISTERED
  •  UNREGISTERED
<compatibility_status> Whether or not this system is compatible with ViPR String Valid Values:
  •  COMPATIBLE
  •  INCOMPATIBLE
  •  UNKNOWN
<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
</network_system>

Examples

Request
GET https://192.168.0.0:4443/vdc/network-systems/urn:storageos:NetworkSystem:bdcfc51f-b061-4035-843e-472dfc241edd: HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
Response
HTTP/1.1 200 OK
Content-Type: application/xml
<network_system>
       <creation_time>1380749105100</creation_time>
       <id>urn:storageos:NetworkSystem:bdcfc51f-b061-4035-843e-472dfc241edd:
       </id>
       <inactive>false</inactive>
       <link
              href="/vdc/network-systems/urn:storageos:NetworkSystem:bdcfc51f-b061-4035-843e-472dfc241edd:"
              rel="self" />
       <name>mds-a</name>
       <tags />
       <native_guid>MDS+192.168.0.3+22</native_guid>
       <compatibility_status>INCOMPATIBLE</compatibility_status>
       <job_discovery_status>ERROR</job_discovery_status>
       <last_discovery_run_time>1380749233621</last_discovery_run_time>
       <last_discovery_status_message>Failed to get version: Failed to connect
              to device mds-a : Authorization Failed</last_discovery_status_message>
       <last_metering_run_time>0</last_metering_run_time>
       <job_metering_status>CREATED</job_metering_status>
       <next_discovery_run_time>1380752815912</next_discovery_run_time>
       <next_metering_run_time>0</next_metering_run_time>
       <registration_status>REGISTERED</registration_status>
       <system_type>mds</system_type>
       <ip_address>192.168.0.3</ip_address>
       <port_number>22</port_number>
       <smis_use_ssl>false</smis_use_ssl>
       <user_name>no-user</user_name>
</network_system>
Notes: