EMC ViPR REST API

Search (SHIFT+S)

API Reference


Get Storage System

GET /vdc/storage-providers/{id}/storage-systems/{systemId}

Allows the user to get data for the storage system with the passed system id that is associated with the storage provider with the passed provider id.

idthe URN of a ViPR Storage provider
systemIdThe id of the storage system.

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN
  • SYSTEM_MONITOR

Response Body

A StorageSystemRestRep reference specifying the data for the storage system.

Field Description Type Notes
<storage_system>
<active_provider_uri>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</active_provider_uri>      
<associated_systems>
<associated_system> String 0-* Elements
</associated_systems>
<export_masks>
<export_mask>     0-* Elements
<name> String
<value> String
</export_mask>      
</export_masks>
<firmware_version> String
<ip_address> String
<major_version> String
<minor_version> String
<model> String
<port_number> Integer
<protocols>
<protocol> String 0-* Elements
</protocols>
<smis_providers>
<smis_provider>     0-* Elements
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</smis_provider>      
</smis_providers>
<reachable> Boolean
<secondary_ips>
<secondary_ip> String 0-* Elements
</secondary_ips>
<serial_number> String
<smis_port_number> Integer
<smis_provider_ip> String
<smis_use_ssl> Boolean
<user_name> String
<supported_provisioning_type> String
<async_actions>
<async_action> String 0-* Elements
</async_actions>
<smis_user_name> String
<smis_connection_status> String
<max_resources> Integer
<num_resources> Integer
<supported_replication_types>
<supported_replication_type> String 0-* Elements
</supported_replication_types>
<connected_systems>
<connected_system> String 0-* Elements
</connected_systems>
<srdf_active_ra_groups_exist> Boolean
<average_port_metrics> Double
<supports_soft_limit> Boolean
<supports_notification_limit> Boolean
<job_arrayaffinity_status> The status of the last array affinity job for this system Valid values: CREATED IN_PROGRESS COMPLETE ERROR String
<last_arrayaffinity_status_message> The last array affinity status message for this system String
<last_arrayaffinity_run_time> The timestamp for the last array affinity job for this system Long
<next_arrayaffinity_run_time> The timestamp for the next scheduled array affinity job for this system Long
<success_arrayaffinity_time> The latest timestamp when the system run array affinity job successfully Long
<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. Valid values: brocade isilon netapp mds = Cisco MDS series swicth rp = Recoverpoint vmax vnxblock vnxfile vplex String
<job_discovery_status> The status of the last discovery job for this system Valid values: CREATED IN_PROGRESS COMPLETE ERROR String
<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 Valid values: CREATED IN_PROGRESS COMPLETE ERROR String
<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. Valid values: REGISTERED UNREGISTERED String
<compatibility_status> Whether or not this system is compatible with ViPR. Valid values: OMPATIBLE INCOMPATIBLE UNKNOWN String
<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
Valid values: Network NetworkSystem StoragePool StoragePort StorageSystem StorageTier:VMAX StorageTier: VNX
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_system>