
Updates one or more of the vCenter attributes. Discovery is initiated after the vCenter is updated.
id | the URN of a ViPR vCenter |
validate_connection | |
discover_vcenter |
Requires one of the following roles:
All parameters are required unless otherwise stated.
Field | Description | Type | Notes |
<vcenter_update> | |||
<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:
|
<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_update> |
The vCenter 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 Valid values: queued = task is queued pending = task is pending ready = task succeed error = task fails suspended_error = task is suspended due to an error suspended_no_error = task is suspended due to config/request | String | |
<allowed_operations> | The allowed operations of the task | 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> |
PUT https://192.168.0.0:4443/compute/vcenters/urn:storageos:Vcenter:ca83f754-6cff-4384-9458-e27783b31940: HTTP/1.1 Content-Type: application/xml X-SDS-AUTH-TOKEN: <AUTH_TOKEN> <vcenter_update> <name>vCenter_west</name> </vcenter_update>
HTTP/1.1 202 Accepted Content-Type: application/xml <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <task> <message>Operation completed successfully</message> <op_id>338ec6da-80b9-4c35-93d8-fa8298bf27c6</op_id> <resource> <id>urn:storageos:Vcenter:ca83f754-6cff-4384-9458-e27783b31940:</id> <link href="/compute/vcenters/urn:storageos:Vcenter:ca83f754-6cff-4384-9458-e27783b31940:" rel="self"/> <name>vCenter_west</name> </resource> <link href="/compute/vcenters/urn:storageos:Vcenter:ca83f754-6cff-4384-9458-e27783b31940:/tasks/338ec6da-80b9-4c35-93d8-fa8298bf27c6" rel="self"/> <start_time>1379648609875</start_time> <state>ready</state> </task>