Compute Instance Agent Functions

CANCEL_INSTANCE_AGENT_COMMAND Function

Cancels a command that is scheduled to run on a compute instance that is managed by Oracle Cloud Agent. Canceling a command is a best-effort attempt. If the command has already completed, it will not be canceled.

Syntax

FUNCTION cancel_instance_agent_command (
  instance_agent_command_id varchar2,
  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_cia_compute_instance_agent_cancel_instance_agent_command_response_t;

Parameters

Parameter	Description
`instance_agent_command_id`	(required) The OCID of the command.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`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://iaas.{region}.{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_INSTANCE_AGENT_COMMAND Function

Creates a command or script to run on a compute instance that is managed by Oracle Cloud Agent. On Linux instances, the script runs in a bash shell. On Windows instances, the script runs in a batch shell. Commands that require administrator privileges will run only if Oracle Cloud Agent is running with administrator privileges.

Syntax

FUNCTION create_instance_agent_command (
  create_instance_agent_command_details dbms_cloud_oci_compute_instance_agent_create_instance_agent_command_details_t,
  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_cia_compute_instance_agent_create_instance_agent_command_response_t;

Parameters

Parameter	Description
`create_instance_agent_command_details`	(required) Create Instance agent command details
`opc_request_id`	(optional) Unique Oracle-assigned 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://iaas.{region}.{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_INSTANCE_AGENT_COMMAND Function

Gets information about an Oracle Cloud Agent command.

Syntax

FUNCTION get_instance_agent_command (
  instance_agent_command_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_cia_compute_instance_agent_get_instance_agent_command_response_t;

Parameters

Parameter	Description
`instance_agent_command_id`	(required) The OCID of the command.
`opc_request_id`	(optional) Unique Oracle-assigned 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://iaas.{region}.{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_INSTANCE_AGENT_COMMAND_EXECUTION Function

Gets information about the status of specified instance agent commandId for the given instanceId.

Syntax

FUNCTION get_instance_agent_command_execution (
  instance_agent_command_id varchar2,
  instance_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_cia_compute_instance_agent_get_instance_agent_command_execution_response_t;

Parameters

Parameter	Description
`instance_agent_command_id`	(required) The OCID of the command.
`instance_id`	(required) The OCID of the instance.
`opc_request_id`	(optional) Unique Oracle-assigned 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://iaas.{region}.{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_INSTANCE_AGENT_COMMAND_EXECUTIONS Function

Lists the execution details for Oracle Cloud Agent commands that run on the specified compute instance.

Syntax

FUNCTION list_instance_agent_command_executions (
  compartment_id varchar2,
  instance_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cia_compute_instance_agent_list_instance_agent_command_executions_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`instance_id`	(required) The OCID of the instance.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`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.
`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.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for `TIMECREATED` is descending. 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'
`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'
`lifecycle_state`	(optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
`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://iaas.{region}.{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_INSTANCE_AGENT_COMMANDS Function

Lists the Oracle Cloud Agent commands issued in a compartment.

Syntax

FUNCTION list_instance_agent_commands (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cia_compute_instance_agent_list_instance_agent_commands_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`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.
`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.
`sort_by`	(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for `TIMECREATED` is descending. 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'
`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'
`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://iaas.{region}.{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

CANCEL_INSTANCE_AGENT_COMMAND Function 🔗

CREATE_INSTANCE_AGENT_COMMAND Function 🔗

GET_INSTANCE_AGENT_COMMAND Function 🔗

GET_INSTANCE_AGENT_COMMAND_EXECUTION Function 🔗

LIST_INSTANCE_AGENT_COMMAND_EXECUTIONS Function 🔗

LIST_INSTANCE_AGENT_COMMANDS Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CANCEL_INSTANCE_AGENT_COMMAND Function

CREATE_INSTANCE_AGENT_COMMAND Function

GET_INSTANCE_AGENT_COMMAND Function

GET_INSTANCE_AGENT_COMMAND_EXECUTION Function

LIST_INSTANCE_AGENT_COMMAND_EXECUTIONS Function

LIST_INSTANCE_AGENT_COMMANDS Function