Management Agent Functions

Package: DBMS_CLOUD_OCI_MA_MANAGEMENT_AGENT

CREATE_MANAGEMENT_AGENT_INSTALL_KEY Function

User creates a new install key as part of this API.

Syntax

FUNCTION create_management_agent_install_key (
  create_management_agent_install_key_details dbms_cloud_oci_management_agent_create_management_agent_install_key_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_ma_management_agent_create_management_agent_install_key_response_t;

Parameters

Parameter	Description
`create_management_agent_install_key_details`	(required) Details of the Agent install Key
`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://management-agent.{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_MANAGEMENT_AGENT Function

Deletes a Management Agent resource by identifier

Syntax

FUNCTION delete_management_agent (
  management_agent_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_ma_management_agent_delete_management_agent_response_t;

Parameters

Parameter	Description
`management_agent_id`	(required) Unique Management Agent identifier
`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://management-agent.{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_MANAGEMENT_AGENT_INSTALL_KEY Function

Deletes a Management Agent install Key resource by identifier

Syntax

FUNCTION delete_management_agent_install_key (
  management_agent_install_key_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_ma_management_agent_delete_management_agent_install_key_response_t;

Parameters

Parameter	Description
`management_agent_install_key_id`	(required) Unique Management Agent Install Key identifier
`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://management-agent.{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_WORK_REQUEST Function

Cancel the work request with the given ID.

Syntax

FUNCTION delete_work_request (
  work_request_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_ma_management_agent_delete_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`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://management-agent.{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.

DEPLOY_PLUGINS Function

Deploys Plugins to a given list of agentIds.

Syntax

FUNCTION deploy_plugins (
  deploy_plugins_details dbms_cloud_oci_management_agent_deploy_plugins_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_ma_management_agent_deploy_plugins_response_t;

Parameters

Parameter	Description
`deploy_plugins_details`	(required) Details of Plugins to be deployed for a given list of Management Agents.
`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://management-agent.{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_AUTO_UPGRADABLE_CONFIG Function

Get the AutoUpgradable configuration for all agents in a tenancy. The supplied compartmentId must be a tenancy root.

Syntax

FUNCTION get_auto_upgradable_config (
  compartment_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_ma_management_agent_get_auto_upgradable_config_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment to which a request will be scoped.
`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://management-agent.{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_MANAGEMENT_AGENT Function

Gets complete details of the inventory of a given agent id

Syntax

FUNCTION get_management_agent (
  management_agent_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_ma_management_agent_get_management_agent_response_t;

Parameters

Parameter	Description
`management_agent_id`	(required) Unique Management Agent identifier
`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://management-agent.{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_MANAGEMENT_AGENT_INSTALL_KEY Function

Gets complete details of the Agent install Key for a given key id

Syntax

FUNCTION get_management_agent_install_key (
  management_agent_install_key_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_ma_management_agent_get_management_agent_install_key_response_t;

Parameters

Parameter	Description
`management_agent_install_key_id`	(required) Unique Management Agent Install Key identifier
`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://management-agent.{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_MANAGEMENT_AGENT_INSTALL_KEY_CONTENT Function

Returns a file with Management Agent install Key in it

Syntax

FUNCTION get_management_agent_install_key_content (
  management_agent_install_key_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  plugin_name dbms_cloud_oci_management_agent_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ma_management_agent_get_management_agent_install_key_content_response_t;

Parameters

Parameter	Description
`management_agent_install_key_id`	(required) Unique Management Agent Install Key identifier
`opc_request_id`	(optional) The client request ID for tracing.
`plugin_name`	(optional) Filter to return input plugin names uncommented in the output.
`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://management-agent.{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_WORK_REQUEST Function

Gets the status of the work request with the given ID.

Syntax

FUNCTION get_work_request (
  work_request_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_ma_management_agent_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`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://management-agent.{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_AVAILABILITY_HISTORIES Function

Lists the availability history records of Management Agent

Syntax

FUNCTION list_availability_histories (
  management_agent_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  time_availability_status_ended_greater_than timestamp with time zone DEFAULT NULL,
  time_availability_status_started_less_than timestamp with time zone DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ma_management_agent_list_availability_histories_response_t;

Parameters

Parameter	Description
`management_agent_id`	(required) Unique Management Agent identifier
`opc_request_id`	(optional) The client request ID for tracing.
`time_availability_status_ended_greater_than`	(optional) Filter to limit the availability history results to that of time after the input time including the boundary record. Defaulted to current date minus one year. The date and time to be given as described in RFC 3339, section 5.6.
`time_availability_status_started_less_than`	(optional) Filter to limit the availability history results to that of time before the input time including the boundary record Defaulted to current date. The date and time to be given as described in RFC 3339, section 5.6.
`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. Default order for timeAvailabilityStatusStarted is descending. Allowed values are: 'timeAvailabilityStatusStarted'
`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://management-agent.{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_MANAGEMENT_AGENT_IMAGES Function

Get supported agent image information

Syntax

FUNCTION list_management_agent_images (
  compartment_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  install_type varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ma_management_agent_list_management_agent_images_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment to which a request will be scoped.
`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.
`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 platformType is descending. Default order for version is descending. If no value is specified platformType is default. Allowed values are: 'platformType', 'version'
`name`	(optional) A filter to return only resources that match the entire platform name given.
`lifecycle_state`	(optional) Filter to return only Management Agents in the particular lifecycle state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'TERMINATED', 'DELETING', 'DELETED', 'FAILED'
`install_type`	(optional) A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned. Allowed values are: 'AGENT', 'GATEWAY'
`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://management-agent.{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_MANAGEMENT_AGENT_INSTALL_KEYS Function

Returns a list of Management Agent installed Keys.

Syntax

FUNCTION list_management_agent_install_keys (
  compartment_id varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 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_ma_management_agent_list_management_agent_install_keys_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment to which a request will be scoped.
`compartment_id_in_subtree`	(optional) if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.
`access_level`	(optional) Value of this is always \"ACCESSIBLE\" and any other value is not supported.
`lifecycle_state`	(optional) Filter to return only Management Agents in the particular lifecycle state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'TERMINATED', 'DELETING', 'DELETED', 'FAILED'
`display_name`	(optional) The display name for which the Key needs to be listed.
`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://management-agent.{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_MANAGEMENT_AGENT_PLUGINS Function

Returns a list of managementAgentPlugins.

Syntax

FUNCTION list_management_agent_plugins (
  compartment_id varchar2,
  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,
  platform_type dbms_cloud_oci_management_agent_varchar2_tbl DEFAULT NULL,
  agent_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ma_management_agent_list_management_agent_plugins_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment to which a request will be scoped.
`display_name`	(optional) Filter to return only Management Agent Plugins having the particular display name.
`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. Default order for displayName is ascending. If no value is specified displayName is default. Allowed values are: 'displayName'
`opc_request_id`	(optional) The client request ID for tracing.
`lifecycle_state`	(optional) Filter to return only Management Agents in the particular lifecycle state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'TERMINATED', 'DELETING', 'DELETED', 'FAILED'
`platform_type`	(optional) Filter to return only results having the particular platform type. Allowed values are: 'LINUX', 'WINDOWS', 'SOLARIS', 'MACOSX'
`agent_id`	(optional) The ManagementAgentID of the agent from which the Management Agents to be filtered.
`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://management-agent.{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_MANAGEMENT_AGENTS Function

Returns a list of Management Agents. If no explicit page size limit is specified, it will default to 1000 when compartmentIdInSubtree is true and 5000 otherwise. The response is limited to maximum 1000 records when compartmentIdInSubtree is true.

Syntax

FUNCTION list_management_agents (
  compartment_id varchar2,
  plugin_name dbms_cloud_oci_management_agent_varchar2_tbl DEFAULT NULL,
  version dbms_cloud_oci_management_agent_varchar2_tbl DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  availability_status varchar2 DEFAULT NULL,
  host_id varchar2 DEFAULT NULL,
  platform_type dbms_cloud_oci_management_agent_varchar2_tbl DEFAULT NULL,
  is_customer_deployed number DEFAULT NULL,
  install_type varchar2 DEFAULT NULL,
  gateway_id dbms_cloud_oci_management_agent_varchar2_tbl 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,
  compartment_id_in_subtree number DEFAULT NULL,
  access_level varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ma_management_agent_list_management_agents_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment to which a request will be scoped.
`plugin_name`	(optional) Filter to return only Management Agents having the particular Plugin installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed.
`version`	(optional) Filter to return only Management Agents having the particular agent version.
`display_name`	(optional) Filter to return only Management Agents having the particular display name.
`lifecycle_state`	(optional) Filter to return only Management Agents in the particular lifecycle state. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'INACTIVE', 'TERMINATED', 'DELETING', 'DELETED', 'FAILED'
`availability_status`	(optional) Filter to return only Management Agents in the particular availability status. Allowed values are: 'ACTIVE', 'SILENT', 'NOT_AVAILABLE'
`host_id`	(optional) Filter to return only Management Agents having the particular agent host id.
`platform_type`	(optional) Filter to return only results having the particular platform type. Allowed values are: 'LINUX', 'WINDOWS', 'SOLARIS', 'MACOSX'
`is_customer_deployed`	(optional) true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
`install_type`	(optional) A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned. Allowed values are: 'AGENT', 'GATEWAY'
`gateway_id`	(optional) Filter to return only results having the particular gatewayId.
`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', 'host', 'availabilityStatus', 'platformType', 'pluginDisplayNames', 'version'
`opc_request_id`	(optional) The client request ID for tracing.
`compartment_id_in_subtree`	(optional) if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.
`access_level`	(optional) When the value is \"ACCESSIBLE\", insufficient permissions for a compartment will filter out resources in that compartment without rejecting the request.
`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://management-agent.{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_WORK_REQUEST_ERRORS Function

Return a (paginated) list of errors for a given work request.

Syntax

FUNCTION list_work_request_errors (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ma_management_agent_list_work_request_errors_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`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 Allowed values are: 'timestamp'
`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://management-agent.{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_WORK_REQUEST_LOGS Function

Return a (paginated) list of logs for a given work request.

Syntax

FUNCTION list_work_request_logs (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ma_management_agent_list_work_request_logs_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`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 Allowed values are: 'timestamp'
`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://management-agent.{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_WORK_REQUESTS Function

Lists the work requests in a compartment.

Syntax

FUNCTION list_work_requests (
  compartment_id varchar2,
  agent_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  status varchar2 DEFAULT NULL,
  l_type varchar2 DEFAULT NULL,
  time_created_greater_than_or_equal_to timestamp with time zone DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ma_management_agent_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment to which a request will be scoped.
`agent_id`	(optional) The ManagementAgentID of the agent from which the Management Agents to be filtered.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`status`	(optional) The OperationStatus of the workRequest Allowed values are: 'CREATED', 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED'
`l_type`	(optional) The OperationType of the workRequest Allowed values are: 'DEPLOY_PLUGIN', 'UPGRADE_PLUGIN', 'CREATE_UPGRADE_PLUGINS', 'AGENTIMAGE_UPGRADE'
`time_created_greater_than_or_equal_to`	(optional) Filter for items with timeCreated greater or equal to provided value. given `timeCreatedGreaterThanOrEqualTo` to the current time, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as defined by RFC 3339.
`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 timeAccepted is descending. If no value is specified timeAccepted is default. Allowed values are: 'timeAccepted'
`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://management-agent.{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.

SET_AUTO_UPGRADABLE_CONFIG Function

Sets the AutoUpgradable configuration for all agents in a tenancy. The supplied compartmentId must be a tenancy root.

Syntax

FUNCTION set_auto_upgradable_config (
  set_auto_upgradable_config_details dbms_cloud_oci_management_agent_set_auto_upgradable_config_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_ma_management_agent_set_auto_upgradable_config_response_t;

Parameters

Parameter	Description
`set_auto_upgradable_config_details`	(required) Details of the AutoUpgradable configuration for agents of the tenancy.
`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://management-agent.{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.

SUMMARIZE_MANAGEMENT_AGENT_COUNTS Function

Gets count of the inventory of agents for a given compartment id, group by, and isPluginDeployed parameters. Supported groupBy parameters: availabilityStatus, platformType, version

Syntax

FUNCTION summarize_management_agent_counts (
  compartment_id varchar2,
  group_by dbms_cloud_oci_management_agent_varchar2_tbl,
  has_plugins number DEFAULT NULL,
  install_type varchar2 DEFAULT NULL,
  compartment_id_in_subtree number DEFAULT NULL,
  page 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_ma_management_agent_summarize_management_agent_counts_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment to which a request will be scoped.
`group_by`	(required) The field by which to group Management Agents. Currently, only one groupBy dimension is supported at a time. Allowed values are: 'availabilityStatus', 'platformType', 'version'
`has_plugins`	(optional) When set to true then agents that have at least one plugin deployed will be returned. When set to false only agents that have no plugins deployed will be returned.
`install_type`	(optional) A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned. Allowed values are: 'AGENT', 'GATEWAY'
`compartment_id_in_subtree`	(optional) if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`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://management-agent.{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.

SUMMARIZE_MANAGEMENT_AGENT_PLUGIN_COUNTS Function

Gets count of the inventory of management agent plugins for a given compartment id and group by parameter. Supported groupBy parameter: pluginName

Syntax

FUNCTION summarize_management_agent_plugin_counts (
  compartment_id varchar2,
  group_by varchar2,
  compartment_id_in_subtree number DEFAULT NULL,
  page 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_ma_management_agent_summarize_management_agent_plugin_counts_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment to which a request will be scoped.
`group_by`	(required) The field by which to group Management Agent Plugins Allowed values are: 'pluginName'
`compartment_id_in_subtree`	(optional) if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`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://management-agent.{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_MANAGEMENT_AGENT Function

API to update the console managed properties of the Management Agent.

Syntax

FUNCTION update_management_agent (
  management_agent_id varchar2,
  update_management_agent_details dbms_cloud_oci_management_agent_update_management_agent_details_t,
  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_ma_management_agent_update_management_agent_response_t;

Parameters

Parameter	Description
`management_agent_id`	(required) Unique Management Agent identifier
`update_management_agent_details`	(required) Details required for changing the console managed properties of the Management Agent.
`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://management-agent.{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_MANAGEMENT_AGENT_INSTALL_KEY Function

API to update the modifiable properties of the Management Agent install key.

Syntax

FUNCTION update_management_agent_install_key (
  management_agent_install_key_id varchar2,
  update_management_agent_install_key_details dbms_cloud_oci_management_agent_update_management_agent_install_key_details_t,
  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_ma_management_agent_update_management_agent_install_key_response_t;

Parameters

Parameter	Description
`management_agent_install_key_id`	(required) Unique Management Agent Install Key identifier
`update_management_agent_install_key_details`	(required) Details required for changing the modifiable properties of the Management Agent install key.
`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://management-agent.{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_MANAGEMENT_AGENT_INSTALL_KEY Function 🔗

DELETE_MANAGEMENT_AGENT Function 🔗

DELETE_MANAGEMENT_AGENT_INSTALL_KEY Function 🔗

DELETE_WORK_REQUEST Function 🔗

DEPLOY_PLUGINS Function 🔗

GET_AUTO_UPGRADABLE_CONFIG Function 🔗

GET_MANAGEMENT_AGENT Function 🔗

GET_MANAGEMENT_AGENT_INSTALL_KEY Function 🔗

GET_MANAGEMENT_AGENT_INSTALL_KEY_CONTENT Function 🔗

GET_WORK_REQUEST Function 🔗

LIST_AVAILABILITY_HISTORIES Function 🔗

LIST_MANAGEMENT_AGENT_IMAGES Function 🔗

LIST_MANAGEMENT_AGENT_INSTALL_KEYS Function 🔗

LIST_MANAGEMENT_AGENT_PLUGINS Function 🔗

LIST_MANAGEMENT_AGENTS Function 🔗

LIST_WORK_REQUEST_ERRORS Function 🔗

LIST_WORK_REQUEST_LOGS Function 🔗

LIST_WORK_REQUESTS Function 🔗

SET_AUTO_UPGRADABLE_CONFIG Function 🔗

SUMMARIZE_MANAGEMENT_AGENT_COUNTS Function 🔗

SUMMARIZE_MANAGEMENT_AGENT_PLUGIN_COUNTS Function 🔗

UPDATE_MANAGEMENT_AGENT Function 🔗

UPDATE_MANAGEMENT_AGENT_INSTALL_KEY Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CREATE_MANAGEMENT_AGENT_INSTALL_KEY Function

DELETE_MANAGEMENT_AGENT Function

DELETE_MANAGEMENT_AGENT_INSTALL_KEY Function

DELETE_WORK_REQUEST Function

DEPLOY_PLUGINS Function

GET_AUTO_UPGRADABLE_CONFIG Function

GET_MANAGEMENT_AGENT Function

GET_MANAGEMENT_AGENT_INSTALL_KEY Function

GET_MANAGEMENT_AGENT_INSTALL_KEY_CONTENT Function

GET_WORK_REQUEST Function

LIST_AVAILABILITY_HISTORIES Function

LIST_MANAGEMENT_AGENT_IMAGES Function

LIST_MANAGEMENT_AGENT_INSTALL_KEYS Function

LIST_MANAGEMENT_AGENT_PLUGINS Function

LIST_MANAGEMENT_AGENTS Function

LIST_WORK_REQUEST_ERRORS Function

LIST_WORK_REQUEST_LOGS Function

LIST_WORK_REQUESTS Function

SET_AUTO_UPGRADABLE_CONFIG Function

SUMMARIZE_MANAGEMENT_AGENT_COUNTS Function

SUMMARIZE_MANAGEMENT_AGENT_PLUGIN_COUNTS Function

UPDATE_MANAGEMENT_AGENT Function

UPDATE_MANAGEMENT_AGENT_INSTALL_KEY Function