Skip to main content

Gcp/gkeonprem

@swamp/gcp/gkeonpremv2026.11.04.1· AGPL-3.0-or-later· 3d agoBEHAVIORS
01README

Google Cloud gkeonprem infrastructure models

02Release Notes
  • Updated: vmwareclusters_vmwarenodepools
03Behaviors7
@swamp/gcp/gkeonprem/baremetaladminclustersv2026.10.23.1baremetaladminclusters.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
annotations?recordAnnotations on the bare metal admin 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.
bareMetalVersion?stringThe Anthos clusters on bare metal version for the bare metal admin cluster.
binaryAuthorization?objectBinary Authorization related configurations.
clusterOperations?objectCluster operations configuration.
controlPlane?objectControl plane configuration.
description?stringA human readable description of this bare metal admin cluster.
loadBalancer?objectLoad balancer configuration.
maintenanceConfig?objectMaintenance configuration.
name?stringImmutable. The bare metal admin cluster resource name.
networkConfig?objectNetwork configuration.
nodeAccessConfig?objectNode access related configurations.
nodeConfig?objectWorkload node configuration.
osEnvironmentConfig?objectOS environment related configurations.
proxy?objectProxy configuration.
securityConfig?objectSecurity related configuration.
storage?objectStorage configuration.
allowPreflightFailure?stringOptional. 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.
bareMetalAdminClusterId?stringRequired. User provided identifier that is used as part of the resource name; must conform to RFC-1034 and additionally restrict to lower-cased letters. This comes out roughly to: /^a-z+[a-z0-9]$/
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create(waitForReady?: boolean)
Create a bareMetalAdminClusters
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
fn get(identifier: string)
Get a bareMetalAdminClusters
ArgumentTypeDescription
identifierstringThe name of the bareMetalAdminClusters
fn update(identifier?: string, waitForReady?: boolean)
Update bareMetalAdminClusters attributes
ArgumentTypeDescription
identifier?stringTarget a specific bareMetalAdminClusters by name (e.g. one discovered by list)
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
fn sync(identifier?: string)
Sync bareMetalAdminClusters state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific bareMetalAdminClusters by name (e.g. one discovered by list)
fn list(allowMissing?: boolean, pageSize?: number, view?: string, maxPages?: number)
List bareMetalAdminClusters resources
ArgumentTypeDescription
allowMissing?booleanOptional. If true, return list of BareMetal Admin Clusters including the ones that only exists in RMS.
pageSize?numberRequested 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.
view?stringView for bare metal admin clusters. When `BASIC` is specified, only the admin cluster resource name and membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete admin cluster configuration details.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn enroll(bareMetalAdminClusterId?: any, membership?: any)
enroll
ArgumentTypeDescription
bareMetalAdminClusterId?any
membership?any
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
ArgumentTypeDescription
options_requestedPolicyVersion?any
fn query_version_config(upgradeConfig_clusterName?: any)
query version config
ArgumentTypeDescription
upgradeConfig_clusterName?any
fn set_iam_policy(policy?: any)
set iam policy
ArgumentTypeDescription
policy?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
fn unenroll(allowMissing?: any, etag?: any, ignoreErrors?: any, validateOnly?: any)
unenroll
ArgumentTypeDescription
allowMissing?any
etag?any
ignoreErrors?any
validateOnly?any

Resources

