{ "opencollection": "1.0.0", "info": { "name": "Oracle Esxi Host API", "version": "1.0" }, "items": [ { "info": { "name": "esxiHost", "type": "folder" }, "items": [ { "info": { "name": "Lists the ESXi hosts in the specified SDDC", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/esxiHosts", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sddcId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the SDDC.\n" }, { "name": "computeInstanceId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Compute instance.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The lifecycle state of the resource." }, { "name": "isBillingDonorsOnly", "value": "", "type": "query", "description": "If this flag/param is set to True, we return only deleted hosts with LeftOver billingCycle.\n" }, { "name": "isSwapBillingOnly", "value": "", "type": "query", "description": "If this flag/param is set to True, we return only active hosts.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment as optional parameter." } ] }, "docs": "Lists the ESXi hosts in the specified SDDC. The list can be filtered\nby Compute instance OCID or ESXi display name.\n\nRemember that in terms of implementation, an ESXi host is a Compute instance that\nis configured with the chosen bundle of VMware software. Each `EsxiHost`\nobject has its own OCID (`id`), and a separate attribute for the OCID of\nthe Compute instance (`computeInstanceId`). When filtering the list of\nESXi hosts, you can specify the OCID of the Compute instance, not the\nESXi host OCID" }, { "info": { "name": "Creates an ESXi host", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220518/esxiHosts", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds another ESXi host to an existing SDDC. The attributes of the specified\n`Sddc` determine the VMware software and other configuration settings used\nby the ESXi host.\n\nUse the [WorkRequest](#/en/vmware/20200501/WorkRequest/) operations to track the\ncreation of the ESXi host.\n" }, { "info": { "name": "Gets the specified ESXi host's information", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/esxiHosts/:esxiHostId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "esxiHostId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host.\n" } ] }, "docs": "Gets the specified ESXi host's information." }, { "info": { "name": "Updates the specified ESXi host", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220518/esxiHosts/:esxiHostId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "esxiHostId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified ESXi host." }, { "info": { "name": "Deletes the specified ESXi host", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220518/esxiHosts/:esxiHostId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "esxiHostId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host.\n" } ] }, "docs": "Deletes the specified ESXi host. Before deleting the host, back up or\nmigrate any VMware workloads running on it.\n\nWhen you delete an ESXi host, Oracle does not remove the node\nconfiguration within the VMware environment itself. That is\nyour responsibility.\n\n**Note:** If you delete EXSi hosts from the SDDC to total less than 3,\nyou are still billed for the 3 minimum recommended EXSi hosts. Also,\nyou cannot add more VMware workloads to the SDDC until it again has at\nleast 3 ESXi hosts.\n\nUse the [" }, { "info": { "name": "Acknowledge the replacement of ESXi host licenses.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220518/esxiHosts/:esxiHostId/actions/acknowledgeLicenseReplacement", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "esxiHostId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host.\n" } ] }, "docs": "Acknowledge the replacement of ESXi host licenses." }, { "info": { "name": "Increase the OCPU count of the specified ESXi host", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220518/esxiHosts/:esxiHostId/actions/increaseHostOcpuCount", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "esxiHostId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Increase the OCPU count of the specified ESXi host." }, { "info": { "name": "Swap billing between two Active ESXi hosts.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220518/esxiHosts/:esxiHostId/actions/swapBilling", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "esxiHostId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host.\n" }, { "name": "swapBillingHostId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the active ESXi Host to swap billing with current host.\n" } ] }, "docs": "Swap billing between two Active ESXi hosts.\n" }, { "info": { "name": "Gets ESXi host's information from provided compute instance Id.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/esxiHostByComputeInstanceId/:computeInstanceId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "computeInstanceId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Compute instance.\n" } ] }, "docs": "Gets ESXi host's information from provided compute instance Id." }, { "info": { "name": "In-place upgrade a ESXi host.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220518/esxiHosts/:esxiHostId/actions/inplaceUpgrade", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "esxiHostId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "In-place upgrade a ESXi host.\n" }, { "info": { "name": "Replace a faulty ESXi host whose underlying bare metal is broken", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220518/esxiHosts/:esxiHostId/actions/replaceHost", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "esxiHostId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the ESXi host.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replace a faulty ESXi host whose underlying bare metal is broken\n" } ] } ], "bundled": true }