vmware_node_pools

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

Overview

Name	vmware_node_pools
Type	Resource
Id	google.gkeonprem.vmware_node_pools

Fields

The following fields are returned by SELECT queries:

projects_locations_vmware_clusters_vmware_node_pools_get

Successful response

Name	Datatype	Description
name	string	Immutable. The resource name of this node pool.
annotations	object	Annotations 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	object	Required. The node configuration of the node pool. (id: VmwareNodeConfig)
createTime	string (google-datetime)	Output only. The time at which this node pool was created.
deleteTime	string (google-datetime)	Output only. The time at which this node pool was deleted. If the resource is not deleted, this must be empty
displayName	string	The display name for the node pool.
etag	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.
nodePoolAutoscaling	object	Node pool autoscaling config for the node pool. (id: VmwareNodePoolAutoscalingConfig)
onPremVersion	string	Anthos version for the node pool. Defaults to the user cluster version.
reconciling	boolean	Output only. If set, there are currently changes in flight to the node pool.
state	string	Output only. The current state of the node pool.
status	object	Output only. ResourceStatus representing the detailed VMware node pool state. (id: ResourceStatus)
uid	string	Output only. The unique identifier of the node pool.
updateTime	string (google-datetime)	Output only. The time at which this node pool was last updated.

projects_locations_vmware_clusters_vmware_node_pools_list

Successful response

Name	Datatype	Description
name	string	Immutable. The resource name of this node pool.
annotations	object	Annotations 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	object	Required. The node configuration of the node pool. (id: VmwareNodeConfig)
createTime	string (google-datetime)	Output only. The time at which this node pool was created.
deleteTime	string (google-datetime)	Output only. The time at which this node pool was deleted. If the resource is not deleted, this must be empty
displayName	string	The display name for the node pool.
etag	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.
nodePoolAutoscaling	object	Node pool autoscaling config for the node pool. (id: VmwareNodePoolAutoscalingConfig)
onPremVersion	string	Anthos version for the node pool. Defaults to the user cluster version.
reconciling	boolean	Output only. If set, there are currently changes in flight to the node pool.
state	string	Output only. The current state of the node pool.
status	object	Output only. ResourceStatus representing the detailed VMware node pool state. (id: ResourceStatus)
uid	string	Output only. The unique identifier of the node pool.
updateTime	string (google-datetime)	Output only. The time at which this node pool was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_vmware_clusters_vmware_node_pools_get	select	projectsId, locationsId, vmwareClustersId, vmwareNodePoolsId	view	Gets details of a single VMware node pool.
projects_locations_vmware_clusters_vmware_node_pools_list	select	projectsId, locationsId, vmwareClustersId	pageSize, pageToken, view	Lists VMware node pools in a given project, location and VMWare cluster.
projects_locations_vmware_clusters_vmware_node_pools_create	insert	projectsId, locationsId, vmwareClustersId	vmwareNodePoolId, validateOnly	Creates a new VMware node pool in a given project, location and VMWare cluster.
projects_locations_vmware_clusters_vmware_node_pools_patch	update	projectsId, locationsId, vmwareClustersId, vmwareNodePoolsId	updateMask, validateOnly	Updates the parameters of a single VMware node pool.
projects_locations_vmware_clusters_vmware_node_pools_delete	delete	projectsId, locationsId, vmwareClustersId, vmwareNodePoolsId	etag, allowMissing, validateOnly, ignoreErrors	Deletes a single VMware node pool.
projects_locations_vmware_clusters_vmware_node_pools_enroll	exec	projectsId, locationsId, vmwareClustersId		Enrolls a VMware node pool to Anthos On-Prem API
projects_locations_vmware_clusters_vmware_node_pools_unenroll	exec	projectsId, locationsId, vmwareClustersId, vmwareNodePoolsId	etag, allowMissing, validateOnly	Unenrolls a VMware node pool to Anthos On-Prem API

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
vmwareClustersId	string
vmwareNodePoolsId	string
allowMissing	boolean
etag	string
ignoreErrors	boolean
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)
validateOnly	boolean
view	string
vmwareNodePoolId	string

SELECT examples

projects_locations_vmware_clusters_vmware_node_pools_get

Gets details of a single VMware node pool.

SELECT
name,
annotations,
config,
createTime,
deleteTime,
displayName,
etag,
nodePoolAutoscaling,
onPremVersion,
reconciling,
state,
status,
uid,
updateTime
FROM google.gkeonprem.vmware_node_pools
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND vmwareClustersId = '{{ vmwareClustersId }}' -- required
AND vmwareNodePoolsId = '{{ vmwareNodePoolsId }}' -- required
AND view = '{{ view }}';

