dedicated_clouds

Creates, updates, deletes, gets or lists a dedicated_clouds resource.

Overview

Name	dedicated_clouds
Type	Resource
Id	ovh.dedicated_cloud.dedicated_clouds

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
service_name	string	Service name of your VMware on OVHcloud (wire: serviceName)
service_pack_name	string	Name of the current service pack (wire: servicePackName)
advanced_security	boolean	Advanced security state (wire: advancedSecurity)
bandwidth	string	The current bandwidth of your VMware on OVHcloud
billing_type	string	Billing type of your VMware on OVHcloud (demo, monthly) (wire: billingType)
can_migrate_to_vcd	boolean	Can the PCC be migrated to VCD (wire: canMigrateToVCD)
certified_interface_url	string	Url to the VMware on OVHcloud certified interface (wire: certifiedInterfaceUrl)
commercial_range	string	The current version of your VMware on OVHcloud (wire: commercialRange)
description	string	Description of your VMware on OVHcloud
generation	string	Generation of your VMware on OVHcloud (1.0, 2.0)
iam	object	IAM resource metadata
location	string	Datacenter where your VMware on OVHcloud is physically located
management_interface	string	The management interface name (azure, openstack, systemcenter, vcloud, vcsa, vsphere) (wire: managementInterface)
product_reference	string	The reference universe information for your VMware on OVHcloud (EPCC, MBM) (wire: productReference)
spla	boolean	SPLA licensing state
ssl_v3	boolean	Enable SSL v3 support. Warning : this option is not recommended as it was recognized as a security breach. If this is enabled, we advise you to enable the filtered User access policy (wire: sslV3)
state	string	Current state of your VMware on OVHcloud (available, delivered, disabled, disabling, error, migrating, provisionning, recycling, reserved, toDisable, toProvision, toRecycle, toRemove, toUnprovision, unprovisionning, upgrading)
user_access_policy	string	Access policy of your VMware on OVHcloud : opened to every IPs or filtered (filtered, open) (wire: userAccessPolicy)
user_limit_concurrent_session	integer	The maximum amount of connected users allowed on the VMware on OVHcloud management interface (wire: userLimitConcurrentSession)
user_logout_policy	string	Which user will be disconnected first in case of quota of maximum connection is reached (first, last) (wire: userLogoutPolicy)
user_session_timeout	integer	The timeout (in seconds) for the user sessions on the VMware on OVHcloud management interface. 0 value disable the timeout (wire: userSessionTimeout)
v_scope_url	string	Url to the VMware on OVHcloud vScope interface (wire: vScopeUrl)
version	object	Version of the management interface
web_interface_url	string	Url to the VMware on OVHcloud web interface (wire: webInterfaceUrl)

list

VMware on OVHcloud

Name	Datatype	Description
service_name	string	Service name of your VMware on OVHcloud (wire: serviceName)
service_pack_name	string	Name of the current service pack (wire: servicePackName)
advanced_security	boolean	Advanced security state (wire: advancedSecurity)
bandwidth	string	The current bandwidth of your VMware on OVHcloud
billing_type	string	Billing type of your VMware on OVHcloud (demo, monthly) (wire: billingType)
can_migrate_to_vcd	boolean	Can the PCC be migrated to VCD (wire: canMigrateToVCD)
certified_interface_url	string	Url to the VMware on OVHcloud certified interface (wire: certifiedInterfaceUrl)
commercial_range	string	The current version of your VMware on OVHcloud (wire: commercialRange)
description	string	Description of your VMware on OVHcloud
generation	string	Generation of your VMware on OVHcloud (1.0, 2.0)
iam	object	IAM resource metadata
location	string	Datacenter where your VMware on OVHcloud is physically located
management_interface	string	The management interface name (azure, openstack, systemcenter, vcloud, vcsa, vsphere) (wire: managementInterface)
product_reference	string	The reference universe information for your VMware on OVHcloud (EPCC, MBM) (wire: productReference)
spla	boolean	SPLA licensing state
ssl_v3	boolean	Enable SSL v3 support. Warning : this option is not recommended as it was recognized as a security breach. If this is enabled, we advise you to enable the filtered User access policy (wire: sslV3)
state	string	Current state of your VMware on OVHcloud (available, delivered, disabled, disabling, error, migrating, provisionning, recycling, reserved, toDisable, toProvision, toRecycle, toRemove, toUnprovision, unprovisionning, upgrading)
user_access_policy	string	Access policy of your VMware on OVHcloud : opened to every IPs or filtered (filtered, open) (wire: userAccessPolicy)
user_limit_concurrent_session	integer	The maximum amount of connected users allowed on the VMware on OVHcloud management interface (wire: userLimitConcurrentSession)
user_logout_policy	string	Which user will be disconnected first in case of quota of maximum connection is reached (first, last) (wire: userLogoutPolicy)
user_session_timeout	integer	The timeout (in seconds) for the user sessions on the VMware on OVHcloud management interface. 0 value disable the timeout (wire: userSessionTimeout)
v_scope_url	string	Url to the VMware on OVHcloud vScope interface (wire: vScopeUrl)
version	object	Version of the management interface
web_interface_url	string	Url to the VMware on OVHcloud web interface (wire: webInterfaceUrl)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Get a Managed VMware vSphere service. Returns the service: state, version, location, access and session policies, and management interface URLs.
list	select		iam_tags, x_pagination_mode	List Managed VMware vSphere services. Returns the names of your services. Filter by IAM tags with iamTags.
change_contact	exec	serviceName		Change service contacts. Starts a procedure to change the admin, tech or billing contact of the service.
change_properties	exec	serviceName		Update the service. Updates the description, access policy, logout policy, session timeout, concurrent session limit and SSL v3 support of the service. Returns a task to track progress.
confirm_termination	exec	serviceName, token		Confirm service termination. Terminates the service with the token sent by email to the admin contact. A reason, a future use and a comment can be given.
generate_nsxv_inventory	exec	serviceName		Generate an NSX-V inventory
generate_vxlan_to_vrack_mapping	exec	serviceName		Generate a VXLAN to vRack mapping. Generates the mapping between the NSX-V VXLANs and the vRack. Returns a task to track progress.
log_url	exec	serviceName, kind		Generate a log URL. Returns a temporary URL to read the logs of a kind in real time, with its expiration date.
order_new_filer_hourly	exec	serviceName, name		Order an hourly global datastore. Orders a datastore billed by the hour, mounted on all datacenters of the service. Returns a task to track progress.
reset_triggered_alarm	exec	serviceName		Reset triggered alarms. Resets all triggered alarms of the hypervisor. Returns a task to track progress.
terminate	exec	serviceName		Request service termination. Starts the termination of the service. The admin contact receives a token by email, to confirm with the confirmTermination call.
upgrade_vcenter	exec	serviceName		Upgrade vCenter. Upgrades vCenter to the next minor version by default, or to the next major version with release. Returns a task to track progress.
vmware_cloud_director_eligibility	exec	serviceName		Check VCD migration eligibility. Checks whether the service can migrate to VMware Cloud Director. 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)
iam_tags	object	Filter resources on IAM tags (wire: iamTags)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get a Managed VMware vSphere service. Returns the service: state, version, location, access and session policies, and management interface URLs.

SELECT
service_name,
service_pack_name,
advanced_security,
bandwidth,
billing_type,
can_migrate_to_vcd,
certified_interface_url,
commercial_range,
description,
generation,
iam,
location,
management_interface,
product_reference,
spla,
ssl_v3,
state,
user_access_policy,
user_limit_concurrent_session,
user_logout_policy,
user_session_timeout,
v_scope_url,
version,
web_interface_url
FROM ovh.dedicated_cloud.dedicated_clouds
WHERE service_name = '{{ service_name }}' -- required
;

list

List Managed VMware vSphere services. Returns the names of your services. Filter by IAM tags with iamTags.

SELECT
service_name,
service_pack_name,
advanced_security,
bandwidth,
billing_type,
can_migrate_to_vcd,
certified_interface_url,
commercial_range,
description,
generation,
iam,
location,
management_interface,
product_reference,
spla,
ssl_v3,
state,
user_access_policy,
user_limit_concurrent_session,
user_logout_policy,
user_session_timeout,
v_scope_url,
version,
web_interface_url
FROM ovh.dedicated_cloud.dedicated_clouds
WHERE iam_tags = '{{ iam_tags }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

change_contact

Change service contacts. Starts a procedure to change the admin, tech or billing contact of the service.

EXEC ovh.dedicated_cloud.dedicated_clouds.change_contact 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"contactAdmin": "{{ contactAdmin }}", 
"contactBilling": "{{ contactBilling }}", 
"contactTech": "{{ contactTech }}"
}'
;

change_properties

Update the service. Updates the description, access policy, logout policy, session timeout, concurrent session limit and SSL v3 support of the service. Returns a task to track progress.

EXEC ovh.dedicated_cloud.dedicated_clouds.change_properties 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"description": "{{ description }}", 
"sslV3": {{ sslV3 }}, 
"userAccessPolicy": "{{ userAccessPolicy }}", 
"userLimitConcurrentSession": {{ userLimitConcurrentSession }}, 
"userLogoutPolicy": "{{ userLogoutPolicy }}", 
"userSessionTimeout": {{ userSessionTimeout }}
}'
;

confirm_termination

Confirm service termination. Terminates the service with the token sent by email to the admin contact. A reason, a future use and a comment can be given.

EXEC ovh.dedicated_cloud.dedicated_clouds.confirm_termination 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"commentary": "{{ commentary }}", 
"futureUse": "{{ futureUse }}", 
"reason": "{{ reason }}", 
"token": "{{ token }}"
}'
;

generate_nsxv_inventory

Generate an NSX-V inventory

EXEC ovh.dedicated_cloud.dedicated_clouds.generate_nsxv_inventory 
@serviceName='{{ serviceName }}' --required
;

generate_vxlan_to_vrack_mapping

Generate a VXLAN to vRack mapping. Generates the mapping between the NSX-V VXLANs and the vRack. Returns a task to track progress.

EXEC ovh.dedicated_cloud.dedicated_clouds.generate_vxlan_to_vrack_mapping 
@serviceName='{{ serviceName }}' --required
;

log_url

Generate a log URL. Returns a temporary URL to read the logs of a kind in real time, with its expiration date.

EXEC ovh.dedicated_cloud.dedicated_clouds.log_url 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"kind": "{{ kind }}"
}'
;

order_new_filer_hourly

Order an hourly global datastore. Orders a datastore billed by the hour, mounted on all datacenters of the service. Returns a task to track progress.

EXEC ovh.dedicated_cloud.dedicated_clouds.order_new_filer_hourly 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"name": "{{ name }}"
}'
;

reset_triggered_alarm

Reset triggered alarms. Resets all triggered alarms of the hypervisor. Returns a task to track progress.

EXEC ovh.dedicated_cloud.dedicated_clouds.reset_triggered_alarm 
@serviceName='{{ serviceName }}' --required
;

terminate

Request service termination. Starts the termination of the service. The admin contact receives a token by email, to confirm with the confirmTermination call.

EXEC ovh.dedicated_cloud.dedicated_clouds.terminate 
@serviceName='{{ serviceName }}' --required
;

upgrade_vcenter

Upgrade vCenter. Upgrades vCenter to the next minor version by default, or to the next major version with release. Returns a task to track progress.

EXEC ovh.dedicated_cloud.dedicated_clouds.upgrade_vcenter 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"release": "{{ release }}"
}'
;

vmware_cloud_director_eligibility

Check VCD migration eligibility. Checks whether the service can migrate to VMware Cloud Director. Returns a task to track progress.

EXEC ovh.dedicated_cloud.dedicated_clouds.vmware_cloud_director_eligibility 
@serviceName='{{ serviceName }}' --required
;