
Updates an already present network system by matching the URI. This can be used to change the IP address or port, change the credentials, or update the name of a network sytem. A refresh (discovery) is asynchronously initiated as a result of this call.
id | - the URN of a ViPR NetworkSystem |
Requires one of the following roles:
All parameters are required unless otherwise stated.
Field | Description | Type | Notes |
<network_system_update> | |||
<name> | Name of the Network System | String |
Valid Values:
|
<ip_address> | IP address of the Network System for SSH communication. This field is applicable 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 applicable for network systems of type 'mds'. It is ignored for 'brocade' type network systems and can be null. | Integer |
Valid Values:
|
<user_name> | User name used for SSH login to the Network System. This field is applicable 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 applicable for network systems of type 'mds'. It is ignored for 'brocade' type network systems and can be null. | String | |
<smis_provider_ip> | IP Address of the SMIS Provider This field is applicable 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 applicable for network systems of type 'brocade'. It is ignored for 'mds' type network systems and can be null. | Integer |
Valid Values:
|
<smis_user_name> | User name to connect to the SMIS Provider This field is applicable 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 applicable 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 applicable for network systems of type 'brocade'. It is ignored for 'mds' type network systems and can be null. | Boolean | |
</network_system_update> |
The rest representation for the updated NetworkSystem
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 suspended_error = task is suspended due to an error suspended_no_error = task is suspended due to config/request | String | |
<allowed_operations> | The allowed operations of the task | 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> |
PUT 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> <network_system_update> <name>mds-a</name> <ip_address>192.168.0.2</ip_address> <port_number>22</port_number> <user_name>no-user</user_name> <password>nopass</password> </network_system_update>
HTTP/1.1 200 OK Content-Type: application/xml <task> <op_id>9e3d8548-b533-4bd4-be33-c431d4a0d4a9</op_id> <resource> <id>urn:storageos:NetworkSystem:bdcfc51f-b061-4035-843e-472dfc241edd: </id> <link href="/vdc/network-systems/urn:storageos:NetworkSystem:bdcfc51f-b061-4035-843e-472dfc241edd:" rel="self" /> <name>mds-a</name> </resource> <link href="/vdc/network-systems/urn:storageos:NetworkSystem:bdcfc51f-b061-4035-843e-472dfc241edd:/tasks/9e3d8548-b533-4bd4-be33-c431d4a0d4a9" rel="self" /> <start_time>1380749215883</start_time> <state>pending</state> </task>