EMC ViPR REST API

Search (SHIFT+S)

API Reference


Get Vcenter

GET /compute/vcenters/{id}

Shows the information for one vCenter server.

idthe URN of a ViPR vCenter

Required Roles

This call has no restrictions.


Response Body

All non-null attributes of the vCenter.

Field Description Type Notes
<vcenter>
<user_name> The login account name String
<ip_address> The vCenter server management IP address String
<port_number> The vCenter server management port Integer
<use_ssl> A flag which indicates whether SSL should be used when communicating with the vCenter Boolean
<os_version> The operating system version of the vcenter. String
<cascade_tenancy> A flag indicating whether to cascade the vCenter tenancy to all its datacenters and its clusters and hosts or not. If cascaded vCenter can belong to only one tenant. Valid values: true = cascades the vCenter tenancy to the datacenters and its hosts and clusters. false = does not cascase Boolean
<tenant>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</tenant>      
<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
</vcenter>