Fabric Manager:Create Network System

Search (SHIFT+S)

API Reference


Create Network System

POST /vdc/network-systems

Creates a new network system. This can either represent an SSH connection to a Cisco MDS or Nexus switch, or an SMI-S connection to the Brocade Network Advisor. The call will return before communication has been established, but discovery of the device will be initiated.


Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN
  • RESTRICTED_SYSTEM_ADMIN

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<network_system_create>
<name> Name of the Network System String Valid Values:
  •  Length: 2..128
<ip_address> IP address of the Network System for SSH communication. This field is required for network systems of type 'mds'. It is ignored for 'brocade' type network systems and can be null. String
<port_number> Port number of the Network System for SSH communication. This field is required for network systems of type 'mds'. It is ignored for 'brocade' type network systems and can be null. Integer Valid Values:
  •  Range: 1..65535
<user_name> User name used for SSH login to the Network System. This field is required for network systems of type 'mds'. It is ignored for 'brocade' type network systems and can be null. String
<password> Password used for SSH login to the Network System. This field is required for network systems of type 'mds'. It is ignored for 'brocade' type network systems and can be null. String
<system_type> Type of the Network System Valid values: brocade mds String
<smis_provider_ip> IP Address of the SMIS Provider This field is required for network systems of type 'brocade'. It is ignored for 'mds' type network systems and can be null. String
<smis_port_number> Port number of the SMIS Provider to connect to This field is required for network systems of type 'brocade'. It is ignored for 'mds' type network systems and can be null. Integer Valid Values:
  •  Range: 1..65535
<smis_user_name> User name to connect to the SMIS Provider This field is required for network systems of type 'brocade'. It is ignored for 'mds' type network systems and can be null. String
<smis_password> Password to connect to the SMIS provider This field is required for network systems of type 'brocade'. It is ignored for 'mds' type network systems and can be null. String
<smis_use_ssl> Determines the protocol used for connection purposes. If HTTPS, then set true, else false. This field is required for network systems of type 'brocade'. It is ignored for 'mds' type network systems and can be null. Boolean
</network_system_create>

Response Body

A REST representation of the newly created network device.

This is an asychronous operation that returns a task object. For information on working with tasks, see Asynchronous Operations.

Field Description Type Notes
<task>
<op_id> The task operation id String
<resource>    
<name> The name of the resource String
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</resource>      
<tenant>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</tenant>      
<associated_resources> A list of links for associated resources
<associated_resource>     0-* Elements
<name> The name of the resource String
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</associated_resource>      
</associated_resources>
<state> The state of the task Valid values: queued = task is queued pending = task is pending ready = task succeed error = task fails String
<message> The task detail message String
<description> The description of the task String
<service_error>    
<code> The numerical code associated with the error encountered when processing a service request Integer
<description> The description of the error String
<details> Detailed information concerning the error String
</service_error>      
<start_time> The date and time of when the task was started DateTime
<end_time> The date and time of when the task ended DateTime
<progress> Integer
<workflow>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</workflow>      
<queuedStartTime> DateTime
<queueName> 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
</task>

Examples

Request
POST https://192.168.0.0:4443/vdc/network-systems HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<network_system_create>
   <ip_address>192.168.0.0</ip_address>
   <name>lglw9250</name>
   <password>password</password>
   <port_number>5988</port_number>
   <smis_password>password</smis_password>
   <smis_port_number>5988</smis_port_number>
   <smis_provider_ip>192.168.0.0</smis_provider_ip>
   <smis_use_ssl>false</smis_use_ssl>
   <smis_user_name>administrator</smis_user_name>
   <system_type>brocade</system_type>
   <user_name>administrator</user_name>
</network_system_create>
Response
HTTP/1.1 202 Accepted
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<task>
   <link href="/vdc/network-systems/urn:storageos:NetworkSystem:e470d0b0-ab8f-4ea0-87c9-de6b0ad270bd:/tasks/2dbbd472-7e2e-4af5-a570-a6e595eb2f88"
      rel="self"/>
   <op_id>2dbbd472-7e2e-4af5-a570-a6e595eb2f88</op_id>
   <resource>
      <id>urn:storageos:NetworkSystem:e470d0b0-ab8f-4ea0-87c9-de6b0ad270bd:</id>
      <link href="/vdc/network-systems/urn:storageos:NetworkSystem:e470d0b0-ab8f-4ea0-87c9-de6b0ad270bd:"
         rel="self"/>
      <name>lglw9250</name>
   </resource>
   <start_time>1380164164281</start_time>
   <state>pending</state>
</task>
Notes: