Oracle · Schema

CreateClusterDetails

Details of the Cluster.

OracleCloudDatabaseEnterpriseInfrastructureSoftware-as-a-ServiceFortune 100

Properties

Name Type Description
capacityReservationId string The [OCID](/Content/General/Concepts/identifiers.htm) of the Capacity Reservation.
clusterByolAllocationDetails object
computeAvailabilityDomain string The availability domain to create the Cluster's ESXi hosts in. For multi-AD Cluster deployment, set to `multi-AD`.
datastoreClusterIds array A list of datastore clusters.
datastores array A list of datastore info for the Cluster. This value is required only when `initialHostShapeName` is a standard shape.
definedTags object 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": {"Cost
displayName string 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
esxiHostsCount integer The number of ESXi hosts to create in the Cluster. You can add more hosts later (see [CreateEsxiHost](#/en/vmware/20200501/EsxiHost/CreateEsxiHost)). **Note:** If you later delete EXSi hosts from a pr
esxiSoftwareVersion string The ESXi software bundle to install on the ESXi hosts in the Cluster. Only versions under the same vmwareSoftwareVersion and have been validate by Oracle Cloud VMware Solution will be accepted. To get
freeformTags object 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)
initialCommitment string The billing option selected during Cluster creation. [ListSupportedCommitments](#/en/vmware/20200501/SupportedCommitmentSummary/ListSupportedCommitments).
initialHostOcpuCount number The initial OCPU count of the Cluster's ESXi hosts.
initialHostShapeName string The initial compute shape of the Cluster's ESXi hosts. [ListSupportedHostShapes](#/en/vmware/20200501/SupportedHostShapes/ListSupportedHostShapes).
initialVcfByolAllocationId string The [OCID](/Content/General/Concepts/identifiers.htm) of the initial VMware BYOL Allocation used to deploy VMware Cloud Foundation.
instanceDisplayNamePrefix string 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 ESX
isShieldedInstanceEnabled boolean Indicates whether shielded instance is enabled for this Cluster.
networkConfiguration object
sddcId string The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC that the Cluster belongs to.
vmwareSoftwareVersion string 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/SupportedVmwareSoftwareV
workloadNetworkCidr string The CIDR block for the IP addresses that VMware VMs in the Cluster use to run application workloads.
View JSON Schema on GitHub

JSON Schema

oracle-create-cluster-details-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/oracle/json-schema/oracle-create-cluster-details-schema.json",
  "title": "CreateClusterDetails",
  "description": "Details of the Cluster.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-cluster-api-openapi.yml#/components/schemas/CreateClusterDetails",
  "properties": {
    "capacityReservationId": {
      "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Capacity Reservation.\n",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "clusterByolAllocationDetails": {
      "$ref": "#/$defs/ClusterByolAllocationDetails"
    },
    "computeAvailabilityDomain": {
      "description": "The availability domain to create the Cluster's ESXi hosts in. For multi-AD Cluster deployment, set to `multi-AD`.\n",
      "maxLength": 64,
      "minLength": 1,
      "type": "string"
    },
    "datastoreClusterIds": {
      "description": "A list of datastore clusters.\n",
      "items": {
        "maxLength": 255,
        "minLength": 1,
        "type": "string"
      },
      "type": "array"
    },
    "datastores": {
      "description": "A list of datastore info for the Cluster.\nThis value is required only when `initialHostShapeName` is a standard shape.\n",
      "items": {
        "$ref": "#/$defs/DatastoreInfo"
      },
      "type": "array"
    },
    "definedTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only the String type is supported.\n",
          "type": "object"
        },
        "description": "Key-value pair representing a defined tag key and value, scoped to a namespace.\n\nExample: `{\"CostCenter\": \"42\"}`\n",
        "type": "object"
      },
      "description": "Defined tags for this resource. Each key is predefined and scoped to a\nnamespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Operations\": {\"CostCenter\": \"42\"}}`\n",
      "type": "object"
    },
    "displayName": {
      "description": "A descriptive name for the Cluster.\nCluster 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.\nAvoid entering confidential information.\n",
      "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\npredefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Department\": \"Finance\"}`\n",
      "type": "object"
    },
    "initialCommitment": {
      "default": "HOUR",
      "description": "The billing option selected during Cluster creation.\n[ListSupportedCommitments](#/en/vmware/20200501/SupportedCommitmentSummary/ListSupportedCommitments).\n",
      "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.\n",
      "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.\n[ListSupportedHostShapes](#/en/vmware/20200501/SupportedHostShapes/ListSupportedHostShapes).\n",
      "type": "string"
    },
    "initialVcfByolAllocationId": {
      "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the initial VMware BYOL Allocation used to deploy VMware Cloud Foundation.\n",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "instanceDisplayNamePrefix": {
      "description": "A prefix used in the name of each ESXi host and Compute instance in the Cluster.\nIf this isn't set, the Cluster's `displayName` is used as the prefix.\n\nFor example, if the value is `myCluster`, the ESXi hosts are named `myCluster-1`,\n`myCluster-2`, and so on.\n",
      "maxLength": 22,
      "minLength": 1,
      "type": "string"
    },
    "isShieldedInstanceEnabled": {
      "default": false,
      "description": "Indicates whether shielded instance is enabled for this Cluster.\n",
      "type": "boolean"
    },
    "networkConfiguration": {
      "$ref": "#/$defs/NetworkConfiguration"
    },
    "sddcId": {
      "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC that the\nCluster belongs to.\n",
      "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\n[ListSupportedVmwareSoftwareVersions](#/en/vmware/20230701/SupportedVmwareSoftwareVersionSummary/ListSupportedVmwareSoftwareVersions).\n",
      "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\nworkloads.\n",
      "maxLength": 20,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "sddcId",
    "computeAvailabilityDomain",
    "esxiHostsCount",
    "networkConfiguration"
  ],
  "type": "object",
  "$defs": {
    "ClusterByolAllocationDetails": {
      "description": "The BYOL allocations used for VMware Cluster provisioning.\n",
      "properties": {
        "firewallByolAllocationId": {
          "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VMware BYOL Allocation used to deploy VMware vDefend Firewall.\n",
          "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.\n",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        }
      },
      "type": "object"
    },
    "DatastoreInfo": {
      "description": "Datastore info for creating an Sddc.\n",
      "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"
    },
    "NetworkConfiguration": {
      "description": "The network configurations used by Cluster, including\n[OCIDs](/Content/General/Concepts/identifiers.htm) of the management subnet and VLANs.\n",
      "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\nfor the NSX Edge Uplink 1 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 1 VLAN\ncurrently used by the ESXi hosts in the Cluster. The purpose\nof this attribute is to show the NSX Edge Uplink 1 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 1 component of the VMware environment, you\nshould use [UpdateCluster](#/en/vmware/20200501/Cluster/UpdateCluster) to update the Cluster's\n`nsxEdgeUplink1VlanId` with that new VLAN's OCID.\n",
          "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\nfor the NSX Edge VTEP component of the VMware environment.\n\nThis attribute is not guaranteed to reflect the NSX Edge VTEP VLAN\ncurrently used by the ESXi hosts in the Cluster. The purpose\nof this attribute is to show the NSX Edge VTEP 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 VTEP component of the VMware environment, you\nshould use [UpdateCluster](#/en/vmware/20200501/Cluster/UpdateCluster) to update the Cluster's\n`nsxEdgeVTepVlanId` with that new VLAN's OCID.\n",
          "type": "string"
        },
        "nsxVTepVlanId": {
          "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster\nfor the NSX VTEP component of the VMware environment.\n\nThis attribute is not guaranteed to reflect the NSX VTEP VLAN\ncurrently used by the ESXi hosts in the Cluster. The purpose\nof this attribute is to show the NSX VTEP 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 VTEP component of the VMware environment, you\nshould use [UpdateCluster](#/en/vmware/20200501/Cluster/UpdateCluster) to update the Cluster's\n`nsxVTepVlanId` with that new VLAN's OCID.\n",
          "type": "string"
        },
        "provisioningSubnetId": {
          "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the management subnet used\nto provision the Cluster.\n",
          "type": "string"
        },
        "provisioningVlanId": {
          "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster\nfor the Provisioning component of the VMware environment.\n",
          "type": "string"
        },
        "replicationVlanId": {
          "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster\nfor the vSphere Replication component of the VMware environment.\n",
          "type": "string"
        },
        "vmotionVlanId": {
          "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster\nfor the vMotion component of the VMware environment.\n\nThis attribute is not guaranteed to reflect the vMotion VLAN\ncurrently used by the ESXi hosts in the Cluster. The purpose\nof this attribute is to show the vMotion 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 vMotion component of the VMware environment, you\nshould use [UpdateCluster](#/en/vmware/20200501/Sddc/UpdateCluster) to update the Cluster's\n`vmotionVlanId` with that new VLAN's OCID.\n",
          "type": "string"
        },
        "vsanVlanId": {
          "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN used by the Cluster\nfor the vSAN component of the VMware environment.\n\nThis attribute is not guaranteed to reflect the vSAN VLAN\ncurrently used by the ESXi hosts in the Cluster. The purpose\nof this attribute is to show the vSAN 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 vSAN component of the VMware environment, you\nshould use [UpdateCluster](#/en/vmware/20200501/Cluster/UpdateCluster) to update the Cluster's\n`vsanVlanId` with that new VLAN's OCID.\n",
          "type": "string"
        },
        "vsphereVlanId": {
          "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the VLAN used by the SDDC\nfor the vSphere component of the VMware environment. This VLAN is a mandatory attribute\nfor Management Cluster.\n\nThis attribute is not guaranteed to reflect the vSphere VLAN\ncurrently used by the ESXi hosts in the Cluster. The purpose\nof this attribute is to show the vSphere 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 vSphere component of the VMware environment, you\nshould use [UpdateCluster](#/en/vmware/20200501/Sddc/UpdateSddc) to update the Cluster's\n`vsphereVlanId` with that new VLAN's OCID.\n",
          "type": "string"
        }
      },
      "required": [
        "provisioningSubnetId",
        "vmotionVlanId",
        "vsanVlanId",
        "nsxVTepVlanId",
        "nsxEdgeVTepVlanId"
      ],
      "type": "object"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema 
curl "https://apis.io/api/v1/json-schemas/oracle-create-cluster-details"
All schemas 
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.