openapi: 3.2.0
info:
  title: Oracle Esxi Host API
  version: '1.0'
  description: 'Operations tagged esxiHost across 2 of this provider''s published API definitions: oci-vmware-1-openapi.yaml, oci-vmware-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://127.0.0.1/20220518
- url: https://127.0.0.1/20220518
tags:
- name: esxiHost
paths:
  /esxiHosts:
    get:
      description: 'Lists the ESXi hosts in the specified SDDC. The list can be filtered

        by Compute instance OCID or ESXi display name.


        Remember that in terms of implementation, an ESXi host is a Compute instance that

        is configured with the chosen bundle of VMware software. Each `EsxiHost`

        object has its own OCID (`id`), and a separate attribute for the OCID of

        the Compute instance (`computeInstanceId`). When filtering the list of

        ESXi hosts, you can specify the OCID of the Compute instance, not the

        ESXi host OCID.

        '
      operationId: ListEsxiHosts
      parameters:
      - $ref: '#/components/parameters/SddcIdentifierQueryParam'
      - $ref: '#/components/parameters/ComputeInstanceIdentifierQueryParam'
      - $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/DeletedDonorHostQueryParam'
      - $ref: '#/components/parameters/ActiveDonorHostQueryParam'
      - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
      responses:
        200:
          description: The list is being retrieved.
          headers:
            Sunset:
              description: Sunset date when this operation will stop working, in <HTTP-date> format, e.g. "Wed, 21 Jun 2023 11:11:11 GMT"
              schema:
                type: string
            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/EsxiHostCollection'
        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 ESXi hosts in the specified SDDC
      tags:
      - esxiHost
      x-related-resource: '#/definitions/EsxiHostSummary'
    post:
      description: 'Adds another ESXi host to an existing SDDC. The attributes of the specified

        `Sddc` determine the VMware software and other configuration settings used

        by the ESXi host.


        Use the [WorkRequest](#/en/vmware/20200501/WorkRequest/) operations to track the

        creation of the ESXi host.

        '
      operationId: CreateEsxiHost
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: The request was accepted and the ESXi host will be created.
          headers:
            Sunset:
              description: Sunset date when this operation will stop working, in <HTTP-date> format, e.g. "Wed, 21 Jun 2023 11:11:11 GMT"
              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
            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: Creates an ESXi host
      tags:
      - esxiHost
      x-related-resource: '#/definitions/EsxiHost'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEsxiHostDetails'
        description: Details for the ESXi host.
        required: true
  /esxiHosts/{esxiHostId}:
    delete:
      description: 'Deletes the specified ESXi host. Before deleting the host, back up or

        migrate any VMware workloads running on it.


        When you delete an ESXi host, Oracle does not remove the node

        configuration within the VMware environment itself. That is

        your responsibility.


        **Note:** If you delete EXSi hosts from the SDDC to total less than 3,

        you are still billed for the 3 minimum recommended EXSi hosts. Also,

        you cannot add more VMware workloads to the SDDC until it again has at

        least 3 ESXi hosts.


        Use the [WorkRequest](#/en/vmware/20200501/WorkRequest/) operations to track the

        deletion of the ESXi host.

        '
      operationId: DeleteEsxiHost
      parameters:
      - $ref: '#/components/parameters/EsxiHostIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: The request was accepted and the ESXi host will be deleted.
          headers:
            Sunset:
              description: Sunset date when this operation will stop working, in <HTTP-date> format, e.g. "Wed, 21 Jun 2023 11:11:11 GMT"
              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
            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 ESXi host
      tags:
      - esxiHost
      x-related-resource: '#/definitions/EsxiHost'
    get:
      description: Gets the specified ESXi host's information.
      operationId: GetEsxiHost
      parameters:
      - $ref: '#/components/parameters/EsxiHostIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The ESXi host was retrieved.
          headers:
            Sunset:
              description: Sunset date when this operation will stop working, in <HTTP-date> format, e.g. "Wed, 21 Jun 2023 11:11:11 GMT"
              schema:
                type: string
            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/EsxiHost'
        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: Gets the specified ESXi host's information
      tags:
      - esxiHost
    put:
      description: Updates the specified ESXi host.
      operationId: UpdateEsxiHost
      parameters:
      - $ref: '#/components/parameters/EsxiHostIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The ESXi host was updated.
          headers:
            Sunset:
              description: Sunset date when this operation will stop working, in <HTTP-date> format, e.g. "Wed, 21 Jun 2023 11:11:11 GMT"
              schema:
                type: string
            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/EsxiHost'
        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 ESXi host
      tags:
      - esxiHost
      x-related-resource: '#/definitions/EsxiHost'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEsxiHostDetails'
        description: The information to be updated.
        required: true
  /esxiHosts/{esxiHostId}/actions/acknowledgeLicenseReplacement:
    post:
      description: Acknowledge the replacement of ESXi host licenses.
      operationId: AcknowledgeEsxiHostLicenseReplacement
      parameters:
      - $ref: '#/components/parameters/EsxiHostIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The replacement of ESXi host licenses was acknowledged.
          headers:
            Sunset:
              description: Sunset date when this operation will stop working, in <HTTP-date> format, e.g. "Wed, 21 Jun 2023 11:11:11 GMT"
              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
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Acknowledge the replacement of ESXi host licenses.
      tags:
      - esxiHost
      x-obmcs-terraform:
        actionType: UPDATE_FIELD
      x-related-resource: '#/definitions/EsxiHost'
  /esxiHosts/{esxiHostId}/actions/increaseHostOcpuCount:
    post:
      description: Increase the OCPU count of the specified ESXi host.
      operationId: IncreaseHostOcpuCount
      parameters:
      - $ref: '#/components/parameters/EsxiHostIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: The request was accepted to increase host OCPU count.
          headers:
            Sunset:
              description: Sunset date when this operation will stop working, in <HTTP-date> format, e.g. "Wed, 21 Jun 2023 11:11:11 GMT"
              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
            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'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Increase the OCPU count of the specified ESXi host
      tags:
      - esxiHost
      x-obmcs-terraform:
        actionType: UPDATE_FIELD
      x-related-resource: '#/definitions/EsxiHost'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IncreaseHostOcpuCountDetails'
        description: The details of the OCPU count scaling operation.
        required: true
  /esxiHosts/{esxiHostId}/actions/swapBilling:
    post:
      description: 'Swap billing between two Active ESXi hosts.

        '
      operationId: SwapBilling
      parameters:
      - $ref: '#/components/parameters/EsxiHostIdentifierPathParam'
      - $ref: '#/components/parameters/SwapBillingEsxiHostIdentifierQueryParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: The request was accepted and the billing will be swapped.
          headers:
            Sunset:
              description: Sunset date when this operation will stop working, in <HTTP-date> format, e.g. "Wed, 21 Jun 2023 11:11:11 GMT"
              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
            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'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Swap billing between two Active ESXi hosts.
      tags:
      - esxiHost
      x-obmcs-terraform:
        actionType: SPECIAL_UPDATE
      x-related-resource: '#/definitions/EsxiHost'
  /esxiHostByComputeInstanceId/{computeInstanceId}:
    get:
      description: Gets ESXi host's information from provided compute instance Id.
      operationId: GetEsxiHostByComputeInstanceId
      parameters:
      - $ref: '#/components/parameters/ComputeInstanceIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader_2'
      responses:
        200:
          description: The ESXi host 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/EsxiHost_2'
        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_2'
      summary: Gets ESXi host's information from provided compute instance Id.
      tags:
      - esxiHost
      x-related-resource: '#/definitions/EsxiHost'
  /esxiHosts/{esxiHostId}/actions/inplaceUpgrade:
    post:
      description: 'In-place upgrade a ESXi host.

        '
      operationId: InplaceUpgrade
      parameters:
      - $ref: '#/components/parameters/EsxiHostIdentifierPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader_2'
      responses:
        202:
          description: The request was accepted and the in-place upgrade initiated.
          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'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default_2'
      summary: In-place upgrade a ESXi host.
      tags:
      - esxiHost
      x-obmcs-terraform:
        actionType: UPDATE_FIELD
      x-related-resource: '#/definitions/EsxiHost'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InplaceUpgradeDetails'
        description: The details for upgrading ESXi host.
  /esxiHosts/{esxiHostId}/actions/replaceHost:
    post:
      description: 'Replace a faulty ESXi host whose underlying bare metal is broken

        '
      operationId: ReplaceHost
      parameters:
      - $ref: '#/components/parameters/EsxiHostIdentifierPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader_2'
      responses:
        202:
          description: The request was accepted and the host replacement initiated.
          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'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default_2'
      summary: Replace a faulty ESXi host whose underlying bare metal is broken
      tags:
      - esxiHost
      x-obmcs-terraform:
        actionType: UPDATE_FIELD
      x-related-resource: '#/definitions/EsxiHost'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReplaceHostDetails'
        description: The details for replacing ESXi host
        required: true
components:
  schemas:
    IncreaseHostOcpuCountDetails:
      description: The details of the OCPU count scaling operation.
      properties:
        hostOcpuCount:
          description: The host OCPU count to scale to.
          format: float
          minimum: 0
          type: number
      required:
      - hostOcpuCount
    DatastoreAttachment:
      description: 'The details about attachment of datastore

        '
      properties:
        blockVolumeId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Block Volume that belongs to the datastore.
          maxLength: 255
          minLength: 1
          type: string
        datastoreId:
          description: 'The [OCIDs](/Content/General/Concepts/identifiers.htm) of the Datastore that ESXi host is attached to.

            '
          maxLength: 255
          minLength: 1
          type: string
        ipAddress:
          description: The IP address of datastore attachment.
          maxLength: 255
          minLength: 1
          type: string
        port:
          description: The port of datastore attachment.
          type: integer
        volumeIqn:
          description: An IQN of the Block Storage Volume.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - blockVolumeId
      - volumeIqn
      - datastoreId
      - ipAddress
      - port
      type: object
    UpdateEsxiHostDetails:
      description: The ESXi host information to be updated.
      properties:
        billingDonorHostId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the deleted ESXi Host with LeftOver billing cycle.

            '
          maxLength: 255
          minLength: 1
          type: string
        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 ESXi host. It''s changeable.

            Esxi Host name requirements are 1-16 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the SDDC.


            Avoid entering confidential information.

            '
          maxLength: 16
          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
        nextSku:
          description: 'The billing option to switch to after the existing billing cycle ends.

            If `nextSku` is null or empty, `currentSku` continues to the next billing cycle.

            [ListSupportedSkus](#/en/vmware/20200501/SupportedSkuSummary/ListSupportedSkus).

            '
          enum:
          - HOUR
          - MONTH
          - ONE_YEAR
          - THREE_YEARS
          type: string
          x-obmcs-top-level-enum: '#/definitions/Sku'
      type: object
    EsxiHost:
      description: 'An ESXi host is a node in an SDDC. At a minimum, each SDDC has 3 ESXi hosts

        that are used to implement a functioning VMware environment.


        In terms of implementation, an ESXi host is a Compute instance that

        is configured with the chosen bundle of VMware software.


        Notice that an `EsxiHost` object has its own OCID (`id`), and a separate

        attribute for the OCID of the Compute instance (`computeInstanceId`).

        '
      properties:
        billingContractEndDate:
          description: 'Current billing cycle end date. If the value in `currentSku` and `nextSku` are different, the value specified in `nextSku`

            becomes the new `currentSKU` when the `contractEndDate` is reached.

            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        billingDonorHostId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the deleted ESXi Host with LeftOver billing cycle.

            '
          maxLength: 255
          minLength: 1
          type: string
        capacityReservationId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Capacity Reservation.

            '
          maxLength: 255
          minLength: 1
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that

            contains the SDDC.

            '
          type: string
        computeAvailabilityDomain:
          description: 'The availability domain of the ESXi host.

            '
          maxLength: 64
          minLength: 1
          type: string
        computeInstanceId:
          description: 'In terms of implementation, an ESXi host is a Compute instance that

            is configured with the chosen bundle of VMware software. The `computeInstanceId`

            is the [OCID](/Content/General/Concepts/identifiers.htm) of that Compute instance.

            '
          type: string
        currentSku:
          description: 'The billing option currently used by the ESXi host.

            [ListSupportedSkus](#/en/vmware/20200501/SupportedSkuSummary/ListSupportedSkus).

            '
          enum:
          - HOUR
          - MONTH
          - ONE_YEAR
          - THREE_YEARS
          type: string
          x-default-description: For ESXi host shapes supporting "MONTH" SKU, the default initialSku is "MONTH". For other shapes, the default initialSku is "HOUR".
          x-obmcs-top-level-enum: '#/definitions/Sku'
        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 ESXi host. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          type: string
        failedEsxiHostId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host that failed.

            '
          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
        gracePeriodEndDate:
          description: 'The date and time when the new esxi host should start billing cycle.

            [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2021-07-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        hostOcpuCount:
          description: 'The OCPU count of the ESXi host.

            '
          format: float
          minimum: 0
          type: number
        hostShapeName:
          description: 'The compute shape name of the ESXi host.

            [ListSupportedHostShapes](#/en/vmware/20200501/SupportedHostShapes/ListSupportedHostShapes).

            '
          type: string
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host.

            '
          type: string
        isBillingContinuationInProgress:
          default: false
          description: 'Indicates whether this host is in the progress of billing continuation.

            '
          type: boolean
        isBillingSwappingInProgress:
          default: false
          description: 'Indicates whether this host is in the progress of swapping billing.

            '
          type: boolean
        lifecycleDetails:
          description: 'The detailed lifecycle of the licenses of the resource.

            '
          type: string
        lifecycleState:
          description: The current state of the ESXi host.
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - DELETED
          - FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleStates'
        nextSku:
          description: 'The billing option to switch to after the current billing cycle ends.

            If `nextSku` is null or empty, `currentSku` continues to the next billing cycle.

            [ListSupportedSkus](#/en/vmware/20200501/SupportedSkuSummary/ListSupportedSkus).

            '
          enum:
          - HOUR
          - MONTH
          - ONE_YEAR
          - THREE_YEARS
          type: string
          x-obmcs-top-level-enum: '#/definitions/Sku'
        nonUpgradedEsxiHostId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host that

            will be upgraded.

            '
          type: string
        previousHostOcpuCount:
          description: 'The host OCPU count before OCPU scaling.

            '
          format: float
          minimum: 0
          type: number
        replacementEsxiHostId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host that

            is created to replace the failed host.

            '
          type: string
        replacementLicenses:
          description: 'Replacement licenses for the ESXi host that was scaled from less or equal then 64 OCPUs to more than 64 OCPUs.

            '
          items:
            $ref: '#/components/schemas/LicenseDetails'
          type: array
        sddcId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC that the

            ESXi host belongs to.

            '
          type: string
        supportedOcpuCountForScaling:
          description: 'The OCPU count that customers can scale to using increaseHostOcpuCount API.

            '
          format: float
          minimum: 0
          type: number
        swapBillingHostId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the active ESXi Host to swap billing with current host.

            '
          maxLength: 255
          minLength: 1
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

            Example: `{orcl-cloud: {free-tier-retain: true}}`

            '
          type: object
        timeCreated:
          description: 'The date and time the ESXi host was created, in the format defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339).


            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeOcpuScalableUntil:
          description: 'The time before which customers can increase the OCPU count. If this field is empty, it means customer can increase OCPU count at any time.

            '
          format: date-time
          type: string
        timeOcpuScaled:
          description: 'The time when the last OCPU scaling happened.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the ESXi host was updated, in the format defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
        upgradedReplacementEsxiHostId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host that

            is newly created to upgrade the original host.

            '
          type: string
        vmwareSoftwareVersion:
          description: 'The version of VMware software that Oracle Cloud VMware Solution installed on the ESXi hosts.

            '
          type: string
      required:
      - id
      - sddcId
      - displayName
      - currentSku
      - nextSku
      - billingContractEndDate
      - computeAvailabilityDomain
      - freeformTags
      - definedTags
      - hostShapeName
      - vmwareSoftwareVersion
      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
    CreateEsxiHostDetails:
      description: Details of the ESXi host to add to the SDDC.
      properties:
        billingDonorHostId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the deleted ESXi Host with LeftOver billing cycle.

            '
          maxLength: 255
          minLength: 1
          type: string
        capacityReservationId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Capacity Reservation.

            '
          maxLength: 255
          minLength: 1
          type: string
        computeAvailabilityDomain:
          description: 'The availability domain to create the ESXi host in.

            If keep empty, for AD-specific SDDC, new ESXi host will be created in the same availability domain;

            for multi-AD SDDC, new ESXi host will be auto assigned to the next availability domain following evenly distribution strategy.

            '
          maxLength: 64
          minLength: 1
          type: string
          x-default-description: 'null'
        currentSku:
          description: 'The billing option currently used by the ESXi host.

            [ListSupportedSkus](#/en/vmware/20200501/SupportedSkuSummary/ListSupportedSkus).

            '
          enum:
          - HOUR
          - MONTH
          - ONE_YEAR
          - THREE_YEARS
          type: string
          x-default-description: For ESXi host shapes supporting "MONTH" SKU, the default initialSku is "MONTH". For other shapes, the default initialSku is "HOUR".
          x-obmcs-top-level-enum: '#/definitions/Sku'
        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 ESXi host. It''s changeable.

            Esxi Host name requirements are 1-16 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the SDDC.


            If this attribute is not specified, the SDDC''s `instanceDisplayNamePrefix` attribute is used

            to name and incrementally number the ESXi host. For example, if you''re creating the fourth

            ESXi host in the SDDC, and `instanceDisplayNamePrefix` is `MySDDC`, the host''s display

            name is `MySDDC-4`.


            Avoid entering confidential information.

            '
          maxLength: 16
          minLength: 1
          type: string
        failedEsxiHostId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host that

            is failed. This is an optional parameter. If this parameter is specified, a new ESXi

            host will be created to replace the failed one, and the `failedEsxiHostId` field

            will be updated in the newly created Esxi host.

            '
          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
        hostOcpuCount:
          description: 'The OCPU count of the ESXi host.

            '
          format: float
          minimum: 0
          type: number
          x-default-description: When unspecified, in case of adding ESXi host, it will use the default OCPU count of the ESXi host's shape. In case of replacing ESXi host, it will use the host ocpu count of the failed ESXi host.
        hostShapeName:
          description: 'The compute shape name of the ESXi host.

            [ListSupportedHostShapes](#/en/vmware/20200501/SupportedHostShapes/ListSupportedHostShapes).

            '
          type: string
          x-default-description: When unspecified, in case of adding ESXi host, it will use the initial host shape of the SDDC. In case of replacing ESXi host, it will use the host shape name of the failed ESXi host.
        nextSku:
          description: 'The billing option to switch to after the existing billing cycle ends.

            If `nextSku` is null or empty, `currentSku` continues to the next billing cycle.

            [ListSupportedSkus](#/en/vmware/20200501/SupportedSkuSummary/ListSupportedSkus).

            '
          enum:
          - HOUR
          - MONTH
          - ONE_YEAR
          - THREE_YEARS
          type: string
          x-obmcs-top-level-enum: '#/definitions/Sku'
        nonUpgradedEsxiHostId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host that

            will be upgraded. This is an optional parameter. If this parameter

            is specified, an ESXi host with the new software version is created to replace the

            original one, and the `nonUpgradedEsxiHostId` field is updated in the newly

            created Esxi host. See [Upgrading VMware Software](/Content/VMware/Concepts/upgrade.htm) for more information.

            '
          type: string
        sddcId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC to add the

            ESXi host to.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - sddcId
      type: object
    EsxiHostCollection:
      description: A list of ESXi hosts.
      properties:
        items:
          description: A list of ESXi hosts.
          items:
            $ref: '#/components/schemas/EsxiHostSummary'
          type: array
      required:
      - items
      type: object
    ReplaceHostDetails:
      description: 'The details for replacing ESXi host.

        '
      properties:
        esxiSoftwareVersion:
          description: "The ESXi software bundle to install on the ESXi host. \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.
        vcfByolAllocationId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Byol Allocation for VCF (VMware Cloud Foundation) deployment.

            '
          maxLength: 255
          minLength: 1
          type: string
      type: object
    EsxiHostSummary:
      description: A summary of the ESXi host.
      properties:
        billingContractEndDate:
          description: 'Current billing cycle end date. If the value in `currentSku` and `nextSku` are different, the value specified in `nextSku`

            becomes the new `currentSKU` when the `contractEndDate` is reached.

            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        billingDonorHostId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the deleted ESXi Host with LeftOver billing cycle.

            '
          maxLength: 255
          minLength: 1
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that

            contains the SDDC.

            '
          type: string
        computeAvailabilityDomain:
          description: 'The availability domain of the ESXi host.

            '
          maxLength: 64
          minLength: 1
          type: string
        computeInstanceId:
          description: 'In terms of implementation, an ESXi host is a Compute instance that

            is configured with the chosen bundle of VMware software. The `computeInstanceId`

            is the [OCID](/Content/General/Concepts/identifiers.htm) of that Compute instance.

            '
          type: string
        currentSku:
          description: 'The billing option currently used by the ESXi host.

            [ListSupportedSkus](#/en/vmware/20200501/SupportedSkuSummary/ListSupportedSkus).

            '
          enum:
          - HOUR
          - MONTH
          - ONE_YEAR
          - THREE_YEARS
          type: string
          x-default-description: For ESXi host shapes supporting "MONTH" SKU, the default initialSku is "MONTH". For other shapes, the default initialSku is "HOUR".
          x-obmcs-top-level-enum: '#/definitions/Sku'
        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 ESXi host. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          type: string
        failedEsxiHostId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host that failed.

            '
          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
        gracePeriodEndDate:
          description: 'The date and time when the new esxi host should start billing cycle.

            [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2021-07-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        hostOcpuCount:
          description: 'The OCPU count of the ESXi host.

            '
          format: float
          minimum: 0
          type: number
        hostShapeName:
          description: 'The compute shape name of the ESXi host.

            [ListSupportedHostShapes](#/en/vmware/20200501/SupportedHostShapes/ListSupportedHostShapes).

            '
          type: string
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host.

            '
          type: string
        isBillingContinuationInProgress:
          default: false
          description: 'Indicates whether this host is in the progress of billing continuation.

            '
          type: boolean
        isBillingSwappingInProgress:
          default: false
          description: 'Indicates whether this host is in the progress of swapping billing.

            '
          type: boolean
        lifecycleState:
          description: The current state of the ESXi host.
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - DELETED
          - FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleStates'
        nextSku:
          description: 'The billing option to switch to after the current billing cycle ends.

            If `nextSku` is null or empty, `currentSku` continues to the next billing cycle.

            [ListSupportedSkus](#/en/vmware/20200501/SupportedSkuSummary/ListSupportedSkus).

            '
          enum:
          - HOUR
          - MONTH
          - ONE_YEAR
          - THREE_YEARS
          type: string
          x-obmcs-top-level-enum: '#/definitions/Sku'
        nonUpgradedEsxiHostId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host that

            will be upgraded.

            '
          type: string
        replacementEsxiHostId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host that

            is newly created to replace the failed host.

            '
          type: string
        sddcId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC that the

            ESXi host belongs to.

            '
          type: string
        supportedOcpuCountForScaling:
          description: 'The host OCPU count that customers can scale to using increaseHostOcpuCount API.

            '
          format: float
          minimum: 0
          type: number
        swapBillingHostId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the active ESXi Host to swap billing with current host.

            '
          maxLength: 255
          minLength: 1
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

            Example: `{orcl-cloud: {free-tier-retain: true}}`

            '
          type: object
        timeCreated:
          description: 'The date and time the ESXi host was created, in the format defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339).


            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeOcpuScalableUntil:
          description: 'The time before which customers can increase the OCPU count. If this field is empty, it means customer can increase OCPU count at any time.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the ESXi host was updated, in the format defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
        upgradedReplacementEsxiHostId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host that

            is newly created to upgrade the original host.

            '
          type: string
        vmwareSoftwareVersion:
          description: 'The version of VMware software that Oracle Cloud VMware Solution installed on the ESXi hosts.

            '
          type: string
      required:
      - id
      - sddcId
      - freeformTags
      - definedTags
      - currentSku
      - nextSku
      - billingContractEndDate
      - computeAvailabilityDomain
      - hostShapeName
      - vmwareSoftwareVersion
      type: object
    InplaceUpgradeDetails:
      description: 'The details for upgrading ESXi host.

        '
      properties:
        vcfByolAllocationId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Byol Allocation for VCF (VMware Cloud Foundation) deployment.

            '
          maxLength: 255
          minLength: 1
          type: string
      type: object
    LicenseDetails:
      description: 'Details of a license.

        '
      properties:
        licenseDescription:
          description: Description of the license.
          type: string
        licenseKey:
          description: License key value.
          type: string
        licenseType:
          description: License type.
          type: string
      required:
      - licenseType
      - licenseKey
    EsxiHost_2:
      description: 'An ESXi host is a node in a Cluster. At a minimum, each Cluster has 3 ESXi hosts

        that are used to implement a functioning VMware environment.


        In terms of implementation, an ESXi host is a Compute instance that

        is configured with the chosen bundle of VMware software.


        Notice that an `EsxiHost` object has its own OCID (`id`), and a separate

        attribute for the OCID of the Compute instance (`computeInstanceId`).

        '
      properties:
        billingContractEndDate:
          description: 'Current billing cycle end date. If the value in `currentCommitment` and `nextCommitment` are different, the value specified in `nextCommitment`

            becomes the new `currentCommitment` when the `contractEndDate` is reached.

            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        billingDonorHostId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the deleted ESXi Host with LeftOver billing cycle.

            '
          maxLength: 255
          minLength: 1
          type: string
        capacityReservationId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Capacity Reservation.

            '
          maxLength: 255
          minLength: 1
          type: string
        clusterId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Cluster that the

            ESXi host belongs to.

            '
          type: string
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that

            contains the Cluster.

            '
          type: string
        computeAvailabilityDomain:
          description: 'The availability domain of the ESXi host.

            '
          maxLength: 64
          minLength: 1
          type: string
        computeInstanceId:
          description: 'In terms of implementation, an ESXi host is a Compute instance that

            is configured with the chosen bundle of VMware software. The `computeInstanceId`

            is the [OCID](/Content/General/Concepts/identifiers.htm) of that Compute instance.

            '
          type: string
        currentCommitment:
          description: 'The billing option currently used by the ESXi host.

            [ListSupportedCommitments](#/en/vmware/20230701/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'
        datastoreAttachments:
          description: List of DatastoreAttachment objects containing information about attachment details
          items:
            $ref: '#/components/schemas/DatastoreAttachment'
          maxItems: 32
          type: array
        datastoreClusterIds:
          description: 'A list of datastore clusters.

            '
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 32
          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 ESXi host. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.

            '
          type: string
        esxiSoftwareVersion:
          description: 'The version of ESXi software that Oracle Cloud VMware Solution installed on the ESXi hosts.

            '
          type: string
        failedEsxiHostId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host that failed.

            '
          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
        gracePeriodEndDate:
          description: 'The date and time when the new esxi host should start billing cycle.

            [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2021-07-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        hostOcpuCount:
          description: 'The OCPU count of the ESXi host.

            '
          format: float
          minimum: 0
          type: number
        hostShapeName:
          description: 'The compute shape name of the ESXi host.

            [ListSupportedHostShapes](#/en/vmware/20230701/SupportedHostShapes/ListSupportedHostShapes).

            '
          type: string
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host.

            '
          type: string
        isBillingContinuationInProgress:
          default: false
          description: 'Indicates whether this host is in the progress of billing continuation.

            '
          type: boolean
        isBillingSwappingInProgress:
          default: false
          description: 'Indicates whether this host is in the progress of swapping billing.

            '
          type: boolean
        isVsanByolEnabled:
          description: 'Indicates whether this host embedded VMware vSAN with BYOL Allocation.

            '
          type: boolean
        lifecycleState:
          description: The current state of the ESXi host.
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - DELETED
          - FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleStates'
        nextCommitment:
          description: 'The billing option to switch to after the current billing cycle ends.

            If `nextCommitment` is null or empty, `currentCommitment` continues to the next billing cycle.

            [ListSupportedCommitments](#/en/vmware/20230701/SupportedCommitmentSummary/ListSupportedCommitments).

            '
          enum:
          - HOUR
          - MONTH
          - ONE_YEAR
          - THREE_YEARS
          type: string
          x-obmcs-top-level-enum: '#/definitions/Commitment'
        nonUpgradedEsxiHostId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host that

            will be upgraded.

            '
          type: string
        previousHostOcpuCount:
          description: 'The host OCPU count before OCPU scaling.

            '
          format: float
          minimum: 0
          type: number
        primaryVnicMacAddress:
          description: 'MAC address of ESXi host''s compute instance primary VNIC.

            '
          maxLength: 17
          minLength: 1
          type: string
        replacementEsxiHostId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host that

            is created to replace the failed host.

            '
          type: string
        sddcId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC that the

            ESXi host belongs to.

            '
          type: string
        supportedOcpuCountForScaling:
          description: 'The OCPU count that customers can scale to using increaseHostOcpuCount API.

            '
          format: float
          minimum: 0
          type: number
        swapBillingHostId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the active ESXi Host to swap billing with current host.

            '
          maxLength: 255
          minLength: 1
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

            Example: `{orcl-cloud: {free-tier-retain: true}}`

            '
          type: object
        timeCreated:
          description: 'The date and time the ESXi host was created, in the format defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339).


            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeOcpuScalableUntil:
          description: 'The time before which customers can increase the OCPU count. If this field is empty, it means customer can increase OCPU count at any time.

            '
          format: date-time
          type: string
        timeOcpuScaled:
          description: 'The time when the last OCPU scaling happened.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the ESXi host was updated, in the format defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
        upgradedReplacementEsxiHostId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host that

            is newly created to upgrade the original host.

            '
          type: string
        vcfByolAllocationId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Byol Allocation for VCF (VMware Cloud Foundation) deployment.

            '
          type: string
        vmwareSoftwareVersion:
          description: 'The version of VMware software that Oracle Cloud VMware Solution installed on the ESXi hosts.

            '
          type: string
      required:
      - id
      - sddcId
      - clusterId
      - displayName
      - currentCommitment
      - nextCommitment
      - billingContractEndDate
      - computeAvailabilityDomain
      - freeformTags
      - definedTags
      - hostShapeName
      - vmwareSoftwareVersion
      type: object
  parameters:
    DeletedDonorHostQueryParam:
      description: 'If this flag/param is set to True, we return only deleted hosts with LeftOver billingCycle.

        '
      in: query
      name: isBillingDonorsOnly
      required: false
      x-default-description: 'null'
      schema:
        type: boolean
        default: false
    PaginationTokenQueryParam:
      description: 'For list pagination. The value of the `opc-next-page` response header from the previous "List"

        call. For important details about how pagination works, see

        [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      in: query
      name: page
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 1024
        minLength: 1
    SortByQueryParam:
      description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for

        TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME

        sort order is case sensitive.


        **Note:** In general, some "List" operations (for example, `ListInstances`) let you

        optionally filter by availability domain if the scope of the resource type is within a

        single availability domain. If you call one of these "List" operations without specifying

        an availability domain, the resources are grouped by availability domain, then sorted.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    SddcIdentifierQueryParam:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC.

        '
      in: query
      name: sddcId
      required: false
      x-default-description: 'null'
      schema:
        type: string
    ComputeInstanceIdentifierQueryParam:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Compute instance.

        '
      in: query
      name: computeInstanceId
      required: false
      x-default-description: 'null'
      schema:
        type: string
    SwapBillingEsxiHostIdentifierQueryParam:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the active ESXi Host to swap billing with current host.

        '
      in: query
      name: swapBillingHostId
      required: true
      x-default-description: 'null'
      schema:
        type: string
    IfMatchHeader:
      description: 'For optimistic concurrency control. In the PUT or DELETE call

        for a resource, set the `if-match` parameter to the value of the

        etag from a previous GET or POST response for that resource.

        The resource will be updated or deleted only if the etag you

        provide matches the resource''s current etag value.

        '
      in: header
      name: if-match
      required: false
      schema:
        type: string
    ComputeInstanceIdentifierPathParam:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Compute instance.

        '
      in: path
      name: computeInstanceId
      required: true
      schema:
        type: string
    PaginationLimitQueryParam:
      description: 'For list pagination. The maximum number of results per page, or items to return in a paginated

        "List" call. For important details about how pagination works, see

        [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      in: query
      name: limit
      x-default-description: 'null'
      schema:
        type: integer
        default: 10
        maximum: 1000
        minimum: 1
    SortOrderQueryParam:
      description: 'The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order

        is case sensitive.

        '
      in: query
      name: sortOrder
      x-obmcs-top-level-enum: '#/definitions/SortOrders'
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: ASC
    EsxiHostIdentifierPathParam:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host.

        '
      in: path
      name: esxiHostId
      required: true
      schema:
        type: string
    RequestIdHeader_2:
      description: 'Unique identifier for the request. If you need to contact Oracle about a particular

        request, please provide the request ID.

        '
      in: header
      name: opc-request-id
      schema:
        type: string
    RetryTokenHeader:
      description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or

        server error without risk of executing that same action again. Retry tokens expire after 24

        hours, but can be invalidated before then due to conflicting operations (for example, if a resource

        has been deleted and purged from the system, then a retry of the original creation request

        may be rejected).

        '
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
        maxLength: 64
        minLength: 1
    DisplayNameQueryParam:
      description: A filter to return only resources that match the given display name exactly.
      in: query
      name: displayName
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    LifecycleState:
      description: The lifecycle state of the resource.
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/LifecycleStates'
      schema:
        type: string
        enum:
        - CREATING
        - UPDATING
        - ACTIVE
        - DELETING
        - DELETED
        - FAILED
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      schema:
        type: string
    CompartmentIdOptionalQueryParam:
      description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment as optional parameter.
      in: query
      name: compartmentId
      required: false
      schema:
        type: string
    ActiveDonorHostQueryParam:
      description: 'If this flag/param is set to True, we return only active hosts.

        '
      in: query
      name: isSwapBillingOnly
      required: false
      x-default-description: 'null'
      schema:
        type: boolean
        default: false
  responses:
    default:
      description: Unknown Error
      headers:
        Sunset:
          description: Sunset date when this operation will stop working, in <HTTP-date> format, e.g. "Wed, 21 Jun 2023 11:11:11 GMT"
          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/Error'
    default_2:
      description: Unknown Error
      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
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-refined-from:
- oci-vmware-1-openapi.yaml
- oci-vmware-openapi.yaml
x-anchors:
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    opc-next-page:
      description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

        then a partial list might have been returned. Include this value as the `page` parameter for the

        subsequent GET request to get the next batch of items.

        '
      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.

        '
      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.

        '
      type: string
    retry-after:
      description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
      type: integer
  x-properties:
    definedTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

            '
          type: object
        description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

          Example: `{"bar-key": "value"}`

          '
        type: object
      description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

        Example: `{"foo-namespace": {"bar-key": "value"}}`

        '
      type: object
    freeformTags:
      additionalProperties:
        type: string
      description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

        Example: `{"bar-key": "value"}`

        '
      type: object
    systemTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

            '
          type: object
        description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

          Example: `{"bar-key": "value"}`

          '
        type: object
      description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

        Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

        '
      type: object
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.idm.agcs.cp