Returns the operations Resource.
Returns the vmwareNodePools Resource.
Close httplib2 connections.
Creates a new VMware user cluster in a given project and location.
Deletes a single VMware Cluster.
enroll(parent, body=None, x__xgafv=None)
Enrolls an existing VMware user cluster and its node pools to the Anthos On-Prem API within a given project and location. Through enrollment, an existing cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster and/or its node pools will be expected to be performed through the API.
get(name, allowMissing=None, view=None, x__xgafv=None)
Gets details of a single VMware Cluster.
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists VMware Clusters in a given project and location.
Retrieves the next page of results.
patch(name, body, updateMask=None, validateOnly=None, x__xgafv=None)
Updates the parameters of a single VMware cluster.
Queries the VMware user cluster version config.
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
testIamPermissions(resource, body=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
unenroll(name, allowMissing=None, etag=None, force=None, validateOnly=None, x__xgafv=None)
Unenrolls an existing VMware user cluster and its node pools from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters and node pools will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or UI.
close()
Close httplib2 connections.
create(parent, body, allowPreflightFailure=None, validateOnly=None, vmwareClusterId=None, x__xgafv=None)
Creates a new VMware user cluster in a given project and location.
Args:
parent: string, Required. The parent of the project and location where this cluster is created in. Format: "projects/{project}/locations/{location}" (required)
body: object, The request body.
The object takes the form of:
{ # Resource that represents a VMware user cluster. ##
"adminClusterMembership": "A String", # Required. The admin cluster this VMware user cluster belongs to. This is the full resource name of the admin cluster's fleet membership. In the future, references to other resource types might be allowed if admin clusters are modeled as their own resources.
"adminClusterName": "A String", # Output only. The resource name of the VMware admin cluster hosting this user cluster.
"annotations": { # Annotations on the VMware user cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.
"a_key": "A String",
},
"antiAffinityGroups": { # Specifies anti affinity group config for the VMware user cluster. # AAGConfig specifies whether to spread VMware user cluster nodes across at least three physical hosts in the datacenter.
"aagConfigDisabled": True or False, # Spread nodes across at least three physical hosts (requires at least three hosts). Enabled by default.
},
"authorization": { # Authorization defines the On-Prem cluster authorization configuration to bootstrap onto the admin cluster. # RBAC policy that will be applied and managed by the Anthos On-Prem API.
"adminUsers": [ # For VMware and bare metal user clusters, users will be granted the cluster-admin role on the cluster, which provides full administrative access to the cluster. For bare metal admin clusters, users will be granted the cluster-view role, which limits users to read-only access.
{ # ClusterUser configures user principals for an RBAC policy.
"username": "A String", # Required. The name of the user, e.g. `my-gcp-id@gmail.com`.
},
],
},
"autoRepairConfig": { # Specifies config to enable/disable auto repair. The cluster-health-controller is deployed only if Enabled is true. # Configuration for auto repairing.
"enabled": True or False, # Whether auto repair is enabled.
},
"binaryAuthorization": { # Configuration for Binary Authorization. # Binary Authorization related configurations.
"evaluationMode": "A String", # Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.
},
"controlPlaneNode": { # Specifies control plane node config for the VMware user cluster. # VMware user cluster control plane nodes must have either 1 or 3 replicas.
"autoResizeConfig": { # Represents auto resizing configurations for the VMware user cluster. # AutoResizeConfig provides auto resizing configurations.
"enabled": True or False, # Whether to enable controle plane node auto resizing.
},
"cpus": "A String", # The number of CPUs for each admin cluster node that serve as control planes for this VMware user cluster. (default: 4 CPUs)
"memory": "A String", # The megabytes of memory for each admin cluster node that serves as a control plane for this VMware user cluster (default: 8192 MB memory).
"replicas": "A String", # The number of control plane nodes for this VMware user cluster. (default: 1 replica).
"vsphereConfig": { # Specifies control plane node config. # Vsphere-specific config.
"datastore": "A String", # The Vsphere datastore used by the control plane Node.
"storagePolicyName": "A String", # The Vsphere storage policy used by the control plane Node.
},
},
"createTime": "A String", # Output only. The time at which VMware user cluster was created.
"dataplaneV2": { # Contains configurations for Dataplane V2, which is optimized dataplane for Kubernetes networking. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dataplane-v2 # VmwareDataplaneV2Config specifies configuration for Dataplane V2.
"advancedNetworking": True or False, # Enable advanced networking which requires dataplane_v2_enabled to be set true.
"dataplaneV2Enabled": True or False, # Enables Dataplane V2.
"forwardMode": "A String", # Configure ForwardMode for Dataplane v2.
"windowsDataplaneV2Enabled": True or False, # Enable Dataplane V2 for clusters with Windows nodes.
},
"deleteTime": "A String", # Output only. The time at which VMware user cluster was deleted.
"description": "A String", # A human readable description of this VMware user cluster.
"disableBundledIngress": True or False, # Disable bundled ingress.
"enableControlPlaneV2": True or False, # Enable control plane V2. Default to false.
"endpoint": "A String", # Output only. The DNS name of VMware user cluster's API server.
"etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control.
"fleet": { # Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See [Anthos Fleets](`https://cloud.google.com/anthos/multicluster-management/fleets`) for more details on Anthos multi-cluster capabilities using Fleets. ## # Output only. Fleet configuration for the cluster.
"membership": "A String", # Output only. The name of the managed fleet Membership resource associated to this cluster. Membership names are formatted as `projects//locations//memberships/`.
},
"loadBalancer": { # Specifies the locad balancer config for the VMware user cluster. # Load balancer configuration.
"f5Config": { # Represents configuration parameters for an F5 BIG-IP load balancer. # Configuration for F5 Big IP typed load balancers.
"address": "A String", # The load balancer's IP address.
"partition": "A String", # The preexisting partition to be used by the load balancer. This partition is usually created for the admin cluster for example: 'my-f5-admin-partition'.
"snatPool": "A String", # The pool name. Only necessary, if using SNAT.
},
"manualLbConfig": { # Represents configuration parameters for an already existing manual load balancer. Given the nature of manual load balancers it is expected that said load balancer will be fully managed by users. IMPORTANT: Please note that the Anthos On-Prem API will not generate or update ManualLB configurations it can only bind a pre-existing configuration to a new VMware user cluster. # Manually configured load balancers.
"controlPlaneNodePort": 42, # NodePort for control plane service. The Kubernetes API server in the admin cluster is implemented as a Service of type NodePort (ex. 30968).
"ingressHttpNodePort": 42, # NodePort for ingress service's http. The ingress service in the admin cluster is implemented as a Service of type NodePort (ex. 32527).
"ingressHttpsNodePort": 42, # NodePort for ingress service's https. The ingress service in the admin cluster is implemented as a Service of type NodePort (ex. 30139).
"konnectivityServerNodePort": 42, # NodePort for konnectivity server service running as a sidecar in each kube-apiserver pod (ex. 30564).
},
"metalLbConfig": { # Represents configuration parameters for the MetalLB load balancer. # Configuration for MetalLB typed load balancers.
"addressPools": [ # Required. AddressPools is a list of non-overlapping IP pools used by load balancer typed services. All addresses must be routable to load balancer nodes. IngressVIP must be included in the pools.
{ # Represents an IP pool used by the load balancer.
"addresses": [ # Required. The addresses that are part of this pool. Each address must be either in the CIDR form (1.2.3.0/24) or range form (1.2.3.1-1.2.3.5).
"A String",
],
"avoidBuggyIps": True or False, # If true, avoid using IPs ending in .0 or .255. This avoids buggy consumer devices mistakenly dropping IPv4 traffic for those special IP addresses.
"manualAssign": True or False, # If true, prevent IP addresses from being automatically assigned.
"pool": "A String", # Required. The name of the address pool.
},
],
},
"seesawConfig": { # VmwareSeesawConfig represents configuration parameters for an already existing Seesaw load balancer. IMPORTANT: Please note that the Anthos On-Prem API will not generate or update Seesaw configurations it can only bind a pre-existing configuration to a new user cluster. IMPORTANT: When attempting to create a user cluster with a pre-existing Seesaw load balancer you will need to follow some preparation steps before calling the 'CreateVmwareCluster' API method. First you will need to create the user cluster's namespace via kubectl. The namespace will need to use the following naming convention : -gke-onprem-mgmt or -gke-onprem-mgmt depending on whether you used the 'VmwareCluster.local_name' to disambiguate collisions; for more context see the documentation of 'VmwareCluster.local_name'. Once the namespace is created you will need to create a secret resource via kubectl. This secret will contain copies of your Seesaw credentials. The Secret must be called 'user-cluster-creds' and contain Seesaw's SSH and Cert credentials. The credentials must be keyed with the following names: 'seesaw-ssh-private-key', 'seesaw-ssh-public-key', 'seesaw-ssh-ca-key', 'seesaw-ssh-ca-cert'. # Output only. Configuration for Seesaw typed load balancers.
"enableHa": True or False, # Enable two load balancer VMs to achieve a highly-available Seesaw load balancer.
"group": "A String", # Required. In general the following format should be used for the Seesaw group name: seesaw-for-[cluster_name].
"ipBlocks": [ # Required. The IP Blocks to be used by the Seesaw load balancer
{ # Represents a collection of IP addresses to assign to nodes.
"gateway": "A String", # The network gateway used by the VMware user cluster.
"ips": [ # The node's network configurations used by the VMware user cluster.
{ # Represents VMware user cluster node's network configuration.
"hostname": "A String", # Hostname of the machine. VM's name will be used if this field is empty.
"ip": "A String", # IP could be an IP address (like 1.2.3.4) or a CIDR (like 1.2.3.0/24).
},
],
"netmask": "A String", # The netmask used by the VMware user cluster.
},
],
"masterIp": "A String", # Required. MasterIP is the IP announced by the master of Seesaw group.
"stackdriverName": "A String", # Name to be used by Stackdriver.
"vms": [ # Names of the VMs created for this Seesaw group.
"A String",
],
},
"vipConfig": { # Specifies the VIP config for the VMware user cluster load balancer. # The VIPs used by the load balancer.
"controlPlaneVip": "A String", # The VIP which you previously set aside for the Kubernetes API of this cluster.
"ingressVip": "A String", # The VIP which you previously set aside for ingress traffic into this cluster.
},
},
"localName": "A String", # Output only. The object name of the VMware OnPremUserCluster custom resource on the associated admin cluster. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the ID in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. All users should use this name to access their cluster using gkectl or kubectl and should expect to see the local name when viewing admin cluster controller logs.
"name": "A String", # Immutable. The VMware user cluster resource name.
"networkConfig": { # Specifies network config for the VMware user cluster. # The VMware user cluster network configuration.
"controlPlaneV2Config": { # Specifies control plane V2 config. # Configuration for control plane V2 mode.
"controlPlaneIpBlock": { # Represents a collection of IP addresses to assign to nodes. # Static IP addresses for the control plane nodes.
"gateway": "A String", # The network gateway used by the VMware user cluster.
"ips": [ # The node's network configurations used by the VMware user cluster.
{ # Represents VMware user cluster node's network configuration.
"hostname": "A String", # Hostname of the machine. VM's name will be used if this field is empty.
"ip": "A String", # IP could be an IP address (like 1.2.3.4) or a CIDR (like 1.2.3.0/24).
},
],
"netmask": "A String", # The netmask used by the VMware user cluster.
},
},
"dhcpIpConfig": { # Represents the network configuration required for the VMware user clusters with DHCP IP configurations. # Configuration settings for a DHCP IP configuration.
"enabled": True or False, # enabled is a flag to mark if DHCP IP allocation is used for VMware user clusters.
},
"hostConfig": { # Represents the common parameters for all the hosts irrespective of their IP address. # Represents common network settings irrespective of the host's IP address.
"dnsSearchDomains": [ # DNS search domains.
"A String",
],
"dnsServers": [ # DNS servers.
"A String",
],
"ntpServers": [ # NTP servers.
"A String",
],
},
"podAddressCidrBlocks": [ # Required. All pods in the cluster are assigned an RFC1918 IPv4 address from these ranges. Only a single range is supported. This field cannot be changed after creation.
"A String",
],
"serviceAddressCidrBlocks": [ # Required. All services in the cluster are assigned an RFC1918 IPv4 address from these ranges. Only a single range is supported. This field cannot be changed after creation.
"A String",
],
"staticIpConfig": { # Represents the network configuration required for the VMware user clusters with Static IP configurations. # Configuration settings for a static IP configuration.
"ipBlocks": [ # Represents the configuration values for static IP allocation to nodes.
{ # Represents a collection of IP addresses to assign to nodes.
"gateway": "A String", # The network gateway used by the VMware user cluster.
"ips": [ # The node's network configurations used by the VMware user cluster.
{ # Represents VMware user cluster node's network configuration.
"hostname": "A String", # Hostname of the machine. VM's name will be used if this field is empty.
"ip": "A String", # IP could be an IP address (like 1.2.3.4) or a CIDR (like 1.2.3.0/24).
},
],
"netmask": "A String", # The netmask used by the VMware user cluster.
},
],
},
"vcenterNetwork": "A String", # vcenter_network specifies vCenter network name. Inherited from the admin cluster.
},
"onPremVersion": "A String", # Required. The Anthos clusters on the VMware version for your user cluster.
"reconciling": True or False, # Output only. If set, there are currently changes in flight to the VMware user cluster.
"state": "A String", # Output only. The current state of VMware user cluster.
"status": { # ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). # Output only. ResourceStatus representing detailed cluster state.
"conditions": [ # ResourceCondition provide a standard mechanism for higher-level status reporting from controller.
{ # ResourceCondition provides a standard mechanism for higher-level status reporting from controller.
"lastTransitionTime": "A String", # Last time the condition transit from one status to another.
"message": "A String", # Human-readable message indicating details about last transition.
"reason": "A String", # Machine-readable message indicating details about last transition.
"state": "A String", # state of the condition.
"type": "A String", # Type of the condition. (e.g., ClusterRunning, NodePoolRunning or ServerSidePreflightReady)
},
],
"errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention.
"version": "A String", # Reflect current version of the resource.
"versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version.
"versions": [ # Shows the mapping of a given version to the number of machines under this version.
{ # Version describes the number of nodes at a given version under a resource.
"count": "A String", # Number of machines under the above version.
"version": "A String", # Resource version.
},
],
},
},
"storage": { # Specifies vSphere CSI components deployment config in the VMware user cluster. # Storage configuration.
"vsphereCsiDisabled": True or False, # Whether or not to deploy vSphere CSI components in the VMware user cluster. Enabled by default.
},
"uid": "A String", # Output only. The unique identifier of the VMware user cluster.
"updateTime": "A String", # Output only. The time at which VMware user cluster was last updated.
"upgradePolicy": { # VmwareClusterUpgradePolicy defines the cluster upgrade policy. # Specifies upgrade policy for the cluster.
"controlPlaneOnly": True or False, # Controls whether the upgrade applies to the control plane only.
},
"validationCheck": { # ValidationCheck represents the result of preflight check. # Output only. ValidationCheck represents the result of the preflight check job.
"option": "A String", # Options used for the validation check
"scenario": "A String", # Output only. The scenario when the preflight checks were run.
"status": { # ValidationCheckStatus defines the detailed validation check status. # Output only. The detailed validation check status.
"result": [ # Individual checks which failed as part of the Preflight check execution.
{ # ValidationCheckResult defines the details about the validation check.
"category": "A String", # The category of the validation.
"description": "A String", # The description of the validation check.
"details": "A String", # Detailed failure information, which might be unformatted.
"reason": "A String", # A human-readable message of the check failure.
"state": "A String", # The validation check state.
},
],
},
},
"vcenter": { # Represents configuration for the VMware VCenter for the user cluster. # VmwareVCenterConfig specifies vCenter config for the user cluster. If unspecified, it is inherited from the admin cluster.
"address": "A String", # Output only. The vCenter IP address.
"caCertData": "A String", # Contains the vCenter CA certificate public key for SSL verification.
"cluster": "A String", # The name of the vCenter cluster for the user cluster.
"datacenter": "A String", # The name of the vCenter datacenter for the user cluster.
"datastore": "A String", # The name of the vCenter datastore for the user cluster.
"folder": "A String", # The name of the vCenter folder for the user cluster.
"resourcePool": "A String", # The name of the vCenter resource pool for the user cluster.
"storagePolicyName": "A String", # The name of the vCenter storage policy for the user cluster.
},
"vmTrackingEnabled": True or False, # Enable VM tracking.
}
allowPreflightFailure: boolean, Optional. If set to true, CLM will force CCFE to persist the cluster resource in RMS when the creation fails during standalone preflight checks. In that case the subsequent create call will fail with "cluster already exists" error and hence a update cluster is required to fix the cluster.
validateOnly: boolean, Validate the request without actually doing any updates.
vmwareClusterId: string, User provided identifier that is used as part of the resource name; This value must be up to 40 characters and follow RFC-1123 (https://tools.ietf.org/html/rfc1123) format.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
delete(name, allowMissing=None, etag=None, force=None, ignoreErrors=None, validateOnly=None, x__xgafv=None)
Deletes a single VMware Cluster.
Args:
name: string, Required. Name of the VMware user cluster to be deleted. Format: "projects/{project}/locations/{location}/vmwareClusters/{vmware_cluster}" (required)
allowMissing: boolean, If set to true, and the VMware cluster is not found, the request will succeed but no action will be taken on the server and return a completed LRO.
etag: string, The current etag of the VMware cluster. If an etag is provided and does not match the current etag of the cluster, deletion will be blocked and an ABORTED error will be returned.
force: boolean, If set to true, any node pools from the cluster will also be deleted.
ignoreErrors: boolean, If set to true, the deletion of a VMware user cluster resource will succeed even if errors occur during deletion. This parameter can be used when you want to delete GCP's cluster resource and the on-prem admin cluster that hosts your user cluster is disconnected / unreachable or deleted. WARNING: Using this parameter when your user cluster still exists may result in a deleted GCP user cluster but an existing on-prem user cluster.
validateOnly: boolean, Validate the request without actually doing any updates.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
enroll(parent, body=None, x__xgafv=None)
Enrolls an existing VMware user cluster and its node pools to the Anthos On-Prem API within a given project and location. Through enrollment, an existing cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster and/or its node pools will be expected to be performed through the API.
Args:
parent: string, Required. The parent of the project and location where the cluster is Enrolled in. Format: "projects/{project}/locations/{location}" (required)
body: object, The request body.
The object takes the form of:
{ # Message for enrolling an existing VMware cluster to the Anthos On-Prem API.
"adminClusterMembership": "A String", # Required. The admin cluster this VMware user cluster belongs to. This is the full resource name of the admin cluster's fleet membership. In the future, references to other resource types might be allowed if admin clusters are modeled as their own resources.
"localName": "A String", # Optional. The object name of the VMware OnPremUserCluster custom resource on the associated admin cluster. This field is used to support conflicting resource names when enrolling existing clusters to the API. When not provided, this field will resolve to the vmware_cluster_id. Otherwise, it must match the object name of the VMware OnPremUserCluster custom resource. It is not modifiable outside / beyond the enrollment operation.
"validateOnly": True or False, # Validate the request without actually doing any updates.
"vmwareClusterId": "A String", # User provided OnePlatform identifier that is used as part of the resource name. This must be unique among all GKE on-prem clusters within a project and location and will return a 409 if the cluster already exists. (https://tools.ietf.org/html/rfc1123) format.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
get(name, allowMissing=None, view=None, x__xgafv=None)
Gets details of a single VMware Cluster.
Args:
name: string, Required. Name of the VMware user cluster to be returned. Format: "projects/{project}/locations/{location}/vmwareClusters/{vmware_cluster}" (required)
allowMissing: boolean, Optional. If true, return Vmware Cluster including the one that only exists in RMS.
view: string, View for VMware user cluster. When `BASIC` is specified, only the cluster resource name and admin cluster membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete cluster configuration details.
Allowed values
CLUSTER_VIEW_UNSPECIFIED - If the value is not set, the default `FULL` view is used.
BASIC - Includes basic information of a cluster resource including cluster resource name and admin cluster membership.
FULL - Includes the complete configuration for VMware cluster resource. This is the default value for GetVmwareClusterRequest method.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Resource that represents a VMware user cluster. ##
"adminClusterMembership": "A String", # Required. The admin cluster this VMware user cluster belongs to. This is the full resource name of the admin cluster's fleet membership. In the future, references to other resource types might be allowed if admin clusters are modeled as their own resources.
"adminClusterName": "A String", # Output only. The resource name of the VMware admin cluster hosting this user cluster.
"annotations": { # Annotations on the VMware user cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.
"a_key": "A String",
},
"antiAffinityGroups": { # Specifies anti affinity group config for the VMware user cluster. # AAGConfig specifies whether to spread VMware user cluster nodes across at least three physical hosts in the datacenter.
"aagConfigDisabled": True or False, # Spread nodes across at least three physical hosts (requires at least three hosts). Enabled by default.
},
"authorization": { # Authorization defines the On-Prem cluster authorization configuration to bootstrap onto the admin cluster. # RBAC policy that will be applied and managed by the Anthos On-Prem API.
"adminUsers": [ # For VMware and bare metal user clusters, users will be granted the cluster-admin role on the cluster, which provides full administrative access to the cluster. For bare metal admin clusters, users will be granted the cluster-view role, which limits users to read-only access.
{ # ClusterUser configures user principals for an RBAC policy.
"username": "A String", # Required. The name of the user, e.g. `my-gcp-id@gmail.com`.
},
],
},
"autoRepairConfig": { # Specifies config to enable/disable auto repair. The cluster-health-controller is deployed only if Enabled is true. # Configuration for auto repairing.
"enabled": True or False, # Whether auto repair is enabled.
},
"binaryAuthorization": { # Configuration for Binary Authorization. # Binary Authorization related configurations.
"evaluationMode": "A String", # Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.
},
"controlPlaneNode": { # Specifies control plane node config for the VMware user cluster. # VMware user cluster control plane nodes must have either 1 or 3 replicas.
"autoResizeConfig": { # Represents auto resizing configurations for the VMware user cluster. # AutoResizeConfig provides auto resizing configurations.
"enabled": True or False, # Whether to enable controle plane node auto resizing.
},
"cpus": "A String", # The number of CPUs for each admin cluster node that serve as control planes for this VMware user cluster. (default: 4 CPUs)
"memory": "A String", # The megabytes of memory for each admin cluster node that serves as a control plane for this VMware user cluster (default: 8192 MB memory).
"replicas": "A String", # The number of control plane nodes for this VMware user cluster. (default: 1 replica).
"vsphereConfig": { # Specifies control plane node config. # Vsphere-specific config.
"datastore": "A String", # The Vsphere datastore used by the control plane Node.
"storagePolicyName": "A String", # The Vsphere storage policy used by the control plane Node.
},
},
"createTime": "A String", # Output only. The time at which VMware user cluster was created.
"dataplaneV2": { # Contains configurations for Dataplane V2, which is optimized dataplane for Kubernetes networking. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dataplane-v2 # VmwareDataplaneV2Config specifies configuration for Dataplane V2.
"advancedNetworking": True or False, # Enable advanced networking which requires dataplane_v2_enabled to be set true.
"dataplaneV2Enabled": True or False, # Enables Dataplane V2.
"forwardMode": "A String", # Configure ForwardMode for Dataplane v2.
"windowsDataplaneV2Enabled": True or False, # Enable Dataplane V2 for clusters with Windows nodes.
},
"deleteTime": "A String", # Output only. The time at which VMware user cluster was deleted.
"description": "A String", # A human readable description of this VMware user cluster.
"disableBundledIngress": True or False, # Disable bundled ingress.
"enableControlPlaneV2": True or False, # Enable control plane V2. Default to false.
"endpoint": "A String", # Output only. The DNS name of VMware user cluster's API server.
"etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control.
"fleet": { # Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See [Anthos Fleets](`https://cloud.google.com/anthos/multicluster-management/fleets`) for more details on Anthos multi-cluster capabilities using Fleets. ## # Output only. Fleet configuration for the cluster.
"membership": "A String", # Output only. The name of the managed fleet Membership resource associated to this cluster. Membership names are formatted as `projects//locations//memberships/`.
},
"loadBalancer": { # Specifies the locad balancer config for the VMware user cluster. # Load balancer configuration.
"f5Config": { # Represents configuration parameters for an F5 BIG-IP load balancer. # Configuration for F5 Big IP typed load balancers.
"address": "A String", # The load balancer's IP address.
"partition": "A String", # The preexisting partition to be used by the load balancer. This partition is usually created for the admin cluster for example: 'my-f5-admin-partition'.
"snatPool": "A String", # The pool name. Only necessary, if using SNAT.
},
"manualLbConfig": { # Represents configuration parameters for an already existing manual load balancer. Given the nature of manual load balancers it is expected that said load balancer will be fully managed by users. IMPORTANT: Please note that the Anthos On-Prem API will not generate or update ManualLB configurations it can only bind a pre-existing configuration to a new VMware user cluster. # Manually configured load balancers.
"controlPlaneNodePort": 42, # NodePort for control plane service. The Kubernetes API server in the admin cluster is implemented as a Service of type NodePort (ex. 30968).
"ingressHttpNodePort": 42, # NodePort for ingress service's http. The ingress service in the admin cluster is implemented as a Service of type NodePort (ex. 32527).
"ingressHttpsNodePort": 42, # NodePort for ingress service's https. The ingress service in the admin cluster is implemented as a Service of type NodePort (ex. 30139).
"konnectivityServerNodePort": 42, # NodePort for konnectivity server service running as a sidecar in each kube-apiserver pod (ex. 30564).
},
"metalLbConfig": { # Represents configuration parameters for the MetalLB load balancer. # Configuration for MetalLB typed load balancers.
"addressPools": [ # Required. AddressPools is a list of non-overlapping IP pools used by load balancer typed services. All addresses must be routable to load balancer nodes. IngressVIP must be included in the pools.
{ # Represents an IP pool used by the load balancer.
"addresses": [ # Required. The addresses that are part of this pool. Each address must be either in the CIDR form (1.2.3.0/24) or range form (1.2.3.1-1.2.3.5).
"A String",
],
"avoidBuggyIps": True or False, # If true, avoid using IPs ending in .0 or .255. This avoids buggy consumer devices mistakenly dropping IPv4 traffic for those special IP addresses.
"manualAssign": True or False, # If true, prevent IP addresses from being automatically assigned.
"pool": "A String", # Required. The name of the address pool.
},
],
},
"seesawConfig": { # VmwareSeesawConfig represents configuration parameters for an already existing Seesaw load balancer. IMPORTANT: Please note that the Anthos On-Prem API will not generate or update Seesaw configurations it can only bind a pre-existing configuration to a new user cluster. IMPORTANT: When attempting to create a user cluster with a pre-existing Seesaw load balancer you will need to follow some preparation steps before calling the 'CreateVmwareCluster' API method. First you will need to create the user cluster's namespace via kubectl. The namespace will need to use the following naming convention : -gke-onprem-mgmt or -gke-onprem-mgmt depending on whether you used the 'VmwareCluster.local_name' to disambiguate collisions; for more context see the documentation of 'VmwareCluster.local_name'. Once the namespace is created you will need to create a secret resource via kubectl. This secret will contain copies of your Seesaw credentials. The Secret must be called 'user-cluster-creds' and contain Seesaw's SSH and Cert credentials. The credentials must be keyed with the following names: 'seesaw-ssh-private-key', 'seesaw-ssh-public-key', 'seesaw-ssh-ca-key', 'seesaw-ssh-ca-cert'. # Output only. Configuration for Seesaw typed load balancers.
"enableHa": True or False, # Enable two load balancer VMs to achieve a highly-available Seesaw load balancer.
"group": "A String", # Required. In general the following format should be used for the Seesaw group name: seesaw-for-[cluster_name].
"ipBlocks": [ # Required. The IP Blocks to be used by the Seesaw load balancer
{ # Represents a collection of IP addresses to assign to nodes.
"gateway": "A String", # The network gateway used by the VMware user cluster.
"ips": [ # The node's network configurations used by the VMware user cluster.
{ # Represents VMware user cluster node's network configuration.
"hostname": "A String", # Hostname of the machine. VM's name will be used if this field is empty.
"ip": "A String", # IP could be an IP address (like 1.2.3.4) or a CIDR (like 1.2.3.0/24).
},
],
"netmask": "A String", # The netmask used by the VMware user cluster.
},
],
"masterIp": "A String", # Required. MasterIP is the IP announced by the master of Seesaw group.
"stackdriverName": "A String", # Name to be used by Stackdriver.
"vms": [ # Names of the VMs created for this Seesaw group.
"A String",
],
},
"vipConfig": { # Specifies the VIP config for the VMware user cluster load balancer. # The VIPs used by the load balancer.
"controlPlaneVip": "A String", # The VIP which you previously set aside for the Kubernetes API of this cluster.
"ingressVip": "A String", # The VIP which you previously set aside for ingress traffic into this cluster.
},
},
"localName": "A String", # Output only. The object name of the VMware OnPremUserCluster custom resource on the associated admin cluster. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the ID in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. All users should use this name to access their cluster using gkectl or kubectl and should expect to see the local name when viewing admin cluster controller logs.
"name": "A String", # Immutable. The VMware user cluster resource name.
"networkConfig": { # Specifies network config for the VMware user cluster. # The VMware user cluster network configuration.
"controlPlaneV2Config": { # Specifies control plane V2 config. # Configuration for control plane V2 mode.
"controlPlaneIpBlock": { # Represents a collection of IP addresses to assign to nodes. # Static IP addresses for the control plane nodes.
"gateway": "A String", # The network gateway used by the VMware user cluster.
"ips": [ # The node's network configurations used by the VMware user cluster.
{ # Represents VMware user cluster node's network configuration.
"hostname": "A String", # Hostname of the machine. VM's name will be used if this field is empty.
"ip": "A String", # IP could be an IP address (like 1.2.3.4) or a CIDR (like 1.2.3.0/24).
},
],
"netmask": "A String", # The netmask used by the VMware user cluster.
},
},
"dhcpIpConfig": { # Represents the network configuration required for the VMware user clusters with DHCP IP configurations. # Configuration settings for a DHCP IP configuration.
"enabled": True or False, # enabled is a flag to mark if DHCP IP allocation is used for VMware user clusters.
},
"hostConfig": { # Represents the common parameters for all the hosts irrespective of their IP address. # Represents common network settings irrespective of the host's IP address.
"dnsSearchDomains": [ # DNS search domains.
"A String",
],
"dnsServers": [ # DNS servers.
"A String",
],
"ntpServers": [ # NTP servers.
"A String",
],
},
"podAddressCidrBlocks": [ # Required. All pods in the cluster are assigned an RFC1918 IPv4 address from these ranges. Only a single range is supported. This field cannot be changed after creation.
"A String",
],
"serviceAddressCidrBlocks": [ # Required. All services in the cluster are assigned an RFC1918 IPv4 address from these ranges. Only a single range is supported. This field cannot be changed after creation.
"A String",
],
"staticIpConfig": { # Represents the network configuration required for the VMware user clusters with Static IP configurations. # Configuration settings for a static IP configuration.
"ipBlocks": [ # Represents the configuration values for static IP allocation to nodes.
{ # Represents a collection of IP addresses to assign to nodes.
"gateway": "A String", # The network gateway used by the VMware user cluster.
"ips": [ # The node's network configurations used by the VMware user cluster.
{ # Represents VMware user cluster node's network configuration.
"hostname": "A String", # Hostname of the machine. VM's name will be used if this field is empty.
"ip": "A String", # IP could be an IP address (like 1.2.3.4) or a CIDR (like 1.2.3.0/24).
},
],
"netmask": "A String", # The netmask used by the VMware user cluster.
},
],
},
"vcenterNetwork": "A String", # vcenter_network specifies vCenter network name. Inherited from the admin cluster.
},
"onPremVersion": "A String", # Required. The Anthos clusters on the VMware version for your user cluster.
"reconciling": True or False, # Output only. If set, there are currently changes in flight to the VMware user cluster.
"state": "A String", # Output only. The current state of VMware user cluster.
"status": { # ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). # Output only. ResourceStatus representing detailed cluster state.
"conditions": [ # ResourceCondition provide a standard mechanism for higher-level status reporting from controller.
{ # ResourceCondition provides a standard mechanism for higher-level status reporting from controller.
"lastTransitionTime": "A String", # Last time the condition transit from one status to another.
"message": "A String", # Human-readable message indicating details about last transition.
"reason": "A String", # Machine-readable message indicating details about last transition.
"state": "A String", # state of the condition.
"type": "A String", # Type of the condition. (e.g., ClusterRunning, NodePoolRunning or ServerSidePreflightReady)
},
],
"errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention.
"version": "A String", # Reflect current version of the resource.
"versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version.
"versions": [ # Shows the mapping of a given version to the number of machines under this version.
{ # Version describes the number of nodes at a given version under a resource.
"count": "A String", # Number of machines under the above version.
"version": "A String", # Resource version.
},
],
},
},
"storage": { # Specifies vSphere CSI components deployment config in the VMware user cluster. # Storage configuration.
"vsphereCsiDisabled": True or False, # Whether or not to deploy vSphere CSI components in the VMware user cluster. Enabled by default.
},
"uid": "A String", # Output only. The unique identifier of the VMware user cluster.
"updateTime": "A String", # Output only. The time at which VMware user cluster was last updated.
"upgradePolicy": { # VmwareClusterUpgradePolicy defines the cluster upgrade policy. # Specifies upgrade policy for the cluster.
"controlPlaneOnly": True or False, # Controls whether the upgrade applies to the control plane only.
},
"validationCheck": { # ValidationCheck represents the result of preflight check. # Output only. ValidationCheck represents the result of the preflight check job.
"option": "A String", # Options used for the validation check
"scenario": "A String", # Output only. The scenario when the preflight checks were run.
"status": { # ValidationCheckStatus defines the detailed validation check status. # Output only. The detailed validation check status.
"result": [ # Individual checks which failed as part of the Preflight check execution.
{ # ValidationCheckResult defines the details about the validation check.
"category": "A String", # The category of the validation.
"description": "A String", # The description of the validation check.
"details": "A String", # Detailed failure information, which might be unformatted.
"reason": "A String", # A human-readable message of the check failure.
"state": "A String", # The validation check state.
},
],
},
},
"vcenter": { # Represents configuration for the VMware VCenter for the user cluster. # VmwareVCenterConfig specifies vCenter config for the user cluster. If unspecified, it is inherited from the admin cluster.
"address": "A String", # Output only. The vCenter IP address.
"caCertData": "A String", # Contains the vCenter CA certificate public key for SSL verification.
"cluster": "A String", # The name of the vCenter cluster for the user cluster.
"datacenter": "A String", # The name of the vCenter datacenter for the user cluster.
"datastore": "A String", # The name of the vCenter datastore for the user cluster.
"folder": "A String", # The name of the vCenter folder for the user cluster.
"resourcePool": "A String", # The name of the vCenter resource pool for the user cluster.
"storagePolicyName": "A String", # The name of the vCenter storage policy for the user cluster.
},
"vmTrackingEnabled": True or False, # Enable VM tracking.
}
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Args:
resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}
list(parent, allowMissing=None, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists VMware Clusters in a given project and location.
Args:
parent: string, Required. The parent of the project and location where the clusters are listed in. Format: "projects/{project}/locations/{location}" (required)
allowMissing: boolean, Optional. If true, return list of Vmware Clusters including the ones that only exists in RMS.
filter: string, A resource filtering expression following https://google.aip.dev/160. When non-empty, only resource's whose attributes field matches the filter are returned.
pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, at most 50 clusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, A token identifying a page of results the server should return.
view: string, View for VMware clusters. When `BASIC` is specified, only the cluster resource name and admin cluster membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete cluster configuration details.
Allowed values
CLUSTER_VIEW_UNSPECIFIED - If the value is not set, the default `FULL` view is used.
BASIC - Includes basic information of a cluster resource including cluster resource name and admin cluster membership.
FULL - Includes the complete configuration for VMware cluster resource. This is the default value for ListVmwareClustersRequest method.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for listing VMware Clusters.
"nextPageToken": "A String", # A token identifying a page of results the server should return. If the token is not empty this means that more results are available and should be retrieved by repeating the request with the provided page token.
"unreachable": [ # Locations that could not be reached.
"A String",
],
"vmwareClusters": [ # The list of VMware Cluster.
{ # Resource that represents a VMware user cluster. ##
"adminClusterMembership": "A String", # Required. The admin cluster this VMware user cluster belongs to. This is the full resource name of the admin cluster's fleet membership. In the future, references to other resource types might be allowed if admin clusters are modeled as their own resources.
"adminClusterName": "A String", # Output only. The resource name of the VMware admin cluster hosting this user cluster.
"annotations": { # Annotations on the VMware user cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.
"a_key": "A String",
},
"antiAffinityGroups": { # Specifies anti affinity group config for the VMware user cluster. # AAGConfig specifies whether to spread VMware user cluster nodes across at least three physical hosts in the datacenter.
"aagConfigDisabled": True or False, # Spread nodes across at least three physical hosts (requires at least three hosts). Enabled by default.
},
"authorization": { # Authorization defines the On-Prem cluster authorization configuration to bootstrap onto the admin cluster. # RBAC policy that will be applied and managed by the Anthos On-Prem API.
"adminUsers": [ # For VMware and bare metal user clusters, users will be granted the cluster-admin role on the cluster, which provides full administrative access to the cluster. For bare metal admin clusters, users will be granted the cluster-view role, which limits users to read-only access.
{ # ClusterUser configures user principals for an RBAC policy.
"username": "A String", # Required. The name of the user, e.g. `my-gcp-id@gmail.com`.
},
],
},
"autoRepairConfig": { # Specifies config to enable/disable auto repair. The cluster-health-controller is deployed only if Enabled is true. # Configuration for auto repairing.
"enabled": True or False, # Whether auto repair is enabled.
},
"binaryAuthorization": { # Configuration for Binary Authorization. # Binary Authorization related configurations.
"evaluationMode": "A String", # Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.
},
"controlPlaneNode": { # Specifies control plane node config for the VMware user cluster. # VMware user cluster control plane nodes must have either 1 or 3 replicas.
"autoResizeConfig": { # Represents auto resizing configurations for the VMware user cluster. # AutoResizeConfig provides auto resizing configurations.
"enabled": True or False, # Whether to enable controle plane node auto resizing.
},
"cpus": "A String", # The number of CPUs for each admin cluster node that serve as control planes for this VMware user cluster. (default: 4 CPUs)
"memory": "A String", # The megabytes of memory for each admin cluster node that serves as a control plane for this VMware user cluster (default: 8192 MB memory).
"replicas": "A String", # The number of control plane nodes for this VMware user cluster. (default: 1 replica).
"vsphereConfig": { # Specifies control plane node config. # Vsphere-specific config.
"datastore": "A String", # The Vsphere datastore used by the control plane Node.
"storagePolicyName": "A String", # The Vsphere storage policy used by the control plane Node.
},
},
"createTime": "A String", # Output only. The time at which VMware user cluster was created.
"dataplaneV2": { # Contains configurations for Dataplane V2, which is optimized dataplane for Kubernetes networking. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dataplane-v2 # VmwareDataplaneV2Config specifies configuration for Dataplane V2.
"advancedNetworking": True or False, # Enable advanced networking which requires dataplane_v2_enabled to be set true.
"dataplaneV2Enabled": True or False, # Enables Dataplane V2.
"forwardMode": "A String", # Configure ForwardMode for Dataplane v2.
"windowsDataplaneV2Enabled": True or False, # Enable Dataplane V2 for clusters with Windows nodes.
},
"deleteTime": "A String", # Output only. The time at which VMware user cluster was deleted.
"description": "A String", # A human readable description of this VMware user cluster.
"disableBundledIngress": True or False, # Disable bundled ingress.
"enableControlPlaneV2": True or False, # Enable control plane V2. Default to false.
"endpoint": "A String", # Output only. The DNS name of VMware user cluster's API server.
"etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control.
"fleet": { # Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See [Anthos Fleets](`https://cloud.google.com/anthos/multicluster-management/fleets`) for more details on Anthos multi-cluster capabilities using Fleets. ## # Output only. Fleet configuration for the cluster.
"membership": "A String", # Output only. The name of the managed fleet Membership resource associated to this cluster. Membership names are formatted as `projects//locations//memberships/`.
},
"loadBalancer": { # Specifies the locad balancer config for the VMware user cluster. # Load balancer configuration.
"f5Config": { # Represents configuration parameters for an F5 BIG-IP load balancer. # Configuration for F5 Big IP typed load balancers.
"address": "A String", # The load balancer's IP address.
"partition": "A String", # The preexisting partition to be used by the load balancer. This partition is usually created for the admin cluster for example: 'my-f5-admin-partition'.
"snatPool": "A String", # The pool name. Only necessary, if using SNAT.
},
"manualLbConfig": { # Represents configuration parameters for an already existing manual load balancer. Given the nature of manual load balancers it is expected that said load balancer will be fully managed by users. IMPORTANT: Please note that the Anthos On-Prem API will not generate or update ManualLB configurations it can only bind a pre-existing configuration to a new VMware user cluster. # Manually configured load balancers.
"controlPlaneNodePort": 42, # NodePort for control plane service. The Kubernetes API server in the admin cluster is implemented as a Service of type NodePort (ex. 30968).
"ingressHttpNodePort": 42, # NodePort for ingress service's http. The ingress service in the admin cluster is implemented as a Service of type NodePort (ex. 32527).
"ingressHttpsNodePort": 42, # NodePort for ingress service's https. The ingress service in the admin cluster is implemented as a Service of type NodePort (ex. 30139).
"konnectivityServerNodePort": 42, # NodePort for konnectivity server service running as a sidecar in each kube-apiserver pod (ex. 30564).
},
"metalLbConfig": { # Represents configuration parameters for the MetalLB load balancer. # Configuration for MetalLB typed load balancers.
"addressPools": [ # Required. AddressPools is a list of non-overlapping IP pools used by load balancer typed services. All addresses must be routable to load balancer nodes. IngressVIP must be included in the pools.
{ # Represents an IP pool used by the load balancer.
"addresses": [ # Required. The addresses that are part of this pool. Each address must be either in the CIDR form (1.2.3.0/24) or range form (1.2.3.1-1.2.3.5).
"A String",
],
"avoidBuggyIps": True or False, # If true, avoid using IPs ending in .0 or .255. This avoids buggy consumer devices mistakenly dropping IPv4 traffic for those special IP addresses.
"manualAssign": True or False, # If true, prevent IP addresses from being automatically assigned.
"pool": "A String", # Required. The name of the address pool.
},
],
},
"seesawConfig": { # VmwareSeesawConfig represents configuration parameters for an already existing Seesaw load balancer. IMPORTANT: Please note that the Anthos On-Prem API will not generate or update Seesaw configurations it can only bind a pre-existing configuration to a new user cluster. IMPORTANT: When attempting to create a user cluster with a pre-existing Seesaw load balancer you will need to follow some preparation steps before calling the 'CreateVmwareCluster' API method. First you will need to create the user cluster's namespace via kubectl. The namespace will need to use the following naming convention : -gke-onprem-mgmt or -gke-onprem-mgmt depending on whether you used the 'VmwareCluster.local_name' to disambiguate collisions; for more context see the documentation of 'VmwareCluster.local_name'. Once the namespace is created you will need to create a secret resource via kubectl. This secret will contain copies of your Seesaw credentials. The Secret must be called 'user-cluster-creds' and contain Seesaw's SSH and Cert credentials. The credentials must be keyed with the following names: 'seesaw-ssh-private-key', 'seesaw-ssh-public-key', 'seesaw-ssh-ca-key', 'seesaw-ssh-ca-cert'. # Output only. Configuration for Seesaw typed load balancers.
"enableHa": True or False, # Enable two load balancer VMs to achieve a highly-available Seesaw load balancer.
"group": "A String", # Required. In general the following format should be used for the Seesaw group name: seesaw-for-[cluster_name].
"ipBlocks": [ # Required. The IP Blocks to be used by the Seesaw load balancer
{ # Represents a collection of IP addresses to assign to nodes.
"gateway": "A String", # The network gateway used by the VMware user cluster.
"ips": [ # The node's network configurations used by the VMware user cluster.
{ # Represents VMware user cluster node's network configuration.
"hostname": "A String", # Hostname of the machine. VM's name will be used if this field is empty.
"ip": "A String", # IP could be an IP address (like 1.2.3.4) or a CIDR (like 1.2.3.0/24).
},
],
"netmask": "A String", # The netmask used by the VMware user cluster.
},
],
"masterIp": "A String", # Required. MasterIP is the IP announced by the master of Seesaw group.
"stackdriverName": "A String", # Name to be used by Stackdriver.
"vms": [ # Names of the VMs created for this Seesaw group.
"A String",
],
},
"vipConfig": { # Specifies the VIP config for the VMware user cluster load balancer. # The VIPs used by the load balancer.
"controlPlaneVip": "A String", # The VIP which you previously set aside for the Kubernetes API of this cluster.
"ingressVip": "A String", # The VIP which you previously set aside for ingress traffic into this cluster.
},
},
"localName": "A String", # Output only. The object name of the VMware OnPremUserCluster custom resource on the associated admin cluster. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the ID in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. All users should use this name to access their cluster using gkectl or kubectl and should expect to see the local name when viewing admin cluster controller logs.
"name": "A String", # Immutable. The VMware user cluster resource name.
"networkConfig": { # Specifies network config for the VMware user cluster. # The VMware user cluster network configuration.
"controlPlaneV2Config": { # Specifies control plane V2 config. # Configuration for control plane V2 mode.
"controlPlaneIpBlock": { # Represents a collection of IP addresses to assign to nodes. # Static IP addresses for the control plane nodes.
"gateway": "A String", # The network gateway used by the VMware user cluster.
"ips": [ # The node's network configurations used by the VMware user cluster.
{ # Represents VMware user cluster node's network configuration.
"hostname": "A String", # Hostname of the machine. VM's name will be used if this field is empty.
"ip": "A String", # IP could be an IP address (like 1.2.3.4) or a CIDR (like 1.2.3.0/24).
},
],
"netmask": "A String", # The netmask used by the VMware user cluster.
},
},
"dhcpIpConfig": { # Represents the network configuration required for the VMware user clusters with DHCP IP configurations. # Configuration settings for a DHCP IP configuration.
"enabled": True or False, # enabled is a flag to mark if DHCP IP allocation is used for VMware user clusters.
},
"hostConfig": { # Represents the common parameters for all the hosts irrespective of their IP address. # Represents common network settings irrespective of the host's IP address.
"dnsSearchDomains": [ # DNS search domains.
"A String",
],
"dnsServers": [ # DNS servers.
"A String",
],
"ntpServers": [ # NTP servers.
"A String",
],
},
"podAddressCidrBlocks": [ # Required. All pods in the cluster are assigned an RFC1918 IPv4 address from these ranges. Only a single range is supported. This field cannot be changed after creation.
"A String",
],
"serviceAddressCidrBlocks": [ # Required. All services in the cluster are assigned an RFC1918 IPv4 address from these ranges. Only a single range is supported. This field cannot be changed after creation.
"A String",
],
"staticIpConfig": { # Represents the network configuration required for the VMware user clusters with Static IP configurations. # Configuration settings for a static IP configuration.
"ipBlocks": [ # Represents the configuration values for static IP allocation to nodes.
{ # Represents a collection of IP addresses to assign to nodes.
"gateway": "A String", # The network gateway used by the VMware user cluster.
"ips": [ # The node's network configurations used by the VMware user cluster.
{ # Represents VMware user cluster node's network configuration.
"hostname": "A String", # Hostname of the machine. VM's name will be used if this field is empty.
"ip": "A String", # IP could be an IP address (like 1.2.3.4) or a CIDR (like 1.2.3.0/24).
},
],
"netmask": "A String", # The netmask used by the VMware user cluster.
},
],
},
"vcenterNetwork": "A String", # vcenter_network specifies vCenter network name. Inherited from the admin cluster.
},
"onPremVersion": "A String", # Required. The Anthos clusters on the VMware version for your user cluster.
"reconciling": True or False, # Output only. If set, there are currently changes in flight to the VMware user cluster.
"state": "A String", # Output only. The current state of VMware user cluster.
"status": { # ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). # Output only. ResourceStatus representing detailed cluster state.
"conditions": [ # ResourceCondition provide a standard mechanism for higher-level status reporting from controller.
{ # ResourceCondition provides a standard mechanism for higher-level status reporting from controller.
"lastTransitionTime": "A String", # Last time the condition transit from one status to another.
"message": "A String", # Human-readable message indicating details about last transition.
"reason": "A String", # Machine-readable message indicating details about last transition.
"state": "A String", # state of the condition.
"type": "A String", # Type of the condition. (e.g., ClusterRunning, NodePoolRunning or ServerSidePreflightReady)
},
],
"errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention.
"version": "A String", # Reflect current version of the resource.
"versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version.
"versions": [ # Shows the mapping of a given version to the number of machines under this version.
{ # Version describes the number of nodes at a given version under a resource.
"count": "A String", # Number of machines under the above version.
"version": "A String", # Resource version.
},
],
},
},
"storage": { # Specifies vSphere CSI components deployment config in the VMware user cluster. # Storage configuration.
"vsphereCsiDisabled": True or False, # Whether or not to deploy vSphere CSI components in the VMware user cluster. Enabled by default.
},
"uid": "A String", # Output only. The unique identifier of the VMware user cluster.
"updateTime": "A String", # Output only. The time at which VMware user cluster was last updated.
"upgradePolicy": { # VmwareClusterUpgradePolicy defines the cluster upgrade policy. # Specifies upgrade policy for the cluster.
"controlPlaneOnly": True or False, # Controls whether the upgrade applies to the control plane only.
},
"validationCheck": { # ValidationCheck represents the result of preflight check. # Output only. ValidationCheck represents the result of the preflight check job.
"option": "A String", # Options used for the validation check
"scenario": "A String", # Output only. The scenario when the preflight checks were run.
"status": { # ValidationCheckStatus defines the detailed validation check status. # Output only. The detailed validation check status.
"result": [ # Individual checks which failed as part of the Preflight check execution.
{ # ValidationCheckResult defines the details about the validation check.
"category": "A String", # The category of the validation.
"description": "A String", # The description of the validation check.
"details": "A String", # Detailed failure information, which might be unformatted.
"reason": "A String", # A human-readable message of the check failure.
"state": "A String", # The validation check state.
},
],
},
},
"vcenter": { # Represents configuration for the VMware VCenter for the user cluster. # VmwareVCenterConfig specifies vCenter config for the user cluster. If unspecified, it is inherited from the admin cluster.
"address": "A String", # Output only. The vCenter IP address.
"caCertData": "A String", # Contains the vCenter CA certificate public key for SSL verification.
"cluster": "A String", # The name of the vCenter cluster for the user cluster.
"datacenter": "A String", # The name of the vCenter datacenter for the user cluster.
"datastore": "A String", # The name of the vCenter datastore for the user cluster.
"folder": "A String", # The name of the vCenter folder for the user cluster.
"resourcePool": "A String", # The name of the vCenter resource pool for the user cluster.
"storagePolicyName": "A String", # The name of the vCenter storage policy for the user cluster.
},
"vmTrackingEnabled": True or False, # Enable VM tracking.
},
],
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body, updateMask=None, validateOnly=None, x__xgafv=None)
Updates the parameters of a single VMware cluster.
Args:
name: string, Immutable. The VMware user cluster resource name. (required)
body: object, The request body.
The object takes the form of:
{ # Resource that represents a VMware user cluster. ##
"adminClusterMembership": "A String", # Required. The admin cluster this VMware user cluster belongs to. This is the full resource name of the admin cluster's fleet membership. In the future, references to other resource types might be allowed if admin clusters are modeled as their own resources.
"adminClusterName": "A String", # Output only. The resource name of the VMware admin cluster hosting this user cluster.
"annotations": { # Annotations on the VMware user cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.
"a_key": "A String",
},
"antiAffinityGroups": { # Specifies anti affinity group config for the VMware user cluster. # AAGConfig specifies whether to spread VMware user cluster nodes across at least three physical hosts in the datacenter.
"aagConfigDisabled": True or False, # Spread nodes across at least three physical hosts (requires at least three hosts). Enabled by default.
},
"authorization": { # Authorization defines the On-Prem cluster authorization configuration to bootstrap onto the admin cluster. # RBAC policy that will be applied and managed by the Anthos On-Prem API.
"adminUsers": [ # For VMware and bare metal user clusters, users will be granted the cluster-admin role on the cluster, which provides full administrative access to the cluster. For bare metal admin clusters, users will be granted the cluster-view role, which limits users to read-only access.
{ # ClusterUser configures user principals for an RBAC policy.
"username": "A String", # Required. The name of the user, e.g. `my-gcp-id@gmail.com`.
},
],
},
"autoRepairConfig": { # Specifies config to enable/disable auto repair. The cluster-health-controller is deployed only if Enabled is true. # Configuration for auto repairing.
"enabled": True or False, # Whether auto repair is enabled.
},
"binaryAuthorization": { # Configuration for Binary Authorization. # Binary Authorization related configurations.
"evaluationMode": "A String", # Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.
},
"controlPlaneNode": { # Specifies control plane node config for the VMware user cluster. # VMware user cluster control plane nodes must have either 1 or 3 replicas.
"autoResizeConfig": { # Represents auto resizing configurations for the VMware user cluster. # AutoResizeConfig provides auto resizing configurations.
"enabled": True or False, # Whether to enable controle plane node auto resizing.
},
"cpus": "A String", # The number of CPUs for each admin cluster node that serve as control planes for this VMware user cluster. (default: 4 CPUs)
"memory": "A String", # The megabytes of memory for each admin cluster node that serves as a control plane for this VMware user cluster (default: 8192 MB memory).
"replicas": "A String", # The number of control plane nodes for this VMware user cluster. (default: 1 replica).
"vsphereConfig": { # Specifies control plane node config. # Vsphere-specific config.
"datastore": "A String", # The Vsphere datastore used by the control plane Node.
"storagePolicyName": "A String", # The Vsphere storage policy used by the control plane Node.
},
},
"createTime": "A String", # Output only. The time at which VMware user cluster was created.
"dataplaneV2": { # Contains configurations for Dataplane V2, which is optimized dataplane for Kubernetes networking. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dataplane-v2 # VmwareDataplaneV2Config specifies configuration for Dataplane V2.
"advancedNetworking": True or False, # Enable advanced networking which requires dataplane_v2_enabled to be set true.
"dataplaneV2Enabled": True or False, # Enables Dataplane V2.
"forwardMode": "A String", # Configure ForwardMode for Dataplane v2.
"windowsDataplaneV2Enabled": True or False, # Enable Dataplane V2 for clusters with Windows nodes.
},
"deleteTime": "A String", # Output only. The time at which VMware user cluster was deleted.
"description": "A String", # A human readable description of this VMware user cluster.
"disableBundledIngress": True or False, # Disable bundled ingress.
"enableControlPlaneV2": True or False, # Enable control plane V2. Default to false.
"endpoint": "A String", # Output only. The DNS name of VMware user cluster's API server.
"etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control.
"fleet": { # Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See [Anthos Fleets](`https://cloud.google.com/anthos/multicluster-management/fleets`) for more details on Anthos multi-cluster capabilities using Fleets. ## # Output only. Fleet configuration for the cluster.
"membership": "A String", # Output only. The name of the managed fleet Membership resource associated to this cluster. Membership names are formatted as `projects//locations//memberships/`.
},
"loadBalancer": { # Specifies the locad balancer config for the VMware user cluster. # Load balancer configuration.
"f5Config": { # Represents configuration parameters for an F5 BIG-IP load balancer. # Configuration for F5 Big IP typed load balancers.
"address": "A String", # The load balancer's IP address.
"partition": "A String", # The preexisting partition to be used by the load balancer. This partition is usually created for the admin cluster for example: 'my-f5-admin-partition'.
"snatPool": "A String", # The pool name. Only necessary, if using SNAT.
},
"manualLbConfig": { # Represents configuration parameters for an already existing manual load balancer. Given the nature of manual load balancers it is expected that said load balancer will be fully managed by users. IMPORTANT: Please note that the Anthos On-Prem API will not generate or update ManualLB configurations it can only bind a pre-existing configuration to a new VMware user cluster. # Manually configured load balancers.
"controlPlaneNodePort": 42, # NodePort for control plane service. The Kubernetes API server in the admin cluster is implemented as a Service of type NodePort (ex. 30968).
"ingressHttpNodePort": 42, # NodePort for ingress service's http. The ingress service in the admin cluster is implemented as a Service of type NodePort (ex. 32527).
"ingressHttpsNodePort": 42, # NodePort for ingress service's https. The ingress service in the admin cluster is implemented as a Service of type NodePort (ex. 30139).
"konnectivityServerNodePort": 42, # NodePort for konnectivity server service running as a sidecar in each kube-apiserver pod (ex. 30564).
},
"metalLbConfig": { # Represents configuration parameters for the MetalLB load balancer. # Configuration for MetalLB typed load balancers.
"addressPools": [ # Required. AddressPools is a list of non-overlapping IP pools used by load balancer typed services. All addresses must be routable to load balancer nodes. IngressVIP must be included in the pools.
{ # Represents an IP pool used by the load balancer.
"addresses": [ # Required. The addresses that are part of this pool. Each address must be either in the CIDR form (1.2.3.0/24) or range form (1.2.3.1-1.2.3.5).
"A String",
],
"avoidBuggyIps": True or False, # If true, avoid using IPs ending in .0 or .255. This avoids buggy consumer devices mistakenly dropping IPv4 traffic for those special IP addresses.
"manualAssign": True or False, # If true, prevent IP addresses from being automatically assigned.
"pool": "A String", # Required. The name of the address pool.
},
],
},
"seesawConfig": { # VmwareSeesawConfig represents configuration parameters for an already existing Seesaw load balancer. IMPORTANT: Please note that the Anthos On-Prem API will not generate or update Seesaw configurations it can only bind a pre-existing configuration to a new user cluster. IMPORTANT: When attempting to create a user cluster with a pre-existing Seesaw load balancer you will need to follow some preparation steps before calling the 'CreateVmwareCluster' API method. First you will need to create the user cluster's namespace via kubectl. The namespace will need to use the following naming convention : -gke-onprem-mgmt or -gke-onprem-mgmt depending on whether you used the 'VmwareCluster.local_name' to disambiguate collisions; for more context see the documentation of 'VmwareCluster.local_name'. Once the namespace is created you will need to create a secret resource via kubectl. This secret will contain copies of your Seesaw credentials. The Secret must be called 'user-cluster-creds' and contain Seesaw's SSH and Cert credentials. The credentials must be keyed with the following names: 'seesaw-ssh-private-key', 'seesaw-ssh-public-key', 'seesaw-ssh-ca-key', 'seesaw-ssh-ca-cert'. # Output only. Configuration for Seesaw typed load balancers.
"enableHa": True or False, # Enable two load balancer VMs to achieve a highly-available Seesaw load balancer.
"group": "A String", # Required. In general the following format should be used for the Seesaw group name: seesaw-for-[cluster_name].
"ipBlocks": [ # Required. The IP Blocks to be used by the Seesaw load balancer
{ # Represents a collection of IP addresses to assign to nodes.
"gateway": "A String", # The network gateway used by the VMware user cluster.
"ips": [ # The node's network configurations used by the VMware user cluster.
{ # Represents VMware user cluster node's network configuration.
"hostname": "A String", # Hostname of the machine. VM's name will be used if this field is empty.
"ip": "A String", # IP could be an IP address (like 1.2.3.4) or a CIDR (like 1.2.3.0/24).
},
],
"netmask": "A String", # The netmask used by the VMware user cluster.
},
],
"masterIp": "A String", # Required. MasterIP is the IP announced by the master of Seesaw group.
"stackdriverName": "A String", # Name to be used by Stackdriver.
"vms": [ # Names of the VMs created for this Seesaw group.
"A String",
],
},
"vipConfig": { # Specifies the VIP config for the VMware user cluster load balancer. # The VIPs used by the load balancer.
"controlPlaneVip": "A String", # The VIP which you previously set aside for the Kubernetes API of this cluster.
"ingressVip": "A String", # The VIP which you previously set aside for ingress traffic into this cluster.
},
},
"localName": "A String", # Output only. The object name of the VMware OnPremUserCluster custom resource on the associated admin cluster. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the ID in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. All users should use this name to access their cluster using gkectl or kubectl and should expect to see the local name when viewing admin cluster controller logs.
"name": "A String", # Immutable. The VMware user cluster resource name.
"networkConfig": { # Specifies network config for the VMware user cluster. # The VMware user cluster network configuration.
"controlPlaneV2Config": { # Specifies control plane V2 config. # Configuration for control plane V2 mode.
"controlPlaneIpBlock": { # Represents a collection of IP addresses to assign to nodes. # Static IP addresses for the control plane nodes.
"gateway": "A String", # The network gateway used by the VMware user cluster.
"ips": [ # The node's network configurations used by the VMware user cluster.
{ # Represents VMware user cluster node's network configuration.
"hostname": "A String", # Hostname of the machine. VM's name will be used if this field is empty.
"ip": "A String", # IP could be an IP address (like 1.2.3.4) or a CIDR (like 1.2.3.0/24).
},
],
"netmask": "A String", # The netmask used by the VMware user cluster.
},
},
"dhcpIpConfig": { # Represents the network configuration required for the VMware user clusters with DHCP IP configurations. # Configuration settings for a DHCP IP configuration.
"enabled": True or False, # enabled is a flag to mark if DHCP IP allocation is used for VMware user clusters.
},
"hostConfig": { # Represents the common parameters for all the hosts irrespective of their IP address. # Represents common network settings irrespective of the host's IP address.
"dnsSearchDomains": [ # DNS search domains.
"A String",
],
"dnsServers": [ # DNS servers.
"A String",
],
"ntpServers": [ # NTP servers.
"A String",
],
},
"podAddressCidrBlocks": [ # Required. All pods in the cluster are assigned an RFC1918 IPv4 address from these ranges. Only a single range is supported. This field cannot be changed after creation.
"A String",
],
"serviceAddressCidrBlocks": [ # Required. All services in the cluster are assigned an RFC1918 IPv4 address from these ranges. Only a single range is supported. This field cannot be changed after creation.
"A String",
],
"staticIpConfig": { # Represents the network configuration required for the VMware user clusters with Static IP configurations. # Configuration settings for a static IP configuration.
"ipBlocks": [ # Represents the configuration values for static IP allocation to nodes.
{ # Represents a collection of IP addresses to assign to nodes.
"gateway": "A String", # The network gateway used by the VMware user cluster.
"ips": [ # The node's network configurations used by the VMware user cluster.
{ # Represents VMware user cluster node's network configuration.
"hostname": "A String", # Hostname of the machine. VM's name will be used if this field is empty.
"ip": "A String", # IP could be an IP address (like 1.2.3.4) or a CIDR (like 1.2.3.0/24).
},
],
"netmask": "A String", # The netmask used by the VMware user cluster.
},
],
},
"vcenterNetwork": "A String", # vcenter_network specifies vCenter network name. Inherited from the admin cluster.
},
"onPremVersion": "A String", # Required. The Anthos clusters on the VMware version for your user cluster.
"reconciling": True or False, # Output only. If set, there are currently changes in flight to the VMware user cluster.
"state": "A String", # Output only. The current state of VMware user cluster.
"status": { # ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). # Output only. ResourceStatus representing detailed cluster state.
"conditions": [ # ResourceCondition provide a standard mechanism for higher-level status reporting from controller.
{ # ResourceCondition provides a standard mechanism for higher-level status reporting from controller.
"lastTransitionTime": "A String", # Last time the condition transit from one status to another.
"message": "A String", # Human-readable message indicating details about last transition.
"reason": "A String", # Machine-readable message indicating details about last transition.
"state": "A String", # state of the condition.
"type": "A String", # Type of the condition. (e.g., ClusterRunning, NodePoolRunning or ServerSidePreflightReady)
},
],
"errorMessage": "A String", # Human-friendly representation of the error message from controller. The error message can be temporary as the controller controller creates a cluster or node pool. If the error message persists for a longer period of time, it can be used to surface error message to indicate real problems requiring user intervention.
"version": "A String", # Reflect current version of the resource.
"versions": { # Versions describes the mapping of a given version to the number of machines under this version. # Shows the mapping of a given version to the number of machines under this version.
"versions": [ # Shows the mapping of a given version to the number of machines under this version.
{ # Version describes the number of nodes at a given version under a resource.
"count": "A String", # Number of machines under the above version.
"version": "A String", # Resource version.
},
],
},
},
"storage": { # Specifies vSphere CSI components deployment config in the VMware user cluster. # Storage configuration.
"vsphereCsiDisabled": True or False, # Whether or not to deploy vSphere CSI components in the VMware user cluster. Enabled by default.
},
"uid": "A String", # Output only. The unique identifier of the VMware user cluster.
"updateTime": "A String", # Output only. The time at which VMware user cluster was last updated.
"upgradePolicy": { # VmwareClusterUpgradePolicy defines the cluster upgrade policy. # Specifies upgrade policy for the cluster.
"controlPlaneOnly": True or False, # Controls whether the upgrade applies to the control plane only.
},
"validationCheck": { # ValidationCheck represents the result of preflight check. # Output only. ValidationCheck represents the result of the preflight check job.
"option": "A String", # Options used for the validation check
"scenario": "A String", # Output only. The scenario when the preflight checks were run.
"status": { # ValidationCheckStatus defines the detailed validation check status. # Output only. The detailed validation check status.
"result": [ # Individual checks which failed as part of the Preflight check execution.
{ # ValidationCheckResult defines the details about the validation check.
"category": "A String", # The category of the validation.
"description": "A String", # The description of the validation check.
"details": "A String", # Detailed failure information, which might be unformatted.
"reason": "A String", # A human-readable message of the check failure.
"state": "A String", # The validation check state.
},
],
},
},
"vcenter": { # Represents configuration for the VMware VCenter for the user cluster. # VmwareVCenterConfig specifies vCenter config for the user cluster. If unspecified, it is inherited from the admin cluster.
"address": "A String", # Output only. The vCenter IP address.
"caCertData": "A String", # Contains the vCenter CA certificate public key for SSL verification.
"cluster": "A String", # The name of the vCenter cluster for the user cluster.
"datacenter": "A String", # The name of the vCenter datacenter for the user cluster.
"datastore": "A String", # The name of the vCenter datastore for the user cluster.
"folder": "A String", # The name of the vCenter folder for the user cluster.
"resourcePool": "A String", # The name of the vCenter resource pool for the user cluster.
"storagePolicyName": "A String", # The name of the vCenter storage policy for the user cluster.
},
"vmTrackingEnabled": True or False, # Enable VM tracking.
}
updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the VMwareCluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all populated fields in the VmwareCluster message will be updated. Empty fields will be ignored unless a field mask is used.
validateOnly: boolean, Validate the request without actually doing any updates.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
queryVersionConfig(parent, createConfig_adminClusterMembership=None, createConfig_adminClusterName=None, upgradeConfig_clusterName=None, x__xgafv=None)
Queries the VMware user cluster version config.
Args:
parent: string, Required. The parent of the project and location to query for version config. Format: "projects/{project}/locations/{location}" (required)
createConfig_adminClusterMembership: string, The admin cluster membership. This is the full resource name of the admin cluster's fleet membership. Format: "projects/{project}/locations/{location}/memberships/{membership}"
createConfig_adminClusterName: string, The admin cluster resource name. This is the full resource name of the admin cluster resource. Format: "projects/{project}/locations/{location}/vmwareAdminClusters/{vmware_admin_cluster}"
upgradeConfig_clusterName: string, The user cluster resource name. This is the full resource name of the user cluster resource. Format: "projects/{project}/locations/{location}/vmwareClusters/{vmware_cluster}"
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for querying VMware user cluster version config.
"versions": [ # List of available versions to install or to upgrade to.
{ # Contains information about a specific Anthos on VMware version.
"dependencies": [ # The list of upgrade dependencies for this version.
{ # UpgradeDependency represents a dependency when upgrading a resource.
"currentVersion": "A String", # Current version of the dependency e.g. 1.15.0.
"membership": "A String", # Membership names are formatted as `projects//locations//memberships/`.
"resourceName": "A String", # Resource name of the dependency.
"targetVersion": "A String", # Target version of the dependency e.g. 1.16.1. This is the version the dependency needs to be upgraded to before a resource can be upgraded.
},
],
"hasDependencies": True or False, # If set, the cluster dependencies (e.g. the admin cluster, other user clusters managed by the same admin cluster) must be upgraded before this version can be installed or upgraded to.
"isInstalled": True or False, # If set, the version is installed in the admin cluster. Otherwise, the version bundle must be downloaded and installed before a user cluster can be created at or upgraded to this version.
"version": "A String", # Version number e.g. 1.13.1-gke.1000.
},
],
}
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Args:
resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}
testIamPermissions(resource, body=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Args:
resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
"permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for `TestIamPermissions` method.
"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
"A String",
],
}
unenroll(name, allowMissing=None, etag=None, force=None, validateOnly=None, x__xgafv=None)
Unenrolls an existing VMware user cluster and its node pools from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters and node pools will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or UI.
Args:
name: string, Required. Name of the VMware user cluster to be unenrolled. Format: "projects/{project}/locations/{location}/vmwareClusters/{vmware_cluster}" (required)
allowMissing: boolean, If set to true, and the VMware cluster is not found, the request will succeed but no action will be taken on the server and return a completed LRO.
etag: string, The current etag of the VMware Cluster. If an etag is provided and does not match the current etag of the cluster, deletion will be blocked and an ABORTED error will be returned.
force: boolean, This is required if the cluster has any associated node pools. When set, any child node pools will also be unenrolled.
validateOnly: boolean, Validate the request without actually doing any updates.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}