OCVP Cluster Functions

CREATE_CLUSTER Function

Create a vSphere Cluster in software-defined data center (SDDC). Use the WORK_REQUEST Type operations to track the creation of the Cluster. **Important:** You must configure the Cluster'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.

Syntax

FUNCTION create_cluster (
  create_cluster_details dbms_cloud_oci_ocvp_create_cluster_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ov_cluster_create_cluster_response_t;

Parameters

Parameter	Description
`create_cluster_details`	(required) Details for the Cluster.
`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).
`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_CLUSTER Function

Deletes the specified Cluster, along with the other resources that were created with the Cluster. For example: the Compute instances, DNS records, and so on. Use the WORK_REQUEST Type operations to track the deletion of the Cluster.

Syntax

FUNCTION delete_cluster (
  cluster_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ov_cluster_delete_cluster_response_t;

Parameters

Parameter	Description
`cluster_id`	(required) The OCID of the Cluster.
`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.

GET_CLUSTER Function

Gets the specified Cluster's information.

Syntax

FUNCTION get_cluster (
  cluster_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ov_cluster_get_cluster_response_t;

Parameters

Parameter	Description
`cluster_id`	(required) The OCID of the Cluster.
`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.

LIST_CLUSTERS Function

Lists the Clusters in the specified compartment.

Syntax

FUNCTION list_clusters (
  sddc_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  compartment_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ov_cluster_list_clusters_response_t;

Parameters

Parameter	Description
`sddc_id`	(optional) The OCID of the SDDC.
`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.
`lifecycle_state`	(optional) The lifecycle state of the resource. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'
`compartment_id`	(optional) The OCID of the compartment as optional parameter.
`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_CLUSTER Function

Updates the specified Cluster. **Important:** Updating a Cluster affects only certain attributes in the `Cluster` object and does not affect the VMware environment currently running in the Cluster.

Syntax

FUNCTION update_cluster (
  cluster_id varchar2,
  update_cluster_details dbms_cloud_oci_ocvp_update_cluster_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ov_cluster_update_cluster_response_t;

Parameters

Parameter	Description
`cluster_id`	(required) The OCID of the Cluster.
`update_cluster_details`	(required) The information to be updated.
`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.

Oracle Cloud Infrastructure Documentation Try Free Tier

CREATE_CLUSTER Function 🔗

DELETE_CLUSTER Function 🔗

GET_CLUSTER Function 🔗

LIST_CLUSTERS Function 🔗

UPDATE_CLUSTER Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CREATE_CLUSTER Function

DELETE_CLUSTER Function

GET_CLUSTER Function

LIST_CLUSTERS Function

UPDATE_CLUSTER Function