state(infinite)— Resource that represents a bare metal admin cluster.
@swamp/gcp/gkeonprem/baremetalclustersv2026.10.23.1baremetalclusters.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
adminClusterMembership?stringRequired. The admin cluster this bare metal user cluster belongs to. This is the full resource name of the admin cluster's fleet membership.
annotations?recordAnnotations on the bare metal 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.
bareMetalVersion?stringRequired. The Anthos clusters on bare metal version for your user cluster.
binaryAuthorization?objectBinary Authorization related configurations.
clusterOperations?objectCluster operations configuration.
controlPlane?objectRequired. Control plane configuration.
description?stringA human readable description of this bare metal user cluster.
loadBalancer?objectRequired. Load balancer configuration.
maintenanceConfig?objectMaintenance configuration.
name?stringImmutable. The bare metal user cluster resource name.
networkConfig?objectRequired. Network configuration.
nodeAccessConfig?objectNode access related configurations.
nodeConfig?objectWorkload node configuration.
osEnvironmentConfig?objectOS environment related configurations.
proxy?objectProxy configuration.
securityConfig?objectSecurity related setting configuration.
storage?objectRequired. Storage configuration.
upgradePolicy?objectThe cluster upgrade policy.
allowPreflightFailure?stringOptional. 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.
bareMetalClusterId?stringRequired. User provided identifier that is used as part of the resource name; must conform to RFC-1034 and additionally restrict to lower-cased letters. This comes out roughly to: /^a-z+[a-z0-9]$/
allowMissing?stringIf set to true, and the bare metal cluster is not found, the request will create a new bare metal cluster with the provided configuration. The user must have both create and update permission to call Update with allow_missing set to true.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create(waitForReady?: boolean)
Create a bareMetalClusters
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
fn get(identifier: string)
Get a bareMetalClusters
ArgumentTypeDescription
identifierstringThe name of the bareMetalClusters
fn update(identifier?: string, waitForReady?: boolean)
Update bareMetalClusters attributes
ArgumentTypeDescription
identifier?stringTarget a specific bareMetalClusters by name (e.g. one discovered by list)
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
fn delete(identifier: string)
Delete the bareMetalClusters
ArgumentTypeDescription
identifierstringThe name of the bareMetalClusters
fn sync(identifier?: string)
Sync bareMetalClusters state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific bareMetalClusters by name (e.g. one discovered by list)
fn list(allowMissing?: boolean, filter?: string, pageSize?: number, view?: string, maxPages?: number)
List bareMetalClusters resources
ArgumentTypeDescription
allowMissing?booleanOptional. If true, return list of BareMetal Clusters including the ones that only exists in RMS.
filter?stringA resource filtering expression following https://google.aip.dev/160. When non-empty, only resource's whose attributes field matches the filter are returned.
pageSize?numberRequested 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.
view?stringView for bare metal 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.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn enroll(adminClusterMembership?: any, bareMetalClusterId?: any, localName?: any, localNamespace?: any)
enroll
ArgumentTypeDescription
adminClusterMembership?any
bareMetalClusterId?any
localName?any
localNamespace?any
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
ArgumentTypeDescription
options_requestedPolicyVersion?any
fn query_version_config(createConfig_adminClusterMembership?: any, createConfig_adminClusterName?: any, upgradeConfig_clusterName?: any)
query version config
ArgumentTypeDescription
createConfig_adminClusterMembership?any
createConfig_adminClusterName?any
upgradeConfig_clusterName?any
fn set_iam_policy(policy?: any)
set iam policy
ArgumentTypeDescription
policy?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
fn unenroll(allowMissing?: any, etag?: any, force?: any, validateOnly?: any)
unenroll
ArgumentTypeDescription
allowMissing?any
etag?any
force?any
validateOnly?any

Resources

