organization_ip_spaces

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

Overview

Name	organization_ip_spaces
Type	Resource
Id	ovh.vmware_cloud_director.organization_ip_spaces

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 IP Space (wire: currentTasks)
resource_status	string	Reflects the readiness of the organization IP Space 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 IP space (wire: targetSpec)
updated_at	string (date-time)	Date and time this resource was last modified (wire: updatedAt)

list

VMware Cloud Director organization IP Space 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 IP Space (wire: currentTasks)
resource_status	string	Reflects the readiness of the organization IP Space 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 IP space (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	ip_space_id, organization_id		Returns the IP space: name, internal scope and associated edge gateway.
list	select	organization_id	x_pagination_cursor, x_pagination_size	Returns the IP spaces of the organization.
update	update	ip_space_id, organization_id, target_spec		Renames the IP space or associates it with another edge gateway. Accepted only when the IP space is READY, then applied asynchronously: currentState catches up with targetSpec.

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"}})
ip_space_id	string (uuid)	Ip space ID (wire: ipSpaceId)
organization_id	string	Organization ID (wire: organizationId)
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 IP space: name, internal scope and associated edge gateway.

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

list

Returns the IP spaces of the organization.

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

UPDATE examples

update

Renames the IP space or associates it with another edge gateway. Accepted only when the IP space is READY, then applied asynchronously: currentState catches up with targetSpec.

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