Roving Edge Infrastructure Entitlement Functions

Package: DBMS_CLOUD_OCI_RV_ROVER_ENTITLEMENT

CHANGE_ROVER_ENTITLEMENT_COMPARTMENT Function

Moves an entitlement into a different compartment.

Syntax

FUNCTION change_rover_entitlement_compartment (
  rover_entitlement_id varchar2,
  change_rover_entitlement_compartment_details dbms_cloud_oci_rover_change_rover_entitlement_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rv_rover_entitlement_change_rover_entitlement_compartment_response_t;

Parameters

Parameter	Description
`rover_entitlement_id`	(required) ID of the rover node or cluster entitlement
`change_rover_entitlement_compartment_details`	(required) CompartmentId of the destination compartment
`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) The client request ID for tracing.
`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 might 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://rover.{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_ROVER_ENTITLEMENT Function

Create the Entitlement to use a Rover Device. It requires some offline process of review and signatures before request is granted.

Syntax

FUNCTION create_rover_entitlement (
  create_rover_entitlement_details dbms_cloud_oci_rover_create_rover_entitlement_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_rv_rover_entitlement_create_rover_entitlement_response_t;

Parameters

Parameter	Description
`create_rover_entitlement_details`	(required) Creates a Rover Device Entitlement
`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 might be rejected.
`opc_request_id`	(optional) The client request ID for tracing.
`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://rover.{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_ROVER_ENTITLEMENT Function

Deletes a rover entitlement

Syntax

FUNCTION delete_rover_entitlement (
  rover_entitlement_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rv_rover_entitlement_delete_rover_entitlement_response_t;

Parameters

Parameter	Description
`rover_entitlement_id`	(required) ID of the rover node or cluster entitlement
`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 might be rejected.
`opc_request_id`	(optional) The client request ID for tracing.
`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.
`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://rover.{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_ROVER_ENTITLEMENT Function

Describes the Rover Device Entitlement in detail

Syntax

FUNCTION get_rover_entitlement (
  rover_entitlement_id varchar2,
  compartment_id varchar2,
  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_rv_rover_entitlement_get_rover_entitlement_response_t;

Parameters

Parameter	Description
`rover_entitlement_id`	(required) ID of the rover node or cluster entitlement
`compartment_id`	(required) The OCID of the compartment in which to list resources.
`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 might be rejected.
`opc_request_id`	(optional) The client request ID for tracing.
`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://rover.{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_ROVER_ENTITLEMENTS Function

Returns a list of RoverEntitlements.

Syntax

FUNCTION list_rover_entitlements (
  compartment_id varchar2,
  id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state 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,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rv_rover_entitlement_list_rover_entitlements_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment in which to list resources.
`id`	(optional) filtering by Rover Device Entitlement id
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`lifecycle_state`	(optional) A filter to return only resources their lifecycleState matches the given lifecycleState. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) The client request ID for tracing.
`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://rover.{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_ROVER_ENTITLEMENT Function

Updates the RoverEntitlement

Syntax

FUNCTION update_rover_entitlement (
  rover_entitlement_id varchar2,
  update_rover_entitlement_details dbms_cloud_oci_rover_update_rover_entitlement_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_rv_rover_entitlement_update_rover_entitlement_response_t;

Parameters

Parameter	Description
`rover_entitlement_id`	(required) ID of the rover node or cluster entitlement
`update_rover_entitlement_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) The client request ID for tracing.
`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://rover.{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

CHANGE_ROVER_ENTITLEMENT_COMPARTMENT Function 🔗

CREATE_ROVER_ENTITLEMENT Function 🔗

DELETE_ROVER_ENTITLEMENT Function 🔗

GET_ROVER_ENTITLEMENT Function 🔗

LIST_ROVER_ENTITLEMENTS Function 🔗

UPDATE_ROVER_ENTITLEMENT Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CHANGE_ROVER_ENTITLEMENT_COMPARTMENT Function

CREATE_ROVER_ENTITLEMENT Function

DELETE_ROVER_ENTITLEMENT Function

GET_ROVER_ENTITLEMENT Function

LIST_ROVER_ENTITLEMENTS Function

UPDATE_ROVER_ENTITLEMENT Function