Host:Get Host

Search (SHIFT+S)



Get Host

GET /compute/hosts/{id}

Gets the information for one host.

idthe URN of a ViPR Host

Required Roles

This call has no restrictions.


Response Body

All the non-null attributes of the host.

Field Description Type Notes
<host>
<cluster>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</cluster>      
<host_name> The host name. String
<os_version> The operating system version of the host. String
<port_number> The host management port number. Integer
<project>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</project>      
<compute_element>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</compute_element>      
<type> The host type. String
<user_name> The login account name. String
<use_ssl> The boolean flag that indicates if SSL should be used when communicating with the host. Boolean Valid Values:
  •  true = use SSL
  •  false = do not use SSL
<vcenter_data_center>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</vcenter_data_center>      
<discoverable> Gets the discoverable flag. Discoverable indicates if automatic discovery should be performed against this host. Boolean Valid Values:
  •  true = discovery is enabled
  •  false = discovery is disabled
<boot_volume>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</boot_volume>      
<provisioning_job_status> The state of the most recent provisioning Job (can be one of these values : IN_PROGRESS / COMPLETE / ERROR. These statuses correspond to the task status, which can be pending,ready or error. String
<tenant>     Valid Values:
  •  String
<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 String Valid Values:
  •  brocade
  •  isilon
  •  netapp
  •  mds = Cisco MDS series switch
  •  rp = RecoverPoint
  •  vmax
  •  vnxblock
  •  vnxfile
  •  vplex
<job_discovery_status> The status of the last discovery job for this system String Valid Values:
  •  CREATED
  •  IN_PROGRESS
  •  COMPLETE
  •  ERROR
<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 String Valid Values:
  •  CREATED
  •  IN_PROGRESS
  •  COMPLETE
  •  ERROR
<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. String Valid Values:
  •  REGISTERED
  •  UNREGISTERED
<compatibility_status> Whether or not this system is compatible with ViPR String Valid Values:
  •  COMPATIBLE
  •  INCOMPATIBLE
  •  UNKNOWN
<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
String Valid Values:
  •  Network : transport-type+network-system-type+fabric-WWN
  •  NetworkSystem: network-system-type+management-IP-address+management-port
  •  StoragePool : storage-system-type+storage-system-serial-number+POOL+pool-native-id
  •  StoragePort : storage-system-type+storage-system-serial-number+PORT+port-network-id
  •  StorageSystem: storage-system-type+serial-number
  •  StorageTier, Auto-Tiering: storage-system-type+storage-system-serial-number+FASTPOLICY+policy-name
  •  StorageTier, VMAX: storage-system-type+storage-system-serial-number+TIER+tier-name
  •  StorageTier, VNX: storage-system-type+storage-system-serial-number+TIER+pool-name+tier-name
<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
</host>

Examples

Request
GET https://192.168.0.0:4443/compute/hosts/urn:storageos:Host:2d946e9f-af2f-410e-b001-5ced40773871: HTTP/1.1
 
Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
Response
HTTP/1.1 200 OK
Content-Type: application/xml
 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <host>
       <creation_time>1379169835921</creation_time>
       <id>urn:storageos:Host:2d946e9f-af2f-410e-b001-5ced40773871:</id>
       <inactive>false</inactive>
       <link href="/compute/hosts/urn:storageos:Host:2d946e9f-af2f-410e-b001-5ced40773871:" rel="self"/>
       <name>wjehost1</name>
       <tags/>
       <native_guid></native_guid>
       <compatibility_status>UNKNOWN</compatibility_status>
       <job_discovery_status>ERROR</job_discovery_status>
       <last_discovery_run_time>1379859419650</last_discovery_run_time>
       <last_discovery_status_message>Unknown host: wjehost1</last_discovery_status_message>
       <last_metering_run_time>0</last_metering_run_time>
       <job_metering_status>CREATED</job_metering_status>
       <next_discovery_run_time>0</next_discovery_run_time>
       <next_metering_run_time>0</next_metering_run_time>
       <registration_status>REGISTERED</registration_status>
       <tenant>
            <id>urn:storageos:TenantOrg:dbeb4135-e297-40d9-a5d4-9b40c73bdb4b:</id>
            <link href="/tenants/urn:storageos:TenantOrg:dbeb4135-e297-40d9-a5d4-9b40c73bdb4b:" rel="self"/>
       </tenant>
       <cluster>
            <id>urn:storageos:Cluster:85c0e380-6a14-41fe-898b-31b6f1fe0112:</id>
            <link href="/compute/clusters/urn:storageos:Cluster:85c0e380-6a14-41fe-898b-31b6f1fe0112:" rel="self"/>
       </cluster>
       <host_name>wjehost1</host_name>
       <os_version>1.0</os_version>
       <port_number>8111</port_number>
       <type>Windows</type>
       <use_ssl>false</use_ssl>
       <user_name>user</user_name>
  </host>
Notes: