organization_virtual_data_center_edge_gateways

Creates, updates, deletes, gets or lists an organization_virtual_data_center_edge_gateways resource.

Overview

Name	organization_virtual_data_center_edge_gateways
Type	Resource
Id	ovh.vmware_cloud_director.organization_virtual_data_center_edge_gateways

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Universal Unique identifier
current_state	object	Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied. (wire: currentState)
current_tasks	array	Asynchronous operations ongoing on the organization Virtual DataCenter edge gateway (wire: currentTasks)
resource_status	string	Reflects the readiness of the organization Virtual DataCenter edge gateway resource. A new target specification request will be accepted only in READY status. (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)
target_spec	object	New target specification for the VMware Cloud Director organization edge gateway (wire: targetSpec)
updated_at	string (date-time)	Date and time this resource was last modified (wire: updatedAt)

list

Organization Virtual DataCenter edge gateway resource

Name	Datatype	Description
id	string (uuid)	Universal Unique identifier
current_state	object	Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied. (wire: currentState)
current_tasks	array	Asynchronous operations ongoing on the organization Virtual DataCenter edge gateway (wire: currentTasks)
resource_status	string	Reflects the readiness of the organization Virtual DataCenter edge gateway resource. A new target specification request will be accepted only in READY status. (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)
target_spec	object	New target specification for the VMware Cloud Director organization edge gateway (wire: targetSpec)
updated_at	string (date-time)	Date and time this resource was last modified (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	edge_gateway_id, organization_id, virtual_data_center_id		Returns the edge gateway: name, deployment mode, provider gateway and VMware Cloud Director ID.
list	select	organization_id, virtual_data_center_id	x_pagination_cursor, x_pagination_size	Returns the edge gateways of the virtual datacenter.
create	insert	organization_id, virtual_data_center_id, target_spec		Creates an edge gateway in the virtual datacenter, with the name given in targetSpec.
update	update	edge_gateway_id, organization_id, virtual_data_center_id, target_spec		Renames the edge gateway. Accepted only when the edge gateway is READY, then applied asynchronously: currentState catches up with targetSpec.
delete	delete	edge_gateway_id, organization_id, virtual_data_center_id		Deletes the edge gateway from the virtual datacenter.

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"}})
edge_gateway_id	string (uuid)	Edge gateway ID (wire: edgeGatewayId)
organization_id	string	Organization ID (wire: organizationId)
virtual_data_center_id	string	Virtual data center ID (wire: virtualDataCenterId)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Returns the edge gateway: name, deployment mode, provider gateway and VMware Cloud Director ID.

SELECT
id,
current_state,
current_tasks,
resource_status,
target_spec,
updated_at
FROM ovh.vmware_cloud_director.organization_virtual_data_center_edge_gateways
WHERE edge_gateway_id = '{{ edge_gateway_id }}' -- required
AND organization_id = '{{ organization_id }}' -- required
AND virtual_data_center_id = '{{ virtual_data_center_id }}' -- required
;

list

Returns the edge gateways of the virtual datacenter.

SELECT
id,
current_state,
current_tasks,
resource_status,
target_spec,
updated_at
FROM ovh.vmware_cloud_director.organization_virtual_data_center_edge_gateways
WHERE organization_id = '{{ organization_id }}' -- required
AND virtual_data_center_id = '{{ virtual_data_center_id }}' -- required
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;

INSERT examples

create

Creates an edge gateway in the virtual datacenter, with the name given in targetSpec.

INSERT INTO ovh.vmware_cloud_director.organization_virtual_data_center_edge_gateways (
target_spec,
organization_id,
virtual_data_center_id
)
SELECT 
'{{ target_spec }}' /* required */,
'{{ organization_id }}',
'{{ virtual_data_center_id }}'
RETURNING
id,
current_state,
current_tasks,
resource_status,
target_spec,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: organization_virtual_data_center_edge_gateways
props:
  - name: organization_id
    value: "{{ organization_id }}"
    description: Required parameter for the organization_virtual_data_center_edge_gateways resource.
  - name: virtual_data_center_id
    value: "{{ virtual_data_center_id }}"
    description: Required parameter for the organization_virtual_data_center_edge_gateways resource.
  - name: target_spec
    description: |
      New target specification for the VMware Cloud Director organization edge gateway
    value:
      name: "{{ name }}"

UPDATE examples

update

Renames the edge gateway. Accepted only when the edge gateway is READY, then applied asynchronously: currentState catches up with targetSpec.

UPDATE ovh.vmware_cloud_director.organization_virtual_data_center_edge_gateways
SET 
target_spec = '{{ target_spec }}'
WHERE 
edge_gateway_id = '{{ edge_gateway_id }}' --required
AND organization_id = '{{ organization_id }}' --required
AND virtual_data_center_id = '{{ virtual_data_center_id }}' --required
AND target_spec = '{{ target_spec }}' --required
RETURNING
id,
current_state,
current_tasks,
resource_status,
target_spec,
updated_at;

DELETE examples

delete

Deletes the edge gateway from the virtual datacenter.

DELETE FROM ovh.vmware_cloud_director.organization_virtual_data_center_edge_gateways
WHERE edge_gateway_id = '{{ edge_gateway_id }}' --required
AND organization_id = '{{ organization_id }}' --required
AND virtual_data_center_id = '{{ virtual_data_center_id }}' --required
;