Oracle Cluster API

openapi: 3.2.0
info:
  description: "Use the Oracle Cloud VMware API to create SDDCs and manage ESXi hosts and software. \nFor more information, see [Oracle Cloud VMware Solution](/iaas/Content/VMware/Concepts/ocvsoverview.htm).\n"
  title: Oracle Cloud VMware Solution Cluster API
  version: '20230701'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/0ad4a7e38b48f3a2cbc0d7ed0bde083759a3aaafa2b2bd5a8e5ced4dbe7541d0.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Oracle Cloud VMware Solution API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/0ad4a7e38b48f3a2cbc0d7ed0bde083759a3aaafa2b2bd5a8e5ced4dbe7541d0.yaml
    what: the harvested document for Oracle Cloud VMware Solution API
servers:
- url: http://127.0.0.1/20230701
- url: https://127.0.0.1/20230701
tags:
- name: cluster
paths:
  /clusters:
    get:
      description: 'Lists the Clusters in the specified compartment.

        '
      operationId: ListClusters
      parameters:
      - $ref: '#/components/parameters/SddcIdentifierQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/LifecycleState'
      - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
      responses:
        200:
          description: The list is being retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages

                of results remain. For important details about how pagination works, see

                [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists the Clusters in the specified SDDC.
      tags:
      - cluster
      x-related-resource: '#/definitions/ClusterSummary'
    post:
      description: 'Create a vSphere Cluster in software-defined data center (SDDC).


        Use the [WorkRequest](#/en/vmware/20230701/WorkRequest/) operations to track the

        creation of the Cluster.


        **Important:** You must configure the Cluster''s networking resources with the security rules detailed in [Security Rules for Oracle Cloud VMware Solution SDDCs](/iaas/Content/VMware/Reference/ocvssecurityrules.htm). Otherwise, provisioning the SDDC will fail. The rules are based on the requirements set by VMware.

        '
      operationId: CreateCluster
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: The request was accepted and the Cluster will be created.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Create a Cluster
      tags:
      - cluster
      x-related-resource: '#/definitions/Cluster'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateClusterDetails'
        description: Details for the Cluster.
        required: true
  /clusters/{clusterId}:
    delete:
      description: 'Deletes the specified Cluster, along with the other resources that were

        created with the Cluster. For example: the Compute instances, DNS records,

        and so on.


        Use the [WorkRequest](#/en/vmware/20230701/WorkRequest/) operations to track the

        deletion of the Cluster.

        '
      operationId: DeleteCluster
      parameters:
      - $ref: '#/components/parameters/ClusterIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: The request was accepted and the Cluster will be deleted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Deletes the specified Cluster
      tags:
      - cluster
      x-related-resource: '#/definitions/Cluster'
    get:
      description: Gets the specified Cluster's information.
      operationId: GetCluster
      parameters:
      - $ref: '#/components/parameters/ClusterIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The Cluster was retrieved.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cluster'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get Cluster
      tags:
      - cluster
      x-related-resource: '#/definitions/Cluster'
    put:
      description: 'Updates the specified Cluster.


        **Important:** Updating a Cluster affects only certain attributes in the `Cluster`

        object and does not affect the VMware environment currently running in

        the Cluster.

        '
      operationId: UpdateCluster
      parameters:
      - $ref: '#/components/parameters/ClusterIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The Cluster was updated.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cluster'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Updates the specified Cluster
      tags:
      - cluster
      x-related-resource: '#/definitions/Cluster'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateClusterDetails'
        description: The information to be updated.
        required: true
components:
  parameters:
    SddcIdentifierQueryParam:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC.

        '
      in: query
      name: sddcId
      required: false
      x-default-description: 'null'
      schema:
        type: string
    SortByQueryParam:
      description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for

        TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME

        sort order is case sensitive.


        **Note:** In general, some "List" operations (for example, `ListInstances`) let you

        optionally filter by availability domain if the scope of the resource type is within a

        single availability domain. If you call one of these "List" operations without specifying

        an availability domain, the resources are grouped by availability domain, then sorted.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    CompartmentIdOptionalQueryParam:
      description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment as optional parameter.
      in: query
      name: compartmentId
      required: false
      schema:
        type: string
    ClusterIdentifierPathParam:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC Cluster.

        '
      in: path
      name: clusterId
      required: true
      schema:
        type: string
    SortOrderQueryParam:
      description: 'The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order

        is case sensitive.

        '
      in: query
      name: sortOrder
      x-obmcs-top-level-enum: '#/definitions/SortOrders'
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: ASC
    LifecycleState:
      description: The lifecycle state of the resource.
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/LifecycleStates'
      schema:
        type: string
        enum:
        - CREATING
        - UPDATING
        - ACTIVE
        - DELETING
        - DELETED
        - FAILED
    RequestIdHeader:
      description: 'Unique identifier for the request. If you need to contact Oracle about a particular

        request, please provide the request ID.

        '
      in: header
      name: opc-request-id
      schema:
        type: string
    PaginationTokenQueryParam:
      description: 'For list pagination. The value of the `opc-next-page` response header from the previous "List"

        call. For important details about how pagination works, see

        [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      in: query
      name: page
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 1024
        minLength: 1
    DisplayNameQueryParam:
      description: A filter to return only resources that match the given display name exactly.
      in: query
      name: displayName
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    RetryTokenHeader:
      description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or

        server error without risk of executing that same action again. Retry tokens expire after 24

        hours, but can be invalidated before then due to conflicting operations (for example, if a resource

        has been deleted and purged from the system, then a retry of the original creation request

        may be rejected).

        '
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
        maxLength: 64
        minLength: 1
    PaginationLimitQueryParam:
      description: 'For list pagination. The maximum number of results per page, or items to return in a paginated

        "List" call. For important details about how pagination works, see

        [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      in: query
      name: limit
      x-default-description: 'null'
      schema:
        type: integer
        default: 10
        maximum: 1000
        minimum: 1
    IfMatchHeader:
      description: 'For optimistic concurrency control. In the PUT or DELETE call

        for a resource, set the `if-match` parameter to the value of the

        etag from a previous GET or POST response for that resource.

        The resource will be updated or deleted only if the etag you

        provide matches the resource''s current etag value.

        '
      in: header
      name: if-match
      required: false
      schema:
        type: string
  schemas:
    DatastoreDetails:
      description: 'Datastore details for a getting an Sddc.

        '
      properties:
        blockVolumeIds:
          description: A list of [OCID](/Content/General/Concepts/identifiers.htm)s of Block Storage Volumes.
          items:
            maxLength: 255
            minLength: 1
            type: string
          type: array
        capacity:
          description: Size of the Block Storage Volume in GB.
          format: double
          type: number
        datastoreType:
          description: Type of the datastore.
          enum:
          - MANAGEMENT
          - WORKLOAD
          type: string
          x-obmcs-top-level-enum: '#/definitions/DatastoreTypes'
      required:
      - blockVolumeIds
      - datastoreType
      - capacity
      type: object
    VsphereLicense:
      description: 'License for vSphere upgrade.

        '
      properties:
        licenseKey:
          description: vSphere license key value.
          type: string
        licenseType:
          description: vSphere license type.
          type: string
      required:
      - licenseType
      - licenseKey
    CreateClusterDetails:
      description: Details of the Cluster.
      properties:
        capacityReservationId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Capacity Reservation.

            '
          maxLength: 255
          minLength: 1
          type: string
        clusterByolAllocationDetails:
          $ref: '#/components/schemas/ClusterByolAllocationDetails'
        computeAvailabilityDomain:
          description: 'The availability domain to create the Cluster''s ESXi hosts in. For multi-AD Cluster deployment, set to `multi-AD`.

            '
          maxLength: 64
          minLength: 1
          type: string
        datastoreClusterIds:
          description: 'A list of datastore clusters.

            '
          items:
            maxLength: 255
            minLength: 1
            type: string
          type: array
        datastores:
          description: 'A list of datastore info for the Cluster.

            This value is required only when `initialHostShapeName` is a standard shape.

            '
          items:
            $ref: '#/components/schemas/DatastoreInfo'
          type: array
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a

            namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: 'A descriptive name for the Cluster.

            Cluster name requirements are 1-22 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the region.

            Avoid entering confidential information.

            '
          maxLength: 22
          minLength: 1
          type: string
        esxiHostsCount:
          description: "The number of ESXi hosts to create in the Cluster. You can add more hosts later\n(see [CreateEsxiHost](#/en/vmware/20200501/EsxiHost/CreateEsxiHost)). \n\n**Note:** If you later delete EXSi hosts from a production Cluster to make SDDC\ntotal host count less than 3, you are still billed for the 3 minimum recommended \nESXi hosts. Also, you cannot add more VMware workloads to the Cluster until the \nSDDC again has at least 3 ESXi hosts.\n"
          maximum: 64
          minimum: 1
          type: integer
        esxiSoftwareVersion:
          description: "The ESXi software bundle to install on the ESXi hosts in the Cluster. \nOnly versions under the same vmwareSoftwareVersion and have been validate by Oracle Cloud VMware Solution will be accepted.\nTo get a list of the available versions, use\n[ListSupportedVmwareSoftwareVersions](#/en/vmware/20230701/SupportedVmwareSoftwareVersionSummary/ListSupportedVmwareSoftwareVersions).\n"
          maxLength: 64
          minLength: 1
          type: string
          x-default-description: When unspecified, the latest supported ESXi software version will be deployed.
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no

            predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        initialCommitment:
          default: HOUR
          description: 'The billing option selected during Cluster creation.

            [ListSupportedCommitments](#/en/vmware/20200501/SupportedCommitmentSummary/ListSupportedCommitments).

            '
          enum:
          - HOUR
          - MONTH
          - ONE_YEAR
          - THREE_YEARS
          type: string
          x-default-description: Default initialCommitment is "HOUR".
          x-obmcs-top-level-enum: '#/definitions/Commitment'
        initialHostOcpuCount:
          description: 'The initial OCPU count of the Cluster''s ESXi hosts.

            '
          format: float
          minimum: 0
          type: number
          x-default-description: When unspecified, it will use the default OCPU count of the initial ESXi host shape.
        initialHostShapeName:
          default: BM.DenseIO2.52
          description: 'The initial compute shape of the Cluster''s ESXi hosts.

            [ListSupportedHostShapes](#/en/vmware/20200501/SupportedHostShapes/ListSupportedHostShapes).

            '
          type: string
        initialVcfByolAllocationId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the initial VMware BYOL Allocation used to deploy VMware Cloud Foundation.

            '
          maxLength: 255
          minLength: 1
          type: string
        instanceDisplayNamePrefix:
          description: 'A prefix used in the name of each ESXi host and Compute instance in the Cluster.

            If this isn''t set, the Cluster''s `displayName` is used as the prefix.


            For example, if the value is `myCluster`, the ESXi hosts are named `myCluster-1`,

            `myCluster-2`, and so on.

            '
          maxLength: 22
          minLength: 1
          type: string
        isShieldedInstanceEnabled:
          default: false
          description: 'Indicates whether shielded instance is enabled for this Cluster.

            '
          type: boolean
        networkConfiguration:
          $ref: '#/components/schemas/NetworkConfiguration'
        sddcId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC that the

            Cluster belongs to.

            '
          type: string
        vmwareSoftwareVersion:
          description: 'The VMware software bundle to install on the ESXi hosts in the Cluster. To get a list of the available versions, use

            [ListSupportedVmwareSoftwareVersions](#/en/vmware/20230701/SupportedVmwareSoftwareVersionSummary/ListSupportedVmwareSoftwareVersions).

            '
          maxLength: 32
          minLength: 1
          type: string
          x-default-description: When unspecified, the same version as configured on the SDDC will be deployed.
        workloadNetworkCidr:
          description: 'The CIDR block for the IP addresses that VMware VMs in the Cluster use to run application

            workloads.

            '
          maxLength: 20
          minLength: 1
          type: string
      required:
      - sddcId
      - computeAvailabilityDomain
      - esxiHostsCount
      - networkConfiguration
      type: object
    VsphereUpgradeObject:
      description: 'Binary object needed for vSphere upgrade

        '
      properties:
        downloadLink:
          description: Binary object download link.
          type: string
        linkDescription:
          description: Binary object description.
          type: string
      required:
      - downloadLink
      - linkDescription
    Cluster:
      description: 'An [Oracle Cloud VMware Solution](/iaas/Content/VMware/Concepts/ocvsoverview.htm) Cluster contains the resources required for a

        functional VMware environment. Instances in a Cluster

        (see [EsxiHost](#/en/vmware/20200501/EsxiHost/)) run in a virtual cloud network (VCN)

        and are preconfigured with VMware and storage. Use the vCenter utility to manage

        and deploy VMware virtual machines (VMs) in the Cluster.


        The Cluster uses a single management subnet for provisioning the Cluster. It also uses a

        set of VLANs for various components of the VMware environment (vSphere, vMotion,

        vSAN, and so on). See the Core Services API for information about VCN subnets and VLANs.

        '
      properties:
        capacityReservationId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Capacity Reservation.

            '
          maxLength: 255
          minLength: 1
          type: string
        clusterByolAllocationDetails:
          $ref: '#/components/schemas/ClusterByolAllocationDetails'
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that

            contains the Cluster.

            '
          type: string
        computeAvailabilityDomain:
          description: 'The availability domain the ESXi hosts are running in. For Multi-AD Cluster, it is `multi-AD`.


            Example: `Uocm:PHX-AD-1`, `multi-AD`

            '
          type: string
        datastoreClusterIds:
          description: 'A list of datastore clusters.

            '
          items:
            maxLength: 255
            minLength: 1
            type: string
          type: array
        datastores:
          description: 'Datastores used for the Cluster.

            '
          items:
            $ref: '#/components/schemas/DatastoreDetails'
          type: array
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a

            namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: 'A descriptive name for the Cluster. It must be unique, start with a letter, and contain only letters, digits,

            whitespaces, dashes and underscores.

            Avoid entering confidential information.

            '
          type: string
        esxiHostsCount:
          description: The number of ESXi hosts in the Cluster.
          type: integer
        esxiSoftwareVersion:
          description: "In general, this is a specific version of bundled ESXi software supported by\nOracle Cloud VMware Solution (see\n[ListSupportedVmwareSoftwareVersions](#/en/vmware/20230701/SupportedVmwareSoftwareVersionSummary/ListSupportedVmwareSoftwareVersions)).\n\nThis attribute is not guaranteed to reflect the version of\nsoftware currently installed on the ESXi hosts in the SDDC. The purpose\nof this attribute is to show the version of software that the Oracle\nCloud VMware Solution will install on any new ESXi hosts that you *add to this\nSDDC in the future* with [CreateEsxiHost](#/en/vmware/20230701/EsxiHost/CreateEsxiHost) \nunless a different version is configured on the ESXi host level.\n\nTherefore, if you upgrade the existing ESXi hosts in the Cluster to use a newer\nversion of bundled ESXi software supported by the Oracle Cloud VMware Solution, you\nshould use [UpdateCluster](#/en/vmware/20200501/Cluster/UpdateCluster) to update the Cluster's\n`esxiSoftwareVersion` with that new version.\n"
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no

            predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Cluster.

            '
          type: string
        initialCommitment:
          description: 'The billing option selected during Cluster creation.

            [ListSupportedCommitments](#/en/vmware/20200501/SupportedCommitmentSummary/ListSupportedCommitments).

            '
          enum:
          - HOUR
          - MONTH
          - ONE_YEAR
          - THREE_YEARS
          type: string
          x-default-description: Default initialCommitment is "HOUR".
          x-obmcs-top-level-enum: '#/definitions/Commitment'
        initialHostOcpuCount:
          description: 'The initial OCPU count of the Cluster''s ESXi hosts.

            '
          format: float
          minimum: 0
          type: number
        initialHostShapeName:
          description: 'The initial compute shape of the Cluster''s ESXi hosts.

            [ListSupportedHostShapes](#/en/vmware/20200501/SupportedHostShapes/ListSupportedHostShapes).

            '
          type: string
        initialVcfByolAllocationId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the initial VMware BYOL Allocation used to deploy VMware Cloud Foundation.

            '
          maxLength: 255
          minLength: 1
          type: string
        instanceDisplayNamePrefix:
          description: 'A prefix used in the name of each ESXi host and Compute instance in the Cluster.

            If this isn''t set, the Cluster''s `displayName` is used as the prefix.


            For example, if the value is `MyCluster`, the ESXi hosts are named `MyCluster-1`,

            `MyCluster-2`, and so on.

            '
          type: string
        isShieldedInstanceEnabled:
          default: false
          description: 'Indicates whether shielded instance is enabled at the Cluster level.

            '
          type: boolean
        lifecycleState:
          description: The current state of the Cluster.
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - DELETED
          - FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleStates'
        networkConfiguration:
          $ref: '#/components/schemas/NetworkConfiguration'
        sddcId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC that the

            Cluster belongs to.

            '
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

            Example: `{orcl-cloud: {free-tier-retain: true}}`

            '
          type: object
        timeCreated:
          description: 'The date and time the Cluster was created, in the format defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339).


            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the Cluster was updated, in the format defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
        upgradeLicenses:
          description: 'The vSphere licenses to use when upgrading the Cluster.

            '
          items:
            $ref: '#/components/schemas/VsphereLicense'
          type: array
        vmwareSoftwareVersion:
          description: 'In general, this is a specific version of bundled VMware software supported by

            Oracle Cloud VMware Solution (see

            [ListSupportedVmwareSoftwareVersions](#/en/vmware/20200501/Sup

# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-cluster-api-openapi.yml