{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/google-kubernetes-engine/json-schema/google-kubernetes-engine-vmware-node-pool-schema.json",
  "title": "VmwareNodePool",
  "description": "Resource VmwareNodePool represents a VMware node pool. ##",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-kubernetes-engine-gkeonprem-projects-api-openapi.yml#/components/schemas/VmwareNodePool",
  "properties": {
    "config": {
      "$ref": "#/$defs/VmwareNodeConfig",
      "description": "Required. The node configuration of the node pool."
    },
    "annotations": {
      "type": "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.",
      "additionalProperties": {
        "type": "string"
      }
    },
    "uid": {
      "description": "Output only. The unique identifier of the node pool.",
      "readOnly": true,
      "type": "string"
    },
    "onPremVersion": {
      "type": "string",
      "description": "Anthos version for the node pool. Defaults to the user cluster version."
    },
    "reconciling": {
      "readOnly": true,
      "type": "boolean",
      "description": "Output only. If set, there are currently changes in flight to the node pool."
    },
    "createTime": {
      "format": "google-datetime",
      "type": "string",
      "readOnly": true,
      "description": "Output only. The time at which this node pool was created."
    },
    "status": {
      "$ref": "#/$defs/ResourceStatus",
      "description": "Output only. ResourceStatus representing the detailed VMware node pool state."
    },
    "etag": {
      "type": "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": {
      "type": "string",
      "description": "Immutable. The resource name of this node pool."
    },
    "deleteTime": {
      "description": "Output only. The time at which this node pool was deleted. If the resource is not deleted, this must be empty",
      "type": "string",
      "format": "google-datetime",
      "readOnly": true
    },
    "displayName": {
      "description": "The display name for the node pool.",
      "type": "string"
    },
    "state": {
      "description": "Output only. The current state of the node pool.",
      "readOnly": true,
      "type": "string",
      "enum": [
        "STATE_UNSPECIFIED",
        "PROVISIONING",
        "RUNNING",
        "RECONCILING",
        "STOPPING",
        "ERROR",
        "DEGRADED"
      ]
    },
    "nodePoolAutoscaling": {
      "$ref": "#/$defs/VmwareNodePoolAutoscalingConfig",
      "description": "Node pool autoscaling config for the node pool."
    },
    "updateTime": {
      "description": "Output only. The time at which this node pool was last updated.",
      "readOnly": true,
      "format": "google-datetime",
      "type": "string"
    },
    "validationCheck": {
      "$ref": "#/$defs/ValidationCheck",
      "description": "The validation check for the node pool."
    }
  },
  "type": "object",
  "$defs": {
    "NodeTaint": {
      "properties": {
        "value": {
          "description": "Value associated with the effect.",
          "type": "string"
        },
        "effect": {
          "enum": [
            "EFFECT_UNSPECIFIED",
            "NO_SCHEDULE",
            "PREFER_NO_SCHEDULE",
            "NO_EXECUTE"
          ],
          "type": "string",
          "description": "The taint effect."
        },
        "key": {
          "description": "Key associated with the effect.",
          "type": "string"
        }
      },
      "description": "NodeTaint applied to every Kubernetes node in a node pool. Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes. Node taints are permanent.",
      "type": "object"
    },
    "ResourceCondition": {
      "description": "ResourceCondition provides a standard mechanism for higher-level status reporting from controller.",
      "properties": {
        "lastTransitionTime": {
          "type": "string",
          "format": "google-datetime",
          "description": "Last time the condition transit from one status to another."
        },
        "message": {
          "description": "Human-readable message indicating details about last transition.",
          "type": "string"
        },
        "type": {
          "type": "string",
          "description": "Type of the condition. (e.g., ClusterRunning, NodePoolRunning or ServerSidePreflightReady)"
        },
        "reason": {
          "description": "Machine-readable message indicating details about last transition.",
          "type": "string"
        },
        "state": {
          "enum": [
            "STATE_UNSPECIFIED",
            "STATE_TRUE",
            "STATE_FALSE",
            "STATE_UNKNOWN"
          ],
          "type": "string",
          "description": "state of the condition."
        }
      },
      "type": "object"
    },
    "ResourceStatus": {
      "properties": {
        "errorMessage": {
          "description": "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.",
          "type": "string"
        },
        "version": {
          "description": "Reflect current version of the resource.",
          "type": "string"
        },
        "versions": {
          "$ref": "#/$defs/Versions",
          "description": "Shows the mapping of a given version to the number of machines under this version."
        },
        "conditions": {
          "type": "array",
          "description": "ResourceCondition provide a standard mechanism for higher-level status reporting from controller.",
          "items": {
            "$ref": "#/$defs/ResourceCondition"
          }
        }
      },
      "description": "ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED).",
      "type": "object"
    },
    "ValidationCheck": {
      "description": "ValidationCheck represents the result of preflight check.",
      "properties": {
        "option": {
          "description": "Options used for the validation check",
          "type": "string",
          "enum": [
            "OPTIONS_UNSPECIFIED",
            "SKIP_VALIDATION_CHECK_BLOCKING",
            "SKIP_VALIDATION_ALL"
          ]
        },
        "scenario": {
          "readOnly": true,
          "type": "string",
          "enum": [
            "SCENARIO_UNSPECIFIED",
            "CREATE",
            "UPDATE"
          ],
          "description": "Output only. The scenario when the preflight checks were run."
        },
        "status": {
          "$ref": "#/$defs/ValidationCheckStatus",
          "description": "Output only. The detailed validation check status."
        }
      },
      "type": "object"
    },
    "ValidationCheckResult": {
      "properties": {
        "category": {
          "description": "The category of the validation.",
          "type": "string"
        },
        "description": {
          "description": "The description of the validation check.",
          "type": "string"
        },
        "details": {
          "type": "string",
          "description": "Detailed failure information, which might be unformatted."
        },
        "reason": {
          "description": "A human-readable message of the check failure.",
          "type": "string"
        },
        "state": {
          "description": "The validation check state.",
          "type": "string",
          "enum": [
            "STATE_UNKNOWN",
            "STATE_FAILURE",
            "STATE_SKIPPED",
            "STATE_FATAL",
            "STATE_WARNING"
          ]
        }
      },
      "description": "ValidationCheckResult defines the details about the validation check.",
      "type": "object"
    },
    "ValidationCheckStatus": {
      "description": "ValidationCheckStatus defines the detailed validation check status.",
      "type": "object",
      "properties": {
        "result": {
          "items": {
            "$ref": "#/$defs/ValidationCheckResult"
          },
          "type": "array",
          "description": "Individual checks which failed as part of the Preflight check execution."
        }
      }
    },
    "Version": {
      "properties": {
        "version": {
          "type": "string",
          "description": "Resource version."
        },
        "count": {
          "format": "int64",
          "description": "Number of machines under the above version.",
          "type": "string"
        }
      },
      "type": "object",
      "description": "Version describes the number of nodes at a given version under a resource."
    },
    "Versions": {
      "type": "object",
      "properties": {
        "versions": {
          "items": {
            "$ref": "#/$defs/Version"
          },
          "description": "Shows the mapping of a given version to the number of machines under this version.",
          "type": "array"
        }
      },
      "description": "Versions describes the mapping of a given version to the number of machines under this version."
    },
    "VmwareNodeConfig": {
      "type": "object",
      "description": "Parameters that describe the configuration of all nodes within a given node pool.",
      "properties": {
        "labels": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/",
          "type": "object"
        },
        "memoryMb": {
          "format": "int64",
          "description": "The megabytes of memory for each node in the node pool.",
          "type": "string"
        },
        "bootDiskSizeGb": {
          "format": "int64",
          "type": "string",
          "description": "VMware disk size to be used during creation."
        },
        "image": {
          "description": "The OS image name in vCenter, only valid when using Windows.",
          "type": "string"
        },
        "vsphereConfig": {
          "$ref": "#/$defs/VmwareVsphereConfig",
          "description": "Specifies the vSphere config for node pool."
        },
        "enableLoadBalancer": {
          "description": "Allow node pool traffic to be load balanced. Only works for clusters with MetalLB load balancers.",
          "type": "boolean"
        },
        "taints": {
          "type": "array",
          "description": "The initial taints assigned to nodes of this node pool.",
          "items": {
            "$ref": "#/$defs/NodeTaint"
          }
        },
        "cpus": {
          "description": "The number of CPUs for each node in the node pool.",
          "type": "string",
          "format": "int64"
        },
        "imageType": {
          "description": "Required. The OS image to be used for each node in a node pool. Currently `cos`, `cos_cgv2`, `ubuntu`, `ubuntu_cgv2`, `ubuntu_containerd` and `windows` are supported.",
          "type": "string"
        },
        "replicas": {
          "description": "The number of nodes in the node pool.",
          "format": "int64",
          "type": "string"
        }
      }
    },
    "VmwareNodePoolAutoscalingConfig": {
      "description": "NodePoolAutoscaling config for the NodePool to allow for the kubernetes to scale NodePool.",
      "type": "object",
      "properties": {
        "minReplicas": {
          "type": "integer",
          "format": "int32",
          "description": "Minimum number of replicas in the NodePool."
        },
        "maxReplicas": {
          "description": "Maximum number of replicas in the NodePool.",
          "type": "integer",
          "format": "int32"
        }
      }
    },
    "VmwareVsphereConfig": {
      "properties": {
        "hostGroups": {
          "description": "Vsphere host groups to apply to all VMs in the node pool",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "datastore": {
          "type": "string",
          "description": "The name of the vCenter datastore. Inherited from the user cluster."
        },
        "tags": {
          "items": {
            "$ref": "#/$defs/VmwareVsphereTag"
          },
          "type": "array",
          "description": "Tags to apply to VMs."
        }
      },
      "type": "object",
      "description": "VmwareVsphereConfig represents configuration for the VMware VCenter for node pool."
    },
    "VmwareVsphereTag": {
      "description": "VmwareVsphereTag describes a vSphere tag to be placed on VMs in the node pool. For more information, see https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-E8E854DD-AA97-4E0C-8419-CE84F93C4058.html",
      "properties": {
        "category": {
          "description": "The Vsphere tag category.",
          "type": "string"
        },
        "tag": {
          "description": "The Vsphere tag name.",
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}