REST Resource: projects.locations.privateClouds

Resource: PrivateCloud

Represents a private cloud resource. Private clouds of type STANDARD and TIME_LIMITED are zonal resources, STRETCHED private clouds are regional.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "expireTime": string,
  "state": enum (State),
  "networkConfig": {
    object (NetworkConfig)
  },
  "managementCluster": {
    object (ManagementCluster)
  },
  "description": string,
  "hcx": {
    object (Hcx)
  },
  "nsx": {
    object (Nsx)
  },
  "vcenter": {
    object (Vcenter)
  },
  "uid": string,
  "type": enum (Type)
}
Fields
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
createTime

string (Timestamp format)

Output only. Creation time of this resource.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. Last update time of this resource.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
deleteTime

string (Timestamp format)

Output only. Time when the resource was scheduled for deletion.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
expireTime

string (Timestamp format)

Output only. Time when the resource will be irreversibly deleted.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Output only. State of the resource. New values may be added to this enum when appropriate.
networkConfig

object (NetworkConfig)

Required. Network configuration of the private cloud.
managementCluster

object (ManagementCluster)

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.
description

string

User-provided description for this private cloud.
hcx

object (Hcx)

Output only. HCX appliance.
nsx

object (Nsx)

Output only. NSX appliance.
vcenter

object (Vcenter)

Output only. Vcenter appliance.
uid

string

Output only. System-generated unique identifier for the resource.
type

enum (Type)

Optional. Type of the private cloud. Defaults to STANDARD.

State

Enum State defines possible states of private clouds.

Enums
STATE_UNSPECIFIED The default value. This value should never be used.
ACTIVE The private cloud is ready.
CREATING The private cloud is being created.
UPDATING The private cloud is being updated.
FAILED The private cloud is in failed state.
DELETED The private cloud is scheduled for deletion. The deletion process can be cancelled by using the corresponding undelete method.
PURGING The private cloud is irreversibly deleted and is being removed from the system.

NetworkConfig

Network configuration in the consumer project with which the peering has to be done.

JSON representation 
{
  "managementCidr": string,
  "vmwareEngineNetwork": string,
  "vmwareEngineNetworkCanonical": string,
  "managementIpAddressLayoutVersion": integer
}
Fields
managementCidr

string

Required. Management CIDR used by VMware management appliances.
vmwareEngineNetwork

string

Optional. The relative resource name of the VMware Engine network attached to the private cloud. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId} where {project} can either be a project number or a project ID.
vmwareEngineNetworkCanonical

string

Output only. The canonical name of the VMware Engine network in the form: projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmwareEngineNetworkId}
managementIpAddressLayoutVersion

integer

Output only. The IP address layout version of the management IP address range. Possible versions include: * managementIpAddressLayoutVersion=1: Indicates the legacy IP address layout used by some existing private clouds. This is no longer supported for new private clouds as it does not support all features. * managementIpAddressLayoutVersion=2: Indicates the latest IP address layout used by all newly created private clouds. This version supports all current features.

ManagementCluster

Management cluster configuration.

JSON representation 
{
  "clusterId": string,
  "nodeTypeConfigs": {
    string: {
      object (NodeTypeConfig)
    },
    ...
  }
}
Fields
clusterId

string

Required. The user-provided identifier of the new Cluster. The identifier must meet the following requirements:

  • Only contains 1-63 alphanumeric characters and hyphens
  • Begins with an alphabetical character
  • Ends with a non-hyphen character
  • Not formatted as a UUID
  • Complies with RFC 1034 (section 3.5)
nodeTypeConfigs

map (key: string, value: object (NodeTypeConfig))

Required. The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the NodeType).

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Hcx

Details about a HCX Cloud Manager appliance.

JSON representation 
{
  "internalIp": string,
  "version": string,
  "state": enum (State),
  "fqdn": string
}
Fields
internalIp

string

Internal IP address of the appliance.
version

string

Version of the appliance.
state

enum (State)

Output only. The state of the appliance.
fqdn

string

Fully qualified domain name of the appliance.

State

State of the appliance

Enums
STATE_UNSPECIFIED Unspecified appliance state. This is the default value.
ACTIVE The appliance is operational and can be used.
CREATING The appliance is being deployed.

Nsx

Details about a NSX Manager appliance.

JSON representation 
{
  "internalIp": string,
  "version": string,
  "state": enum (State),
  "fqdn": string
}
Fields
internalIp

string

Internal IP address of the appliance.
version

string

Version of the appliance.
state

enum (State)

Output only. The state of the appliance.
fqdn

string

Fully qualified domain name of the appliance.

State

State of the appliance

Enums
STATE_UNSPECIFIED Unspecified appliance state. This is the default value.
ACTIVE The appliance is operational and can be used.
CREATING The appliance is being deployed.

Vcenter

Details about a vCenter Server management appliance.

JSON representation 
{
  "internalIp": string,
  "version": string,
  "state": enum (State),
  "fqdn": string
}
Fields
internalIp

string

Internal IP address of the appliance.
version

string

Version of the appliance.
state

enum (State)

Output only. The state of the appliance.
fqdn

string

Fully qualified domain name of the appliance.

State

State of the appliance

Enums
STATE_UNSPECIFIED Unspecified appliance state. This is the default value.
ACTIVE The appliance is operational and can be used.
CREATING The appliance is being deployed.

Type

Enum Type defines private cloud type.

Enums
STANDARD Standard private is a zonal resource, with 3+ nodes. Default type.
TIME_LIMITED Time limited private cloud is a zonal resource, can have only 1 node and has limited life span. Will be deleted after defined period of time, can be converted into standard private cloud by expanding it up to 3 or more nodes.

Methods

create

 Creates a new PrivateCloud resource in a given project and location.

delete

 Schedules a PrivateCloud resource for deletion.

get

 Retrieves a PrivateCloud resource by its resource name.

getIamPolicy

 Gets the access control policy for a resource.

list

 Lists PrivateCloud resources in a given project and location.

patch

 Modifies a PrivateCloud resource.

resetNsxCredentials

 Resets credentials of the NSX appliance.

resetVcenterCredentials

 Resets credentials of the Vcenter appliance.

setIamPolicy

 Sets the access control policy on the specified resource.

showNsxCredentials

 Gets details of credentials for NSX appliance.

showVcenterCredentials

 Gets details of credentials for Vcenter appliance.

testIamPermissions

 Returns permissions that a caller has on the specified resource.

undelete

 Restores a private cloud that was previously scheduled for deletion by DeletePrivateCloud.