vCenter:Create Vcenter

Search (SHIFT+S)

API Reference


Create Vcenter

POST /compute/vcenters

Creates a new vCenter. Discovery is initiated after the vCenter is created.


Query Parameters

validate_connectionspecifies if the connection to the vCenter to be validated before creating the vCenter or not. Default value is "false", so connection to the vCenter will not be validated if it is not specified.
discover_vcenter

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN
  • TENANT_ADMIN

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<vcenter_create>
<ip_address> The IP address or host name of the vCenter. String
<name> The user label for this vCenter String
<port_number> The integer port number of the vCenter management interface. min=1, max= 65535 Integer Valid Values:
  •  Range: 1..65535
<user_name> The user credential used to login to the vCenter. String
<password> The password credential used to login to the vCenter. String
<use_ssl> A flag indicating whether SSL should be used to communicate 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
</vcenter_create>

Response Body

The vCenter discovery async task.

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 Valid values: queued = task is queued pending = task is pending ready = task succeed error = task fails String
<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>      
<queuedStartTime> DateTime
<queueName> 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
</task>
Notes: