Console
    Contact Us Start free

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

    create Time

    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" .
    update Time

    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" .
    delete Time

    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" .
    expire Time

    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.
    network Config

    object ( NetworkConfig )

    Required. Network configuration of the private cloud.
    management Cluster

    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 
 , 
 "dnsServerIp" 
 : 
 string 
 }
    Fields
    management Cidr

    string

    Required. Management CIDR used by VMware management appliances.
    vmware Engine Network

    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.
    vmware Engine Network Canonical

    string

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

    management Ip Address Layout Version

    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.
    dns Server Ip

    string

    Output only. DNS Server IP of the Private Cloud. All DNS queries can be forwarded to this address for name resolution of Private Cloud's management entities like vCenter, NSX-T Manager and ESXi hosts.

    ManagementCluster

    Management cluster configuration.

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

    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)
    node Type Configs

    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" } .

    stretched Cluster Config

    object ( StretchedClusterConfig )

    Optional. Configuration of a stretched cluster. Required for STRETCHED private clouds.

    Hcx

    Details about a HCX Cloud Manager appliance.

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

    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.
    ACTIVATING The appliance is being activated.

    Nsx

    Details about a NSX Manager appliance.

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

    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
    internal Ip

    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.
    STRETCHED Stretched private cloud is a regional resource with redundancy, with a minimum of 6 nodes, nodes count has to be even.

    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.

    get Dns Forwarding

    		Gets details of the DnsForwarding config.

    get Iam Policy

    		Gets the access control policy for a resource.

    list

    		Lists PrivateCloud resources in a given project and location.

    patch

    		Modifies a PrivateCloud resource.

    reset Nsx Credentials

    		Resets credentials of the NSX appliance.

    reset Vcenter Credentials

    		Resets credentials of the Vcenter appliance.

    set Iam Policy

    		Sets the access control policy on the specified resource.

    show Nsx Credentials

    		Gets details of credentials for NSX appliance.

    show Vcenter Credentials

    		Gets details of credentials for Vcenter appliance.

    test Iam Permissions

    		Returns permissions that a caller has on the specified resource.

    undelete

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

    update Dns Forwarding

    		Updates the parameters of the DnsForwarding config, like associated domains.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: