organizations

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

Overview

Name	organizations
Type	Resource
Id	ovh.vmware_cloud_director.organizations

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	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 VMware Cloud Director organization (wire: currentTasks)
iam	object	IAM resource metadata
resource_status	string	Reflects the readiness of the VMware Cloud Director organization. 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	Configuration you requested. While a change is still being applied it differs from currentState. (wire: targetSpec)
updated_at	string (date-time)	Date and time this resource was last modified (wire: updatedAt)

list

VMware Cloud Director organization service

Name	Datatype	Description
id	string	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 VMware Cloud Director organization (wire: currentTasks)
iam	object	IAM resource metadata
resource_status	string	Reflects the readiness of the VMware Cloud Director organization. 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	Configuration you requested. While a change is still being applied it differs from currentState. (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	organization_id		Returns the organization: name, region, billing type, API and web interface URLs, and requested specification.
list	select		x_pagination_cursor, x_pagination_size, iam_tags	Returns the organizations, with their state and specification.
update	update	organization_id, target_spec		Updates the full name and description of the organization. Accepted only when the organization is READY, then applied asynchronously: currentState catches up with targetSpec.
password	exec	organizationId		Resets the password of the organization administrator. The new password is sent by email to the admin contact.

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"}})
organizationId	string	Organization ID
organization_id	string	Organization ID (wire: organizationId)
iam_tags	object	Filter resources on IAM tags (wire: iamTags)
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 organization: name, region, billing type, API and web interface URLs, and requested specification.

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

list

Returns the organizations, with their state and specification.

SELECT
id,
current_state,
current_tasks,
iam,
resource_status,
target_spec,
updated_at
FROM ovh.vmware_cloud_director.organizations
WHERE x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
AND iam_tags = '{{ iam_tags }}'
;

UPDATE examples

update

Updates the full name and description of the organization. Accepted only when the organization is READY, then applied asynchronously: currentState catches up with targetSpec.

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

Lifecycle Methods

EXEC variables use wire (API) names.

password

Resets the password of the organization administrator. The new password is sent by email to the admin contact.

EXEC ovh.vmware_cloud_director.organizations.password 
@organizationId='{{ organizationId }}' --required
;