projects_locations_vmware_clusters_vmware_node_pools_list

Lists VMware node pools in a given project, location and VMWare cluster.

SELECT
name,
annotations,
config,
createTime,
deleteTime,
displayName,
etag,
nodePoolAutoscaling,
onPremVersion,
reconciling,
state,
status,
uid,
updateTime
FROM google.gkeonprem.vmware_node_pools
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND vmwareClustersId = '{{ vmwareClustersId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND view = '{{ view }}';

INSERT examples

projects_locations_vmware_clusters_vmware_node_pools_create

Creates a new VMware node pool in a given project, location and VMWare cluster.

INSERT INTO google.gkeonprem.vmware_node_pools (
data__name,
data__displayName,
data__etag,
data__annotations,
data__nodePoolAutoscaling,
data__config,
data__onPremVersion,
projectsId,
locationsId,
vmwareClustersId,
vmwareNodePoolId,
validateOnly
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ etag }}',
'{{ annotations }}',
'{{ nodePoolAutoscaling }}',
'{{ config }}',
'{{ onPremVersion }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ vmwareClustersId }}',
'{{ vmwareNodePoolId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: vmware_node_pools
  props:
    - name: projectsId
      value: string
      description: Required parameter for the vmware_node_pools resource.
    - name: locationsId
      value: string
      description: Required parameter for the vmware_node_pools resource.
    - name: vmwareClustersId
      value: string
      description: Required parameter for the vmware_node_pools resource.
    - name: name
      value: string
      description: >
        Immutable. The resource name of this node pool.
        
    - name: displayName
      value: string
      description: >
        The display name for the node pool.
        
    - name: etag
      value: string
      description: >
        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.
        
    - name: annotations
      value: object
      description: >
        Annotations 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.
        
    - name: nodePoolAutoscaling
      value: object
      description: >
        Node pool autoscaling config for the node pool.
        
    - name: config
      value: object
      description: >
        Required. The node configuration of the node pool.
        
    - name: onPremVersion
      value: string
      description: >
        Anthos version for the node pool. Defaults to the user cluster version.
        
    - name: vmwareNodePoolId
      value: string
    - name: validateOnly
      value: boolean

UPDATE examples

projects_locations_vmware_clusters_vmware_node_pools_patch

Updates the parameters of a single VMware node pool.

UPDATE google.gkeonprem.vmware_node_pools
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__etag = '{{ etag }}',
data__annotations = '{{ annotations }}',
data__nodePoolAutoscaling = '{{ nodePoolAutoscaling }}',
data__config = '{{ config }}',
data__onPremVersion = '{{ onPremVersion }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND vmwareClustersId = '{{ vmwareClustersId }}' --required
AND vmwareNodePoolsId = '{{ vmwareNodePoolsId }}' --required
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_vmware_clusters_vmware_node_pools_delete

Deletes a single VMware node pool.

DELETE FROM google.gkeonprem.vmware_node_pools
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND vmwareClustersId = '{{ vmwareClustersId }}' --required
AND vmwareNodePoolsId = '{{ vmwareNodePoolsId }}' --required
AND etag = '{{ etag }}'
AND allowMissing = '{{ allowMissing }}'
AND validateOnly = '{{ validateOnly }}'
AND ignoreErrors = '{{ ignoreErrors }}';

Lifecycle Methods

projects_locations_vmware_clusters_vmware_node_pools_enroll

Enrolls a VMware node pool to Anthos On-Prem API

EXEC google.gkeonprem.vmware_node_pools.projects_locations_vmware_clusters_vmware_node_pools_enroll 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@vmwareClustersId='{{ vmwareClustersId }}' --required 
@@json=
'{
"vmwareNodePoolId": "{{ vmwareNodePoolId }}"
}';

projects_locations_vmware_clusters_vmware_node_pools_unenroll

Unenrolls a VMware node pool to Anthos On-Prem API

EXEC google.gkeonprem.vmware_node_pools.projects_locations_vmware_clusters_vmware_node_pools_unenroll 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@vmwareClustersId='{{ vmwareClustersId }}' --required, 
@vmwareNodePoolsId='{{ vmwareNodePoolsId }}' --required, 
@etag='{{ etag }}', 
@allowMissing={{ allowMissing }}, 
@validateOnly={{ validateOnly }};