private_clouds

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

Overview

Name	private_clouds
Type	Resource
Id	google.vmwareengine.private_clouds

Fields

Name	Datatype	Description
name	string	Output only. 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
description	string	User-provided description for this private cloud.
createTime	string	Output only. Creation time of this resource.
deleteTime	string	Output only. Time when the resource was scheduled for deletion.
expireTime	string	Output only. Time when the resource will be irreversibly deleted.
hcx	object	Details about a HCX Cloud Manager appliance.
managementCluster	object	Management cluster configuration.
networkConfig	object	Network configuration in the consumer project with which the peering has to be done.
nsx	object	Details about a NSX Manager appliance.
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	Output only. Last update time of this resource.
vcenter	object	Details about a vCenter Server management appliance.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	locationsId, privateCloudsId, projectsId	Retrieves a PrivateCloud resource by its resource name.
list	SELECT	locationsId, projectsId	Lists PrivateCloud resources in a given project and location.
create	INSERT	locationsId, projectsId	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.
delete	DELETE	locationsId, privateCloudsId, projectsId	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.
patch	UPDATE	locationsId, privateCloudsId, projectsId	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.
reset_nsx_credentials	EXEC	locationsId, privateCloudsId, projectsId	Resets credentials of the NSX appliance.
reset_vcenter_credentials	EXEC	locationsId, privateCloudsId, projectsId	Resets credentials of the Vcenter appliance.
show_nsx_credentials	EXEC	locationsId, privateCloudsId, projectsId	Gets details of credentials for NSX appliance.
show_vcenter_credentials	EXEC	locationsId, privateCloudsId, projectsId	Gets details of credentials for Vcenter appliance.
undelete	EXEC	locationsId, privateCloudsId, projectsId	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.

SELECT examples

Lists PrivateCloud resources in a given project and location.

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

INSERT example

Use the following StackQL query and manifest file to create a new private_clouds resource.

All Properties

/*+ create */
INSERT INTO google.vmwareengine.private_clouds (
locationsId,
projectsId,
networkConfig,
managementCluster,
description,
type
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ networkConfig }}',
'{{ managementCluster }}',
'{{ description }}',
'{{ type }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: deleteTime
      value: string
    - name: expireTime
      value: string
    - name: state
      value: string
    - name: networkConfig
      value:
        - name: managementCidr
          value: string
        - name: vmwareEngineNetwork
          value: string
        - name: vmwareEngineNetworkCanonical
          value: string
        - name: managementIpAddressLayoutVersion
          value: integer
        - name: dnsServerIp
          value: string
    - name: managementCluster
      value:
        - name: clusterId
          value: string
        - name: nodeTypeConfigs
          value: object
        - name: stretchedClusterConfig
          value:
            - name: preferredLocation
              value: string
            - name: secondaryLocation
              value: string
    - name: description
      value: string
    - name: hcx
      value:
        - name: internalIp
          value: string
        - name: version
          value: string
        - name: state
          value: string
        - name: fqdn
          value: string
    - name: nsx
      value:
        - name: internalIp
          value: string
        - name: version
          value: string
        - name: state
          value: string
        - name: fqdn
          value: string
    - name: vcenter
      value:
        - name: internalIp
          value: string
        - name: version
          value: string
        - name: state
          value: string
        - name: fqdn
          value: string
    - name: uid
      value: string
    - name: type
      value: string

UPDATE example

Updates a private_clouds resource.

/*+ update */
UPDATE google.vmwareengine.private_clouds
SET 
networkConfig = '{{ networkConfig }}',
managementCluster = '{{ managementCluster }}',
description = '{{ description }}',
type = '{{ type }}'
WHERE 
locationsId = '{{ locationsId }}'
AND privateCloudsId = '{{ privateCloudsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified private_clouds resource.

/*+ delete */
DELETE FROM google.vmwareengine.private_clouds
WHERE locationsId = '{{ locationsId }}'
AND privateCloudsId = '{{ privateCloudsId }}'
AND projectsId = '{{ projectsId }}';