state(infinite)— Resource that represents a bare metal user cluster.
@swamp/gcp/gkeonprem/baremetalclusters-baremetalnodepoolsv2026.10.23.1baremetalclusters_baremetalnodepools.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
annotations?recordAnnotations on the bare metal node pool. 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.
displayName?stringThe display name for the bare metal node pool.
name?stringImmutable. The bare metal node pool resource name.
nodePoolConfig?objectRequired. Node pool configuration.
upgradePolicy?objectThe worker node pool upgrade policy.
bareMetalNodePoolId?stringThe ID to use for the node pool, which will become the final component of the node pool's resource name. This value must be up to 63 characters, and valid characters are /a-z-/. The value must not be permitted to be a UUID (or UUID-like: anything matching /^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$/i).
allowMissing?stringIf set to true, and the bare metal node pool is not found, the request will create a new bare metal node pool with the provided configuration. The user must have both create and update permission to call Update with allow_missing set to true.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create(waitForReady?: boolean)
Create a bareMetalNodePools
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
fn get(identifier: string)
Get a bareMetalNodePools
ArgumentTypeDescription
identifierstringThe name of the bareMetalNodePools
fn update(identifier?: string, waitForReady?: boolean)
Update bareMetalNodePools attributes
ArgumentTypeDescription
identifier?stringTarget a specific bareMetalNodePools by name (e.g. one discovered by list)
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
fn delete(identifier: string)
Delete the bareMetalNodePools
ArgumentTypeDescription
identifierstringThe name of the bareMetalNodePools
fn sync(identifier?: string)
Sync bareMetalNodePools state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific bareMetalNodePools by name (e.g. one discovered by list)
fn list(pageSize?: number, view?: string, maxPages?: number)
List bareMetalNodePools resources
ArgumentTypeDescription
pageSize?numberThe maximum number of node pools to return. The service may return fewer than this value. If unspecified, at most 50 node pools will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
view?stringView for bare metal node pools. When `BASIC` is specified, only the node pool resource name is returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete node pool configuration details.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn enroll(bareMetalNodePoolId?: any, validateOnly?: any)
enroll
ArgumentTypeDescription
bareMetalNodePoolId?any
validateOnly?any
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
ArgumentTypeDescription
options_requestedPolicyVersion?any
fn set_iam_policy(policy?: any)
set iam policy
ArgumentTypeDescription
policy?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
fn unenroll(allowMissing?: any, etag?: any, validateOnly?: any)
unenroll
ArgumentTypeDescription
allowMissing?any
etag?any
validateOnly?any

Resources

state(infinite)— Resource that represents a bare metal node pool.
@swamp/gcp/gkeonprem/locationsv2026.10.23.1locations.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
namestringThe resource that owns the locations collection, if applicable.
fn get(identifier: string)
Get a locations
ArgumentTypeDescription
identifierstringThe name of the locations
fn sync(identifier?: string)
Sync locations state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific locations by name (e.g. one discovered by list)
fn list(extraLocationTypes?: string, filter?: string, pageSize?: number, maxPages?: number)
List locations resources
ArgumentTypeDescription
extraLocationTypes?stringOptional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
filter?stringA filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
pageSize?numberThe maximum number of results to return. If not set, the service selects a default.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/gkeonprem/vmwareadminclustersv2026.10.23.1vmwareadminclusters.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
addonNode?objectThe VMware admin cluster addon node configuration.
annotations?recordAnnotations on the VMware admin 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.
antiAffinityGroups?objectThe VMware admin cluster anti affinity group configuration.
authorization?objectThe VMware admin cluster authorization configuration.
autoRepairConfig?objectThe VMware admin cluster auto repair configuration.
bootstrapClusterMembership?stringThe bootstrap cluster this VMware admin cluster belongs to.
controlPlaneNode?objectThe VMware admin cluster control plane node configuration.
description?stringA human readable description of this VMware admin cluster.
enableAdvancedCluster?booleanEnable advanced cluster.
imageType?stringThe OS image type for the VMware admin cluster.
loadBalancer?objectThe VMware admin cluster load balancer configuration.
name?stringImmutable. The VMware admin cluster resource name.
networkConfig?objectThe VMware admin cluster network configuration.
onPremVersion?stringThe Anthos clusters on the VMware version for the admin cluster.
platformConfig?objectThe VMware platform configuration.
privateRegistryConfig?objectConfiguration for registry.
proxy?objectConfiguration for proxy.
vcenter?objectThe VMware admin cluster VCenter configuration.
allowPreflightFailure?stringOptional. 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.
skipValidations?stringOptional. If set, skip the specified validations.
vmwareAdminClusterId?stringRequired. User provided identifier that is used as part of the resource name; must conform to RFC-1034 and additionally restrict to lower-cased letters. This comes out roughly to: /^a-z+[a-z0-9]$/
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create(waitForReady?: boolean)
Create a vmwareAdminClusters
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
fn get(identifier: string)
Get a vmwareAdminClusters
ArgumentTypeDescription
identifierstringThe name of the vmwareAdminClusters
fn update(identifier?: string, waitForReady?: boolean)
Update vmwareAdminClusters attributes
ArgumentTypeDescription
identifier?stringTarget a specific vmwareAdminClusters by name (e.g. one discovered by list)
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
fn sync(identifier?: string)
Sync vmwareAdminClusters state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific vmwareAdminClusters by name (e.g. one discovered by list)
fn list(allowMissing?: boolean, pageSize?: number, view?: string, maxPages?: number)
List vmwareAdminClusters resources
ArgumentTypeDescription
allowMissing?booleanOptional. If true, return list of Vmware Admin Clusters including the ones that only exists in RMS.
pageSize?numberRequested 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.
view?stringView for VMware admin clusters. When `BASIC` is specified, only the admin cluster resource name and membership are returned. The default/unset value `CLUSTER_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete admin cluster configuration details.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn enroll(membership?: any, vmwareAdminClusterId?: any)
enroll
ArgumentTypeDescription
membership?any
vmwareAdminClusterId?any
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
ArgumentTypeDescription
options_requestedPolicyVersion?any
fn set_iam_policy(policy?: any)
set iam policy
ArgumentTypeDescription
policy?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
fn unenroll(allowMissing?: any, etag?: any, ignoreErrors?: any, validateOnly?: any)
unenroll
ArgumentTypeDescription
allowMissing?any
etag?any
ignoreErrors?any
validateOnly?any

Resources

state(infinite)— Resource that represents a VMware admin cluster.
@swamp/gcp/gkeonprem/vmwareclustersv2026.10.23.1vmwareclusters.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
adminClusterMembership?stringRequired. 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.
annotations?recordAnnotations 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.
antiAffinityGroups?objectAAGConfig specifies whether to spread VMware user cluster nodes across at least three physical hosts in the datacenter.
authorization?objectRBAC policy that will be applied and managed by the Anthos On-Prem API.
autoRepairConfig?objectConfiguration for auto repairing.
binaryAuthorization?objectBinary Authorization related configurations.
controlPlaneNode?objectVMware user cluster control plane nodes must have either 1 or 3 replicas.
dataplaneV2?objectVmwareDataplaneV2Config specifies configuration for Dataplane V2.
description?stringA human readable description of this VMware user cluster.
disableBundledIngress?booleanDisable bundled ingress.
enableAdvancedCluster?booleanEnable advanced cluster.
enableControlPlaneV2?booleanEnable control plane V2. Default to false.
loadBalancer?objectLoad balancer configuration.
name?stringImmutable. The VMware user cluster resource name.
networkConfig?objectThe VMware user cluster network configuration.
onPremVersion?stringRequired. The Anthos clusters on the VMware version for your user cluster.
storage?objectStorage configuration.
upgradePolicy?objectSpecifies upgrade policy for the cluster.
vcenter?objectVmwareVCenterConfig specifies vCenter config for the user cluster. If unspecified, it is inherited from the admin cluster.
vmTrackingEnabled?booleanEnable VM tracking.
allowPreflightFailure?stringOptional. 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.
skipValidations?stringOptional. List of validations to skip during cluster creation.
vmwareClusterId?stringUser 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.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create(waitForReady?: boolean)
Create a vmwareClusters
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
fn get(identifier: string)
Get a vmwareClusters
ArgumentTypeDescription
identifierstringThe name of the vmwareClusters
fn update(identifier?: string, waitForReady?: boolean)
Update vmwareClusters attributes
ArgumentTypeDescription
identifier?stringTarget a specific vmwareClusters by name (e.g. one discovered by list)
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
fn delete(identifier: string)
Delete the vmwareClusters
ArgumentTypeDescription
identifierstringThe name of the vmwareClusters
fn sync(identifier?: string)
Sync vmwareClusters state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific vmwareClusters by name (e.g. one discovered by list)
fn list(allowMissing?: boolean, filter?: string, pageSize?: number, view?: string, maxPages?: number)
List vmwareClusters resources
ArgumentTypeDescription
allowMissing?booleanOptional. If true, return list of Vmware Clusters including the ones that only exists in RMS.
filter?stringA resource filtering expression following https://google.aip.dev/160. When non-empty, only resource's whose attributes field matches the filter are returned.
pageSize?numberRequested 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.
view?stringView 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.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn enroll(adminClusterMembership?: any, localName?: any, validateOnly?: any, vmwareClusterId?: any)
enroll
ArgumentTypeDescription
adminClusterMembership?any
localName?any
validateOnly?any
vmwareClusterId?any
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
ArgumentTypeDescription
options_requestedPolicyVersion?any
fn query_version_config(createConfig_adminClusterMembership?: any, createConfig_adminClusterName?: any, upgradeConfig_clusterName?: any)
query version config
ArgumentTypeDescription
createConfig_adminClusterMembership?any
createConfig_adminClusterName?any
upgradeConfig_clusterName?any
fn set_iam_policy(policy?: any)
set iam policy
ArgumentTypeDescription
policy?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
fn unenroll(allowMissing?: any, etag?: any, force?: any, validateOnly?: any)
unenroll
ArgumentTypeDescription
allowMissing?any
etag?any
force?any
validateOnly?any

Resources

state(infinite)— Resource that represents a VMware user cluster. ##
@swamp/gcp/gkeonprem/vmwareclusters-vmwarenodepoolsv2026.11.04.1vmwareclusters_vmwarenodepools.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
apiEndpoint?stringCustom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
annotations?recordAnnotations on the node pool. 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.
config?objectRequired. The node configuration of the node pool.
displayName?stringThe display name for the node pool.
name?stringImmutable. The resource name of this node pool.
nodePoolAutoscaling?objectNode pool autoscaling config for the node pool.
onPremVersion?stringAnthos version for the node pool. Defaults to the user cluster version.
validationCheck?objectThe validation check for the node pool.
vmwareNodePoolId?stringThe ID to use for the node pool, which will become the final component of the node pool's resource name. This value must be up to 40 characters and follow RFC-1123 (https://tools.ietf.org/html/rfc1123) format. The value must not be permitted to be a UUID (or UUID-like: anything matching /^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$/i).
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create(waitForReady?: boolean)
Create a vmwareNodePools
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
fn get(identifier: string)
Get a vmwareNodePools
ArgumentTypeDescription
identifierstringThe name of the vmwareNodePools
fn update(identifier?: string, waitForReady?: boolean)
Update vmwareNodePools attributes
ArgumentTypeDescription
identifier?stringTarget a specific vmwareNodePools by name (e.g. one discovered by list)
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
fn delete(identifier: string)
Delete the vmwareNodePools
ArgumentTypeDescription
identifierstringThe name of the vmwareNodePools
fn sync(identifier?: string)
Sync vmwareNodePools state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific vmwareNodePools by name (e.g. one discovered by list)
fn list(pageSize?: number, view?: string, maxPages?: number)
List vmwareNodePools resources
ArgumentTypeDescription
pageSize?numberThe maximum number of node pools to return. The service may return fewer than this value. If unspecified, at most 50 node pools will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
view?stringView for VMware node pools. When `BASIC` is specified, only the node pool resource name is returned. The default/unset value `NODE_POOL_VIEW_UNSPECIFIED` is the same as `FULL', which returns the complete node pool configuration details.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn enroll(vmwareNodePoolId?: any)
enroll
ArgumentTypeDescription
vmwareNodePoolId?any
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
ArgumentTypeDescription
options_requestedPolicyVersion?any
fn set_iam_policy(policy?: any)
set iam policy
ArgumentTypeDescription
policy?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any
fn unenroll(allowMissing?: any, etag?: any, validateOnly?: any)
unenroll
ArgumentTypeDescription
allowMissing?any
etag?any
validateOnly?any

