UpdateClusterDetails

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/oracle/json-schema/oracle-update-cluster-details-schema.json",
  "title": "UpdateClusterDetails",
  "description": "The Cluster information to be updated.\n\n**Important:** Only the `displayName`, `freeFormTags`, and `definedTags` attributes\naffect the existing Cluster. Changing the other attributes affects the `Cluster` object, but not\nthe VMware environment currently running on that Cluster. Those other attributes are used\nby the Oracle Cloud VMware Solution *only* for new ESXi hosts that you add to this\nCluster in the future with [CreateEsxiHost](#/en/vmware/20200501/EsxiHost/CreateEsxiHost).\n",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-cluster-api-openapi.yml#/components/schemas/UpdateClusterDetails",
  "properties": {
    "clusterByolAllocationDetails": {
      "$ref": "#/$defs/ClusterByolAllocationDetails"
    },
    "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": "The [OCID](/Content/General/Concepts/identifiers.htm) of 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.\n",
      "maxLength": 22,
      "minLength": 1,
      "type": "string"
    },
    "esxiSoftwareVersion": {
      "description": "The version of bundled ESXi software that the Oracle Cloud VMware Solution will\ninstall on any new ESXi hosts that you add to this Cluster in the future unless a specific version is configured on the ESXi level.\nTo get a list of the available versions, use\n[ListSupportedVmwareSoftwareVersions](#/en/vmware/20230701/SupportedVmwareSoftwareVersionSummary/ListSupportedVmwareSoftwareVersions).\n",
      "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\npredefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Department\": \"Finance\"}`\n",
      "type": "object"
    },
    "networkConfiguration": {
      "$ref": "#/$defs/NetworkConfiguration"
    },
    "vmwareSoftwareVersion": {
      "description": "The version of bundled VMware software that the Oracle Cloud VMware Solution will\ninstall on any new ESXi hosts that you add to this Cluster in the future. To get a list of the available versions, use\n[ListSupportedVmwareSoftwareVersions](#/en/vmware/20230701/SupportedVmwareSoftwareVersionSummary/ListSupportedVmwareSoftwareVersions).\n",
      "maxLength": 32,
      "minLength": 1,
      "type": "string"
    }
  },
  "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"
    },
    "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"
    }
  }
}