Oracle Esxi Host API

The esxiHost API from Oracle — 8 operation(s) for esxihost.

Documentation

📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/access-governance-cp/20220518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/adm/20220421/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/advisor/20200606/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ai-data-platform/20240831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/analytics/20190331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/announcements/0.0.1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/api-gateway/20190501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-config/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-control-plane/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-synthetic-monitoring/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-trace-explorer/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/audit/20190901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/autoscaling/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bastion/20210331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/batch/20251031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bigdata/20190531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/blockchain/20191010/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/budgets/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificates/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificatesmgmt/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cloud-guard/20200131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/clusterplacementgroups/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/compute-cloud-at-customer/20221208/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-registry/20180419/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/containerengine/20180222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cost-anomaly/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dashboard/20210731/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-catalog/20190325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-flow/20200129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-integration/20200430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-safe/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-science/20190101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-management/20201101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-migration/20230518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-multicloud-integrations/20240501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools/20201005/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools-runtime/20230222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datacc/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling-dp/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/delegate-access-control/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/devops/20210630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/digital-assistant/20190506/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/disaster-recovery/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dms/20211101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dns/20180115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/document-understanding/20221109/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/edsfu/20220528/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildelivery/20170907/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildeliverysubmission/20220926/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/events/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fleet-management/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functions/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functionsdocgenpbf/1.0/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fusion-applications/20211201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents-client/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-inference/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-nl2sql/20260325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generic/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/globally-distributed-database/20250101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/goldengate/20200407/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/healthchecks/20180501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iaas/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-domains/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-dp/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/incidentmanagement/20181231/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/instanceagent/20180530/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/integration/20190131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iot/20250531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/itas/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms/20210610/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-utils/20250521/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/kafka/20240901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/key/release/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/language/20221001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/licensemanager/20220430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits-increase/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits/20181025/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/loadbalancer/20170115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logan-api-spec/20200601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-dataplane/20200831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-management/20200531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-search/20190909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/lustre/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managed-access/20220126/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/management-agent/20200202/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/marketplace/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mngdmac/20250320/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/monitoring/20180401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/multicloud-omhub-cp/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mysql/20190415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/NetMonitor/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20230501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/networkloadbalancer/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/nosql-database/20190828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/OCB/20220509/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occ/20230515/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occds/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occm/20231107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocicache/20220315/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocm/20220919/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opa/20210621/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opensearch/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operations-insights/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operatoraccesscontrol/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/oracle-api-access-control/20241130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20230401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20200801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/osmh/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/postgresql/20220915/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/psasvc/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/publisher/20241201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/queue/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/recovery-service/20210216/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/registry/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-analytics/20241031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-discovery-monitoring-control-api/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-scheduler/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resourcemanager/20180917/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/rover/20201210/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/s3objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/scanning/20210215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/search/20180409/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretmgmt/20180608/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretretrieval/20190301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secure-desktops/20220618/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/security-attribute/20240815/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/self/20260129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/service-catalog/20210527/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/serviceconnectors/20200909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/smp/20210914/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/speech/20220101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/stack-monitoring/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/threat-intel/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage/20200107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage-proxy/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vision/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder/20210601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder-studio/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20230701/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waa/20211230/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waas/20181116/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waf/20210930/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/wlms/20241101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/workrequests/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing-tools/20240301/

Specifications

OpenAPI Specification

oracle-esxihost-api-openapi.yml Raw ↑
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'
        n

# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-esxihost-api-openapi.yml