CreateByolDetails

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/oracle/json-schema/oracle-create-byol-details-schema.json",
  "title": "CreateByolDetails",
  "description": "The details to create a BYOL.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-byol-api-openapi.yml#/components/schemas/CreateByolDetails",
  "properties": {
    "compartmentId": {
      "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that\ncontains the BYOL.\n",
      "maxLength": 255,
      "minLength": 1,
      "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"
    },
    "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",
      "type": "string",
      "x-obmcs-enumref": "#/definitions/Byol/softwareType"
    },
    "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"
    },
    "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": [
    "compartmentId",
    "displayName",
    "softwareType",
    "totalUnits",
    "timeTermStart",
    "timeTermEnd",
    "entitlementKey"
  ],
  "type": "object"
}