EMC ViPR REST API

Search (SHIFT+S)

API Reference


Get Storage Provider

GET /vdc/storage-providers/{id}

This call allows user to fetch Storage Provider details such as provider host access credential details.

idStorage Provider Identifier

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN
  • SYSTEM_MONITOR

Response Body

Storage Provider details.

Field Description Type Notes
<storage_provider>
<connection_status> Status of the connection. Valid values: CONNECTED NOTCONNECTED String
<description> Information relevant to the provider software. String
<interface> Intarface type String
<ip_address> provider's IP address. String
<manufacturer> Name of the manufacturer. String
<port_number> The port number used to connect with the provider, typically 5988 or 5989. Integer
<provider_id> A combination of the provider's IP address and the port number, used as an ID. String
<storage_systems>
<storage_system>     0-* Elements
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</storage_system>      
</storage_systems>
<user_name> Login credential at the provider. String
<use_ssl> Whether or not secure SSL connection is used. Boolean
<version_string> provider software revision number. String
<job_scan_status> Status of the provider scan job. Valid values: CREATED IN_PROGRESS COMPLETE ERROR String
<last_scan_status_message> Status message from the last scan. String
<last_scan_time> Time the last scan occurred. Long
<next_scan_time> Time for which the next scan job is scheduled. Long
<success_scan_time> The latest timestamp when the system run scanning successfully Long
<registration_status> Registration status of the provider Valid values: REGISTERED UNREGISTERED String
<compatibility_status> Whether or not the provider software is compatible with ViPR. Valid values: COMPATIBLE INCOMPATIBLE UNKNOWN String
<secondary_username> Username for an optional, secondary credential String
<secondary_url> URL of the Management system that is associated with the Provider. String
<element_manager_url> URL of the Element Management system that is associated with the Provider. 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
</storage_provider>