Resources

state(infinite)— Resource VmwareNodePool represents a VMware node pool. ##
04Previous Versions19
2026.10.23.1AGPL-3.0-or-later(was none)
  • Updated: locations, baremetaladminclusters, baremetalclusters, baremetalclusters_baremetalnodepools, vmwareadminclusters, vmwareclusters, vmwareclusters_vmwarenodepools
2026.10.13.1
  • Updated: locations, baremetaladminclusters, baremetalclusters, baremetalclusters_baremetalnodepools, vmwareadminclusters, vmwareclusters, vmwareclusters_vmwarenodepools
2026.09.07.2
  • Updated: baremetaladminclusters, baremetalclusters, baremetalclusters_baremetalnodepools, vmwareadminclusters, vmwareclusters, vmwareclusters_vmwarenodepools
2026.08.12.2
  • Updated: locations, baremetaladminclusters, baremetalclusters, baremetalclusters_baremetalnodepools, vmwareadminclusters, vmwareclusters, vmwareclusters_vmwarenodepools
2026.07.29.1
  • Updated: locations, baremetaladminclusters, baremetalclusters, baremetalclusters_baremetalnodepools, vmwareadminclusters, vmwareclusters, vmwareclusters_vmwarenodepools
2026.07.21.4
  • Updated: locations
