private_clouds

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

Overview

Name	private_clouds
Type	Resource
Id	google.vmwareengine.private_clouds

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud
createTime	string (google-datetime)	Output only. Creation time of this resource.
deleteTime	string (google-datetime)	Output only. Time when the resource was scheduled for deletion.
description	string	User-provided description for this private cloud.
expireTime	string (google-datetime)	Output only. Time when the resource will be irreversibly deleted.
hcx	object	Output only. HCX appliance. (id: Hcx)
managementCluster	object	Required. Input only. The management cluster for this private cloud. This field is required during creation of the private cloud to provide details for the default cluster. The following fields can't be changed after private cloud creation: ManagementCluster.clusterId, ManagementCluster.nodeTypeId. (id: ManagementCluster)
networkConfig	object	Required. Network configuration of the private cloud. (id: NetworkConfig)
nsx	object	Output only. NSX appliance. (id: Nsx)
state	string	Output only. State of the resource. New values may be added to this enum when appropriate.
type	string	Optional. Type of the private cloud. Defaults to STANDARD.
uid	string	Output only. System-generated unique identifier for the resource.
updateTime	string (google-datetime)	Output only. Last update time of this resource.
vcenter	object	Output only. Vcenter appliance. (id: Vcenter)

list

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud
createTime	string (google-datetime)	Output only. Creation time of this resource.
deleteTime	string (google-datetime)	Output only. Time when the resource was scheduled for deletion.
description	string	User-provided description for this private cloud.
expireTime	string (google-datetime)	Output only. Time when the resource will be irreversibly deleted.
hcx	object	Output only. HCX appliance. (id: Hcx)
managementCluster	object	Required. Input only. The management cluster for this private cloud. This field is required during creation of the private cloud to provide details for the default cluster. The following fields can't be changed after private cloud creation: ManagementCluster.clusterId, ManagementCluster.nodeTypeId. (id: ManagementCluster)
networkConfig	object	Required. Network configuration of the private cloud. (id: NetworkConfig)
nsx	object	Output only. NSX appliance. (id: Nsx)
state	string	Output only. State of the resource. New values may be added to this enum when appropriate.
type	string	Optional. Type of the private cloud. Defaults to STANDARD.
uid	string	Output only. System-generated unique identifier for the resource.
updateTime	string (google-datetime)	Output only. Last update time of this resource.
vcenter	object	Output only. Vcenter appliance. (id: Vcenter)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, privateCloudsId		Retrieves a PrivateCloud resource by its resource name.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists PrivateCloud resources in a given project and location.
create	insert	projectsId, locationsId	privateCloudId, requestId, validateOnly	Creates a new PrivateCloud resource in a given project and location. Private clouds of type STANDARD and TIME_LIMITED are zonal resources, STRETCHED private clouds are regional. Creating a private cloud also creates a management cluster for that private cloud.
patch	update	projectsId, locationsId, privateCloudsId	updateMask, requestId	Modifies a PrivateCloud resource. Only the following fields can be updated: description. Only fields specified in updateMask are applied. During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.
delete	delete	projectsId, locationsId, privateCloudsId	requestId, force, delayHours	Schedules a PrivateCloud resource for deletion. A PrivateCloud resource scheduled for deletion has PrivateCloud.state set to DELETED and expireTime set to the time when deletion is final and can no longer be reversed. The delete operation is marked as done as soon as the PrivateCloud is successfully scheduled for deletion (this also applies when delayHours is set to zero), and the operation is not kept in pending state until PrivateCloud is purged. PrivateCloud can be restored using UndeletePrivateCloud method before the expireTime elapses. When expireTime is reached, deletion is final and all private cloud resources are irreversibly removed and billing stops. During the final removal process, PrivateCloud.state is set to PURGING. PrivateCloud can be polled using standard GET method for the whole period of deletion and purging. It will not be returned only when it is completely purged.
private_cloud_deletion_now	exec	projectsId, locationsId, privateCloudsId		Accelerates the deletion of a private cloud that is currently in soft deletion A PrivateCloud resource in soft deletion has PrivateCloud.state set to SOFT_DELETED and PrivateCloud.expireTime set to the time when deletion can no longer be reversed.
undelete	exec	projectsId, locationsId, privateCloudsId		Restores a private cloud that was previously scheduled for deletion by DeletePrivateCloud. A PrivateCloud resource scheduled for deletion has PrivateCloud.state set to DELETED and PrivateCloud.expireTime set to the time when deletion can no longer be reversed.
show_nsx_credentials	exec	projectsId, locationsId, privateCloudsId		Gets details of credentials for NSX appliance.
show_vcenter_credentials	exec	projectsId, locationsId, privateCloudsId	username	Gets details of credentials for Vcenter appliance.
reset_nsx_credentials	exec	projectsId, locationsId, privateCloudsId		Resets credentials of the NSX appliance.
reset_vcenter_credentials	exec	projectsId, locationsId, privateCloudsId		Resets credentials of the Vcenter appliance.

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
locationsId	string
privateCloudsId	string
projectsId	string
delayHours	integer (int32)
filter	string
force	boolean
orderBy	string
pageSize	integer (int32)
pageToken	string
privateCloudId	string
requestId	string
updateMask	string (google-fieldmask)
username	string
validateOnly	boolean

SELECT examples

get

Retrieves a PrivateCloud resource by its resource name.

