(optional) 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).
if_match
(optional) 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.
opc_request_id
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://ocvps.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
CHANGE_SDDC_COMPARTMENT Function 🔗
Moves an SDDC into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
(required) Request to change the compartment of the specified SDDC
if_match
(optional) 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.
opc_request_id
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc_retry_token
(optional) 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).
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://ocvps.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
CREATE_SDDC Function 🔗
Creates an Oracle Cloud VMware Solution software-defined data center (SDDC). Use the WORK_REQUEST Type operations to track the creation of the SDDC. **Important:** You must configure the SDDC's networking resources with the security rules detailed in Security Rules for Oracle Cloud VMware Solution SDDCs. Otherwise, provisioning the SDDC will fail. The rules are based on the requirements set by VMware.
(optional) 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).
opc_request_id
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://ocvps.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
DELETE_SDDC Function 🔗
Deletes the specified SDDC, along with the other resources that were created with the SDDC. For example: the Compute instances, DNS records, and so on. Use the WORK_REQUEST Type operations to track the deletion of the SDDC.
(optional) 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.
opc_request_id
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://ocvps.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
DOWNGRADE_HCX Function 🔗
Downgrade the specified SDDC from HCX Enterprise to HCX Advanced. SDDC with standard compute shapes will always use HCX Enterprise if HCX is enabled and cannot be downgraded. Downgrading from HCX Enterprise to HCX Advanced reduces the number of provided license keys from 10 to 3. Downgrade remains in a `PENDING` state until the end of the current billing cycle. You can use CANCEL_DOWNGRADE_HCX Function to cancel the downgrade while it's still in a `PENDING` state.
(optional) 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).
if_match
(optional) 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.
opc_request_id
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://ocvps.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://ocvps.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
LIST_SDDCS Function 🔗
Lists the SDDCs in the specified compartment. The list can be filtered by display name or availability domain.
(optional) The name of the availability domain that the Compute instances are running in. Example: `Uocm:PHX-AD-1`
display_name
(optional) A filter to return only resources that match the given display name exactly.
limit
(optional) 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.
page
(optional) 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.
sort_order
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive.
Allowed values are: 'ASC', 'DESC'
sort_by
(optional) 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.
Allowed values are: 'timeCreated', 'displayName'
opc_request_id
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://ocvps.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
(optional) 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.
page
(optional) 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.
opc_request_id
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
host_shape_name
(optional) A filter to return only resources that match or support the given ESXi host shape.
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://ocvps.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
LIST_SUPPORTED_HOST_SHAPES Function 🔗
Lists supported compute shapes for ESXi hosts.
Syntax
FUNCTION list_supported_host_shapes (
compartment_id varchar2,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
name varchar2 DEFAULT NULL,
is_single_host_sddc_supported number DEFAULT NULL,
initial_host_shape_name varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ov_sddc_list_supported_host_shapes_response_t;
(optional) 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.
page
(optional) 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.
opc_request_id
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
name
(optional) A filter to return only resources that match the given name exactly.
is_single_host_sddc_supported
(optional) A filter to return only resources that support single host SDDC.
initial_host_shape_name
(optional) A filter to return only the shapes compatible with the initial host shape of the Cluster.
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://ocvps.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
LIST_SUPPORTED_VMWARE_SOFTWARE_VERSIONS Function 🔗
Lists the versions of bundled VMware software supported by the Oracle Cloud VMware Solution.
Syntax
FUNCTION list_supported_vmware_software_versions (
compartment_id varchar2,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
version varchar2 DEFAULT NULL,
host_shape_name varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ov_sddc_list_supported_vmware_software_versions_response_t;
(optional) 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.
page
(optional) 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.
opc_request_id
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
version
(optional) A filter to return only resources that match the given VMware software version exactly.
host_shape_name
(optional) A filter to return only resources that match or support the given ESXi host shape.
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://ocvps.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
REFRESH_HCX_LICENSE_STATUS Function 🔗
Refresh HCX on-premise licenses status of the specified SDDC.
(optional) 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).
if_match
(optional) 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.
opc_request_id
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://ocvps.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
(optional) 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.
opc_request_id
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc_retry_token
(optional) 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).
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://ocvps.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
UPDATE_SDDC Function 🔗
Updates the specified SDDC. **Important:** Updating an SDDC affects only certain attributes in the `Sddc` object and does not affect the VMware environment currently running in the SDDC. For more information, see UPDATE_SDDC_DETAILS Function.
(optional) 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.
opc_request_id
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://ocvps.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.
UPGRADE_HCX Function 🔗
Upgrade the specified SDDC from HCX Advanced to HCX Enterprise.
(optional) 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).
if_match
(optional) 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.
opc_request_id
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
region
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
endpoint
(optional) The endpoint of the service to call using this function. e.g https://ocvps.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
credential_name
(optional) The name of the credential for authenticating with the corresponding cloud native API.