2026.07.21.1
  • Updated: baremetaladminclusters, baremetalclusters, baremetalclusters_baremetalnodepools, vmwareadminclusters, vmwareclusters, vmwareclusters_vmwarenodepools

Added 7, removed 1 behaviors

2026.07.20.2
  • Updated: locations
2026.07.20.1
  • Updated: locations, baremetaladminclusters, baremetalclusters, baremetalclusters_baremetalnodepools, vmwareadminclusters, vmwareclusters, vmwareclusters_vmwarenodepools
2026.07.19.2
  • Updated: locations
2026.07.19.1
  • Updated: locations, baremetaladminclusters, baremetalclusters, baremetalclusters_baremetalnodepools, vmwareadminclusters, vmwareclusters, vmwareclusters_vmwarenodepools
2026.07.18.2
  • Updated: locations, baremetaladminclusters, baremetalclusters, baremetalclusters_baremetalnodepools, vmwareadminclusters, vmwareclusters, vmwareclusters_vmwarenodepools

Added 1, removed 7 behaviors

2026.07.17.2
  • Updated: baremetaladminclusters, baremetalclusters, baremetalclusters_baremetalnodepools, vmwareadminclusters, vmwareclusters, vmwareclusters_vmwarenodepools
2026.07.17.1
  • Updated: baremetaladminclusters, baremetalclusters, baremetalclusters_baremetalnodepools, vmwareadminclusters, vmwareclusters, vmwareclusters_vmwarenodepools
2026.06.08.2
  • Updated: locations, baremetaladminclusters, baremetalclusters, baremetalclusters_baremetalnodepools, vmwareadminclusters, vmwareclusters, vmwareclusters_vmwarenodepools
2026.06.07.1
  • Updated: locations, baremetaladminclusters, baremetalclusters, baremetalclusters_baremetalnodepools, vmwareadminclusters, vmwareclusters, vmwareclusters_vmwarenodepools
2026.05.26.1
  • Updated: locations
2026.05.25.1
  • Updated: locations, baremetaladminclusters, baremetalclusters, baremetalclusters_baremetalnodepools, vmwareadminclusters, vmwareclusters, vmwareclusters_vmwarenodepools

Modified 7 behaviors

2026.05.24.1
  • Updated: locations, baremetaladminclusters, baremetalclusters, baremetalclusters_baremetalnodepools, vmwareadminclusters, vmwareclusters, vmwareclusters_vmwarenodepools
05Stats
A
100 / 100
Downloads
37
Archive size
146.3 KB
Verified by Swamp
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Docs keep secrets in a vault1/1earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License2/2earned
  • Verified public repository2/2earned
06Platforms
07Labels