SMIS Provider:Update Storage System

Search (SHIFT+S)



Update Storage System

PUT /vdc/smis-providers/storage-systems/{system_id}
This call has been deprecated and will be removed in future versions

Allows the user to update credentials for a storage system that is not connected to any SMIS Provider. This update call is applicable to systems that cannot be discovered via an SMI-S provider. This API call creates an asynchronous operation to add providers to the SMI-S provider, verifies that the storage system is visible through the provider, and performs discovery of the storage system Note: only vnxblock can be actively connected to the SMIS provider. VMAX skips this step, the system must be visible to the SMIS provider beforehand.

idthe URN of a ViPR SMI-S provider

Required Roles

  • SYSTEM_ADMIN

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<storage_smisprovider_update>
<system_type> Type of the storage system String Valid Values:
  •  isilon
  •  vnxblock
  •  vnxfile
  •  vmax
  •  netapp
  •  vplex
  •  mds
  •  brocade
  •  rp
<_name> User Defined Name of the storage system String
<ip_address> IP Address of the storage system String
<secondary_ips>
<secondary_ip> String 0-* Elements
</secondary_ips>
<port_number> Port Number used to connect to the storage system Integer
<user_name> Username to connect to storage system String
<password> Password to connect to storage system String
<serial_number> Serial ID of the storage system String
<providers> List of SMI-S Providers managing this storage system
<provider> URI 0-* Elements
</providers>
</storage_smisprovider_update>

Response Body

A TaskResourceRep reference specifying the storage system data.

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 String Valid Values:
  •  pending = task is pending
  •  ready = task succeed
  •  error = task fails
<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>      
<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
</task>
Notes: