vrops
Creates, updates, deletes, gets or lists a vrops resource.
Overview​
| Name | vrops |
| Type | Resource |
| Id | ovh.dedicated_cloud.vrops |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
state | string | State of the option (disabled, disabling, enabled, enabling, error, migrating, unknown) |
upgrades | array | Available upgrades for Aria Operations |
url | string | Url of Aria Operations interface |
v_r_ops_public_ip | string (ipv4) | VMware Aria Operation public IP (example: 192.0.2.0) (wire: vROpsPublicIP) |
version | string | Version of Aria Operations |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name | Get the Aria Operations option. Returns the state, version, URL, public IP address and available upgrades of the VMware Aria Operations option. | |
upgrade | exec | serviceName | Upgrade Aria Operations. Upgrades Aria Operations to the given version, or to the latest version listed in upgrades when no version is given. Returns a task to track progress. |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
api_host | string | The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}}) |
serviceName | string | Domain of the service |
service_name | string | Domain of the service (wire: serviceName) |
SELECT examples​
- get
Get the Aria Operations option. Returns the state, version, URL, public IP address and available upgrades of the VMware Aria Operations option.
SELECT
state,
upgrades,
url,
v_r_ops_public_ip,
version
FROM ovh.dedicated_cloud.vrops
WHERE service_name = '{{ service_name }}' -- required
;
Lifecycle Methods​
EXEC variables use wire (API) names.
- upgrade
Upgrade Aria Operations. Upgrades Aria Operations to the given version, or to the latest version listed in upgrades when no version is given. Returns a task to track progress.
EXEC ovh.dedicated_cloud.vrops.upgrade
@serviceName='{{ serviceName }}' --required
@@json=
'{
"version": "{{ version }}"
}'
;