SELECT
name,
createTime,
deleteTime,
description,
expireTime,
hcx,
managementCluster,
networkConfig,
nsx,
state,
type,
uid,
updateTime,
vcenter
FROM google.vmwareengine.private_clouds
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND privateCloudsId = '{{ privateCloudsId }}' -- required;

list

Lists PrivateCloud resources in a given project and location.

SELECT
name,
createTime,
deleteTime,
description,
expireTime,
hcx,
managementCluster,
networkConfig,
nsx,
state,
type,
uid,
updateTime,
vcenter
FROM google.vmwareengine.private_clouds
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a new PrivateCloud resource in a given project and location. Private clouds of type STANDARD and TIME_LIMITED are zonal resources, STRETCHED private clouds are regional. Creating a private cloud also creates a management cluster for that private cloud.

INSERT INTO google.vmwareengine.private_clouds (
data__networkConfig,
data__managementCluster,
data__description,
data__type,
projectsId,
locationsId,
privateCloudId,
requestId,
validateOnly
)
SELECT 
'{{ networkConfig }}',
'{{ managementCluster }}',
'{{ description }}',
'{{ type }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ privateCloudId }}',
'{{ requestId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: private_clouds
  props:
    - name: projectsId
      value: string
      description: Required parameter for the private_clouds resource.
    - name: locationsId
      value: string
      description: Required parameter for the private_clouds resource.
    - name: networkConfig
      value: object
      description: >
        Required. Network configuration of the private cloud.
        
    - name: managementCluster
      value: object
      description: >
        Required. Input only. The management cluster for this private cloud. This field is required during creation of the private cloud to provide details for the default cluster. The following fields can't be changed after private cloud creation: `ManagementCluster.clusterId`, `ManagementCluster.nodeTypeId`.
        
    - name: description
      value: string
      description: >
        User-provided description for this private cloud.
        
    - name: type
      value: string
      description: >
        Optional. Type of the private cloud. Defaults to STANDARD.
        
      valid_values: ['STANDARD', 'TIME_LIMITED', 'STRETCHED']
    - name: privateCloudId
      value: string
    - name: requestId
      value: string
    - name: validateOnly
      value: boolean

UPDATE examples

patch

Modifies a PrivateCloud resource. Only the following fields can be updated: description. Only fields specified in updateMask are applied. During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

UPDATE google.vmwareengine.private_clouds
SET 
data__networkConfig = '{{ networkConfig }}',
data__managementCluster = '{{ managementCluster }}',
data__description = '{{ description }}',
data__type = '{{ type }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND privateCloudsId = '{{ privateCloudsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Schedules a PrivateCloud resource for deletion. A PrivateCloud resource scheduled for deletion has PrivateCloud.state set to DELETED and expireTime set to the time when deletion is final and can no longer be reversed. The delete operation is marked as done as soon as the PrivateCloud is successfully scheduled for deletion (this also applies when delayHours is set to zero), and the operation is not kept in pending state until PrivateCloud is purged. PrivateCloud can be restored using UndeletePrivateCloud method before the expireTime elapses. When expireTime is reached, deletion is final and all private cloud resources are irreversibly removed and billing stops. During the final removal process, PrivateCloud.state is set to PURGING. PrivateCloud can be polled using standard GET method for the whole period of deletion and purging. It will not be returned only when it is completely purged.

DELETE FROM google.vmwareengine.private_clouds
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND privateCloudsId = '{{ privateCloudsId }}' --required
AND requestId = '{{ requestId }}'
AND force = '{{ force }}'
AND delayHours = '{{ delayHours }}';

Lifecycle Methods

private_cloud_deletion_now

Accelerates the deletion of a private cloud that is currently in soft deletion A PrivateCloud resource in soft deletion has PrivateCloud.state set to SOFT_DELETED and PrivateCloud.expireTime set to the time when deletion can no longer be reversed.

EXEC google.vmwareengine.private_clouds.private_cloud_deletion_now 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@privateCloudsId='{{ privateCloudsId }}' --required 
@@json=
'{
"requestId": "{{ requestId }}", 
"etag": "{{ etag }}"
}';

undelete

Restores a private cloud that was previously scheduled for deletion by DeletePrivateCloud. A PrivateCloud resource scheduled for deletion has PrivateCloud.state set to DELETED and PrivateCloud.expireTime set to the time when deletion can no longer be reversed.

EXEC google.vmwareengine.private_clouds.undelete 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@privateCloudsId='{{ privateCloudsId }}' --required 
@@json=
'{
"requestId": "{{ requestId }}"
}';

show_nsx_credentials

Gets details of credentials for NSX appliance.

EXEC google.vmwareengine.private_clouds.show_nsx_credentials 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@privateCloudsId='{{ privateCloudsId }}' --required;

show_vcenter_credentials

Gets details of credentials for Vcenter appliance.

EXEC google.vmwareengine.private_clouds.show_vcenter_credentials 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@privateCloudsId='{{ privateCloudsId }}' --required, 
@username='{{ username }}';

reset_nsx_credentials

Resets credentials of the NSX appliance.

EXEC google.vmwareengine.private_clouds.reset_nsx_credentials 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@privateCloudsId='{{ privateCloudsId }}' --required 
@@json=
'{
"requestId": "{{ requestId }}"
}';

reset_vcenter_credentials

Resets credentials of the Vcenter appliance.

EXEC google.vmwareengine.private_clouds.reset_vcenter_credentials 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@privateCloudsId='{{ privateCloudsId }}' --required 
@@json=
'{
"requestId": "{{ requestId }}", 
"username": "{{ username }}"
}';