Byol

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/oracle/json-schema/oracle-byol-schema.json",
  "title": "Byol",
  "description": "An [Oracle Cloud VMware Solution](/iaas/Content/VMware/Concepts/ocvsoverview.htm) Bring-Your-Own-License (BYOL), \nis a permit (entitlement) customer purchased from Broadcom and registered in OCI to install VMware software.\n",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-byol-api-openapi.yml#/components/schemas/Byol",
  "properties": {
    "availableUnits": {
      "description": "The quantity of licensed units that not yet allocated to specific region.\n",
      "type": "integer"
    },
    "compartmentId": {
      "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that\ncontains the BYOL.\n",
      "type": "string"
    },
    "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"
    },
    "description": {
      "description": "A description of the BYOL.",
      "type": "string"
    },
    "displayName": {
      "description": "A descriptive name for the BYOL.\n",
      "type": "string"
    },
    "entitlementKey": {
      "description": "The Broadcom-supplied identifier of a BYOL license.\n",
      "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"
    },
    "id": {
      "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the BYOL.\n",
      "type": "string"
    },
    "lifecycleState": {
      "description": "The current state of the BYOL.",
      "enum": [
        "CREATING",
        "ACTIVE",
        "INACTIVE",
        "UPDATING",
        "DELETING",
        "DELETED",
        "FAILED"
      ],
      "type": "string"
    },
    "siteId": {
      "description": "The hyperscaler identifier in Broadcom systems.\n",
      "maxLength": 64,
      "minLength": 1,
      "type": "string"
    },
    "softwareType": {
      "description": "The type of VMware software the BYOL applies to. \nSupported values:\n- VCF (VMware Cloud Foundation)\n- VSAN (VMware vSAN)\n- VDEFEND (VMware vDefend Firewall)\n- AVI_LOAD_BALANCER (VMware Avi Load Balancer)\n",
      "enum": [
        "VCF",
        "VSAN",
        "VDEFEND",
        "AVI_LOAD_BALANCER"
      ],
      "type": "string"
    },
    "systemTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only string, integer and boolean types are supported.\n",
          "type": "object"
        },
        "description": "Key-value pair representing system tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
        "type": "object"
      },
      "description": "Usage of system tag keys. These predefined keys are scoped to namespaces.\nExample: `{orcl-cloud: {free-tier-retain: true}}`\n",
      "type": "object"
    },
    "timeCreated": {
      "description": "The date and time the BYOL was created, in the format defined by\n[RFC3339](https://tools.ietf.org/html/rfc3339).\nExample: `2016-08-25T21:10:29.600Z`\n",
      "format": "date-time",
      "type": "string"
    },
    "timeTermEnd": {
      "description": "The date and time when the BYOL expires and becomes inactive.\nIn the format defined by[RFC3339](https://tools.ietf.org/html/rfc3339).\n",
      "format": "date-time",
      "type": "string"
    },
    "timeTermStart": {
      "description": "The date and time when the BYOL becomes active. VMware software functionality cannot begin before this time.\nIn the format defined by[RFC3339](https://tools.ietf.org/html/rfc3339).\nExample: `2016-08-25T21:10:29.600Z`\n",
      "format": "date-time",
      "type": "string"
    },
    "timeUpdated": {
      "description": "The date and time the BYOL was updated, in the format defined by\n[RFC3339](https://tools.ietf.org/html/rfc3339).\n",
      "format": "date-time",
      "type": "string"
    },
    "totalUnits": {
      "description": "Total quantity of licensed units for the specified `softwareType`:\n\n- VCF, VDEFEND: number of OCPUs\n- VSAN: storage capacity in TiB (tebibytes)\n- AVI_LOAD_BALANCER: number of instances\n",
      "type": "integer"
    }
  },
  "required": [
    "id",
    "compartmentId",
    "displayName",
    "lifecycleState",
    "softwareType",
    "totalUnits",
    "availableUnits",
    "timeTermStart",
    "timeTermEnd",
    "entitlementKey",
    "timeCreated",
    "timeUpdated",
    "freeformTags",
    "definedTags",
    "systemTags"
  ],
  "type": "object"
}