Oracle Cloud Infrastructure Documentation
Try Free Tier

Compute Instance Agent Plugin Functions

Package: DBMS_CLOUD_OCI_CIA_PLUGIN

GET_INSTANCE_AGENT_PLUGIN Function

The API to get information for a plugin.

Syntax

FUNCTION get_instance_agent_plugin (
  instanceagent_id varchar2,
  compartment_id varchar2,
  plugin_name 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_plugin_get_instance_agent_plugin_response_t;

Parameters

Parameter Description

instanceagent_id

(required) The OCID of the instance.

compartment_id

(required) The OCID of the compartment.

plugin_name

(required) The name of the plugin.

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_PLUGINS Function

The API to get one or more plugin information.

Syntax

FUNCTION list_instance_agent_plugins (
  compartment_id varchar2,
  instanceagent_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  status varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cia_plugin_list_instance_agent_plugins_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID of the compartment.

instanceagent_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.

status

(optional) The plugin status

Allowed values are: 'RUNNING', 'STOPPED', 'NOT_SUPPORTED', 'INVALID'

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'

name

(optional) The plugin name

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.

Was this article helpful?