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:
  schemas:
    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
    NetworkConfiguration:
      description: 'The network configurations used by Cluster, including

        [OCIDs](/Content/General/Concepts/identifiers.htm) of the management subnet and VLANs.

        '
      properties:
        hcxVlanId:
          description: "The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC\nfor the HCX component of the VMware environment. This VLAN is a mandatory attribute \nfor Management Cluster when HCX is enabled.\n\nThis attribute is not guaranteed to reflect the HCX VLAN\ncurrently used by the ESXi hosts in the SDDC. The purpose\nof this attribute is to show the HCX VLAN that the Oracle\nCloud VMware Solution will use for any new ESXi hosts that you *add to this\nSDDC in the future* with [CreateEsxiHost](#/en/vmware/20230701/EsxiHost/CreateEsxiHost).\n\nTherefore, if you change the existing ESXi hosts in the SDDC to use a different VLAN\nfor the HCX component of the VMware environment, you\nshould use [UpdateSddc](#/en/vmware/20230701/Sddc/UpdateSddc) to update the SDDC's\n`hcxVlanId` with that new VLAN's OCID.\n"
          type: string
        nsxEdgeUplink1VlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC

            for the NSX Edge Uplink 1 component of the VMware environment. This VLAN is a mandatory

            attribute for Management Cluster.


            This attribute is not guaranteed to reflect the NSX Edge Uplink 1 VLAN

            currently used by the ESXi hosts in the Cluster. The purpose

            of this attribute is to show the NSX Edge Uplink 1 VLAN that the Oracle

            Cloud VMware Solution will use for any new ESXi hosts that you *add to this

            Cluster in the future* with [CreateEsxiHost](#/en/vmware/20200501/EsxiHost/CreateEsxiHost).


            Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN

            for the NSX Edge Uplink 1 component of the VMware environment, you

            should use [UpdateCluster](#/en/vmware/20200501/Cluster/UpdateCluster) to update the Cluster''s

            `nsxEdgeUplink1VlanId` with that new VLAN''s OCID.

            '
          type: string
        nsxEdgeUplink2VlanId:
          description: "The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC \nfor the NSX Edge Uplink 2 component of the VMware environment. This VLAN is a mandatory\nattribute for Management Cluster.\n\nThis attribute is not guaranteed to reflect the NSX Edge Uplink 2 VLAN\ncurrently used by the ESXi hosts in the Cluster. The purpose\nof this attribute is to show the NSX Edge Uplink 2 VLAN that the Oracle\nCloud VMware Solution will use for any new ESXi hosts that you *add to this\nCluster in the future* with [CreateEsxiHost](#/en/vmware/20200501/EsxiHost/CreateEsxiHost).\n\nTherefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN\nfor the NSX Edge Uplink 2 component of the VMware environment, you\nshould use [UpdateCluster](#/en/vmware/20200501/Cluster/UpdateCluster) to update the Cluster's\n`nsxEdgeUplink2VlanId` with that new VLAN's OCID.\n"
          type: string
        nsxEdgeVTepVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster

            for the NSX Edge VTEP component of the VMware environment.


            This attribute is not guaranteed to reflect the NSX Edge VTEP VLAN

            currently used by the ESXi hosts in the Cluster. The purpose

            of this attribute is to show the NSX Edge VTEP VLAN that the Oracle

            Cloud VMware Solution will use for any new ESXi hosts that you *add to this

            Cluster in the future* with [CreateEsxiHost](#/en/vmware/20200501/EsxiHost/CreateEsxiHost).


            Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN

            for the NSX Edge VTEP component of the VMware environment, you

            should use [UpdateCluster](#/en/vmware/20200501/Cluster/UpdateCluster) to update the Cluster''s

            `nsxEdgeVTepVlanId` with that new VLAN''s OCID.

            '
          type: string
        nsxVTepVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster

            for the NSX VTEP component of the VMware environment.


            This attribute is not guaranteed to reflect the NSX VTEP VLAN

            currently used by the ESXi hosts in the Cluster. The purpose

            of this attribute is to show the NSX VTEP VLAN that the Oracle

            Cloud VMware Solution will use for any new ESXi hosts that you *add to this

            Cluster in the future* with [CreateEsxiHost](#/en/vmware/20200501/EsxiHost/CreateEsxiHost).


            Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN

            for the NSX VTEP component of the VMware environment, you

            should use [UpdateCluster](#/en/vmware/20200501/Cluster/UpdateCluster) to update the Cluster''s

            `nsxVTepVlanId` with that new VLAN''s OCID.

            '
          type: string
        provisioningSubnetId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the management subnet used

            to provision the Cluster.

            '
          type: string
        provisioningVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster

            for the Provisioning component of the VMware environment.

            '
          type: string
        replicationVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster

            for the vSphere Replication component of the VMware environment.

            '
          type: string
        vmotionVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster

            for the vMotion component of the VMware environment.


            This attribute is not guaranteed to reflect the vMotion VLAN

            currently used by the ESXi hosts in the Cluster. The purpose

            of this attribute is to show the vMotion VLAN that the Oracle

            Cloud VMware Solution will use for any new ESXi hosts that you *add to this

            Cluster in the future* with [CreateEsxiHost](#/en/vmware/20200501/EsxiHost/CreateEsxiHost).


            Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN

            for the vMotion component of the VMware environment, you

            should use [UpdateCluster](#/en/vmware/20200501/Sddc/UpdateCluster) to update the Cluster''s

            `vmotionVlanId` with that new VLAN''s OCID.

            '
          type: string
        vsanVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster

            for the vSAN component of the VMware environment.


            This attribute is not guaranteed to reflect the vSAN VLAN

            currently used by the ESXi hosts in the Cluster. The purpose

            of this attribute is to show the vSAN VLAN that the Oracle

            Cloud VMware Solution will use for any new ESXi hosts that you *add to this

            Cluster in the future* with [CreateEsxiHost](#/en/vmware/20200501/EsxiHost/CreateEsxiHost).


            Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN

            for the vSAN component of the VMware environment, you

            should use [UpdateCluster](#/en/vmware/20200501/Cluster/UpdateCluster) to update the Cluster''s

            `vsanVlanId` with that new VLAN''s OCID.

            '
          type: string
        vsphereVlanId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC

            for the vSphere component of the VMware environment. This VLAN is a mandatory attribute

            for Management Cluster.


            This attribute is not guaranteed to reflect the vSphere VLAN

            currently used by the ESXi hosts in the Cluster. The purpose

            of this attribute is to show the vSphere VLAN that the Oracle

            Cloud VMware Solution will use for any new ESXi hosts that you *add to this

            Cluster in the future* with [CreateEsxiHost](#/en/vmware/20200501/EsxiHost/CreateEsxiHost).


            Therefore, if you change the existing ESXi hosts in the Cluster to use a different VLAN

            for the vSphere component of the VMware environment, you

            should use [UpdateCluster](#/en/vmware/20200501/Sddc/UpdateSddc) to update the Cluster''s

            `vsphereVlanId` with that new VLAN''s OCID.

            '
          type: string
      required:
      - provisioningSubnetId
      - vmotionVlanId
      - vsanVlanId
      - nsxVTepVlanId
      - nsxEdgeVTepVlanId
      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
    ClusterByolAllocationDetails:
      description: 'The BYOL allocations used for VMware Cluster provisioning.

        '
      properties:
        firewallByolAllocationId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware vDefend Firewall.

            '
          maxLength: 255
          minLength: 1
          type: string
        vsanByolAllocationId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware vSAN.

            '
          maxLength: 255
          minLength: 1
          type: string
      type: object
    Error:
      description: Error Information.
      properties:
        code:
          description: 'A short error code that defines the error, meant for programmatic parsing. See

            [API Errors](/Content/API/References/apierrors.htm).

            '
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    UpdateClusterDetails:
      description: 'The Cluster information to be updated.


        **Important:** Only the `displayName`, `freeFormTags`, and `definedTags` attributes

        affect the existing Cluster. Changing the other attributes affects the `Cluster` object, but not

        the VMware environment currently running on that Cluster. Those other attributes are used

        by the Oracle Cloud VMware Solution *only* for new ESXi hosts that you add to this

        Cluster in the future with [CreateEsxiHost](#/en/vmware/20200501/EsxiHost/CreateEsxiHost).

        '
      properties:
        clusterByolAllocationDetails:
          $ref: '#/components/schemas/ClusterByolAllocationDetails'
        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: 'The [OCID](/Content/General/Concepts/identifiers.htm) of 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.

            '
          maxLength: 22
          minLength: 1
          type: string
        esxiSoftwareVersion:
          description: 'The version of bundled ESXi software that the Oracle Cloud VMware Solution will

            install on any new ESXi hosts that you add to this Cluster in the future unless a specific version is configured on the ESXi level.

            To get a list of the available versions, use

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

            '
          maxLength: 64
          minLength: 1
          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
        networkConfiguration:
          $ref: '#/components/schemas/NetworkConfiguration'
        vmwareSoftwareVersion:
          description: 'The version of bundled VMware software that the Oracle Cloud VMware Solution will

            install on any new ESXi hosts that you add to this Cluster in the future. To get a list of the available versions, use

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

            '
          maxLength: 32
          minLength: 1
          type: string
      type: object
    DatastoreInfo:
      description: 'Datastore info for creating 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
        datastoreType:
          description: Type of the datastore.
          enum:
          - MANAGEMENT
          - WORKLOAD
          type: string
          x-obmcs-top-level-enum: '#/definitions/DatastoreTypes'
      required:
      - blockVolumeIds
      - datastoreType
      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
    ClusterSummary:
      description: A summary of the Cluster.
      properties:
        clusterByolAllocationDetails:
          $ref: '#/components/schemas/

# --- 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