OS Management Hub Reporting Managed Instance Functions

Package: DBMS_CLOUD_OCI_OMH_REPORTING_MANAGED_INSTANCE

GET_MANAGED_INSTANCE_ANALYTIC_CONTENT Function

Returns a CSV format report of managed instances matching the given filters.

Syntax

FUNCTION get_managed_instance_analytic_content (
  compartment_id varchar2 DEFAULT NULL,
  managed_instance_group_id varchar2 DEFAULT NULL,
  lifecycle_environment_id varchar2 DEFAULT NULL,
  lifecycle_stage_id varchar2 DEFAULT NULL,
  status dbms_cloud_oci_os_management_hub_varchar2_tbl DEFAULT NULL,
  display_name dbms_cloud_oci_os_management_hub_varchar2_tbl DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  instance_location varchar2 DEFAULT NULL,
  security_updates_available_equals_to number DEFAULT NULL,
  bug_updates_available_equals_to number DEFAULT NULL,
  security_updates_available_greater_than number DEFAULT NULL,
  bug_updates_available_greater_than number 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_omh_reporting_managed_instance_get_managed_instance_analytic_content_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) This compartmentId is used to list managed instances within a compartment. Or serve as an additional filter to restrict only managed instances with in certain compartment if other filter presents.
`managed_instance_group_id`	(optional) The OCID of the managed instance group for which to list resources.
`lifecycle_environment_id`	(optional) The OCID of the lifecycle environment.
`lifecycle_stage_id`	(optional) The OCID of the lifecycle stage for which to list resources.
`status`	(optional) A filter to return only instances whose managed instance status matches the given status. Allowed values are: 'NORMAL', 'UNREACHABLE', 'ERROR', 'WARNING', 'REGISTRATION_ERROR'
`display_name`	(optional) A filter to return resources that match the given display names.
`display_name_contains`	(optional) A filter to return resources that may partially match the given display name.
`instance_location`	(optional) Filter instances by Location. Used when report target type is compartment or group. Allowed values are: 'ON_PREMISE', 'OCI_COMPUTE', 'AZURE', 'EC2'
`security_updates_available_equals_to`	(optional) A filter to return instances with number of available security updates equals to the number specified.
`bug_updates_available_equals_to`	(optional) A filter to return instances with number of available bug updates equals to the number specified.
`security_updates_available_greater_than`	(optional) A filter to return instances with number of available security updates greater than the number specified.
`bug_updates_available_greater_than`	(optional) A filter to return instances with number of available bug updates greater than the number specified.
`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://osmh.{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_MANAGED_INSTANCE_CONTENT Function

Returns a CSV format report of a single managed instance whose associated Erratas match the given filters.

Syntax

FUNCTION get_managed_instance_content (
  managed_instance_id varchar2,
  advisory_name dbms_cloud_oci_os_management_hub_varchar2_tbl DEFAULT NULL,
  advisory_name_contains varchar2 DEFAULT NULL,
  advisory_type dbms_cloud_oci_os_management_hub_varchar2_tbl 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_omh_reporting_managed_instance_get_managed_instance_content_response_t;

Parameters

Parameter	Description
`managed_instance_id`	(required) The OCID of the managed instance.
`advisory_name`	(optional) The assigned erratum name. It's unique and not changeable. Example: `ELSA-2020-5804`
`advisory_name_contains`	(optional) A filter to return resources that may partially match the erratum advisory name given.
`advisory_type`	(optional) A filter to return only errata that match the given advisory types. Allowed values are: 'SECURITY', 'BUGFIX', 'ENHANCEMENT'
`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://osmh.{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_MANAGED_INSTANCE_ANALYTICS Function

Returns a list of user specified metrics for a collection of managed instances.

Syntax

FUNCTION summarize_managed_instance_analytics (
  metric_names dbms_cloud_oci_os_management_hub_varchar2_tbl,
  compartment_id varchar2 DEFAULT NULL,
  managed_instance_group_id varchar2 DEFAULT NULL,
  lifecycle_environment_id varchar2 DEFAULT NULL,
  lifecycle_stage_id varchar2 DEFAULT NULL,
  status dbms_cloud_oci_os_management_hub_varchar2_tbl DEFAULT NULL,
  display_name dbms_cloud_oci_os_management_hub_varchar2_tbl DEFAULT NULL,
  display_name_contains varchar2 DEFAULT NULL,
  instance_location varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order 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_omh_reporting_managed_instance_summarize_managed_instance_analytics_response_t;

Parameters

Parameter	Description
`metric_names`	(required) A filter to return only metrics whose name matches the given metric names. Allowed values are: 'TOTAL_INSTANCE_COUNT', 'INSTANCE_WITH_AVAILABLE_SECURITY_UPDATES_COUNT', 'INSTANCE_WITH_AVAILABLE_BUGFIX_UPDATES_COUNT', 'NORMAL_INSTANCE_COUNT', 'ERROR_INSTANCE_COUNT', 'WARNING_INSTANCE_COUNT', 'UNREACHABLE_INSTANCE_COUNT', 'REGISTRATION_FAILED_INSTANCE_COUNT', 'INSTANCE_SECURITY_UPDATES_COUNT', 'INSTANCE_BUGFIX_UPDATES_COUNT'
`compartment_id`	(optional) This compartmentId is used to list managed instances within a compartment. Or serve as an additional filter to restrict only managed instances with in certain compartment if other filter presents.
`managed_instance_group_id`	(optional) The OCID of the managed instance group for which to list resources.
`lifecycle_environment_id`	(optional) The OCID of the lifecycle environment.
`lifecycle_stage_id`	(optional) The OCID of the lifecycle stage for which to list resources.
`status`	(optional) A filter to return only instances whose managed instance status matches the given status. Allowed values are: 'NORMAL', 'UNREACHABLE', 'ERROR', 'WARNING', 'REGISTRATION_ERROR'
`display_name`	(optional) A filter to return resources that match the given display names.
`display_name_contains`	(optional) A filter to return resources that may partially match the given display name.
`instance_location`	(optional) Filter instances by Location. Used when report target type is compartment or group. Allowed values are: 'ON_PREMISE', 'OCI_COMPUTE', 'AZURE', 'EC2'
`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. Example: `50`
`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. Example: `3`
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for name is ascending. Allowed values are: 'name'
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`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://osmh.{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

GET_MANAGED_INSTANCE_ANALYTIC_CONTENT Function

GET_MANAGED_INSTANCE_CONTENT Function

SUMMARIZE_MANAGED_INSTANCE_ANALYTICS Function