Host:Create Host

Search (SHIFT+S)



Create Host

POST /compute/hosts

Creates a new host for the tenant organization. Discovery is initiated after the host is created.


Query Parameters

validate_connection

Required Roles

  • TENANT_ADMIN

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<host_create>
<type> The host type. String Valid Values:
  •  Windows
  •  HPUX
  •  Linux
  •  Esx
  •  Other
<host_name> The short or fully qualified host name or IP address of the host management interface. String Valid Values:
  •  example: hostname
  •  example: fqdn.hostname.com
  •  example: 10.12.100.200
<os_version> The operating system version of the host. String Valid Values:
  •  example: 8.1
<name> The user label for this host. String Valid Values:
  •  example: host1
  •  Length: 2..128
<port_number> The integer port number of the host management interface. Integer Valid Values:
  •  Range: 1..65535
<user_name> The user name used to log in to the host. String Valid Values:
  •  example: user1
<password> The password credential used to login to the host. String Valid Values:
  •  example: abc1
<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
<cluster> The URI of the cluster if the host is in a cluster. URI Valid Values:
  •  example: urn:storageos:Cluster:6cfe6999-1095-48f0-af1a-31827fe6ea7d:
<vcenter_data_center> The URI of a vCenter data center if the host is an ESX host in a data center. URI Valid Values:
  •  example: urn:storageos:VcenterDataCenter:32cf44c5-7147-48db-b28a-1a321dfeab59:
<project> This field is currently not used. Any values passed into it will be ignored. URI Valid Values:
  •  example: urn:storageos:Project:dd672a52-0591-4f48-b1bc-3c0fba4a26ff:
<discoverable> Gets the discoverable flag. Discoverable indicates if automatic discovery should be performed against this host. Defaults to true. Boolean Valid Values:
  •  true = discovery is enabled
  •  false = discovery is disabled
<tenant> The URI of the tenant owning the host. URI Valid Values:
  •  example: urn:storageos:TenantOrg:45baad25-ff81-4c67-9db5-91df44cb1312:global
<boot_volume> URI
</host_create>

Response Body

The host discovery async task representation.

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: