ReportingManagedInstanceClient¶

class oci.os_management_hub.ReportingManagedInstanceClient(config, **kwargs)¶

Use the OS Management Hub API to manage and monitor updates and patches for instances in OCI, your private data center, or 3rd-party clouds. For more information, see [Overview of OS Management Hub](https://docs.cloud.oracle.com/iaas/osmh/doc/overview.htm).

Methods

`__init__`(config, **kwargs)	Creates a new service client
`get_managed_instance_analytic_content`(**kwargs)	Returns a report of managed instances matching the given filters.
`get_managed_instance_content`(…)	Returns a report for a single managed instance whose associated erratas match the given filters.
`summarize_managed_instance_analytics`(…)	Returns a list of user specified metrics for a collection of managed instances.

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
signer (AbstractBaseSigner) –
(optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

get_managed_instance_analytic_content(**kwargs)¶

Returns a report of managed instances matching the given filters. You can select CSV, XML, or JSON format.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment. This filter returns only resources contained within the specified compartment. managed_instance_group_id (str) – (optional) The OCID of the managed instance group. This filter returns resources associated with this group. lifecycle_environment_id (str) – (optional) The OCID of the lifecycle environment. This filter returns only resource contained with the specified lifecycle environment. lifecycle_stage_id (str) – (optional) The OCID of the lifecycle stage. This resource returns resources associated with this lifecycle stage. status (list[str]) – (optional) A filter to return only managed instances whose status matches the status provided. Allowed values are: “NORMAL”, “UNREACHABLE”, “ERROR”, “WARNING”, “REGISTRATION_ERROR”, “DELETING”, “ONBOARDING” display_name (list[str]) – (optional) A filter to return resources that match the given display names. display_name_contains (str) – (optional) A filter to return resources that may partially match the given display name. security_updates_available_equals_to (int) – (optional) A filter to return instances that have the specified number of available security updates. bug_updates_available_equals_to (int) – (optional) A filter to return instances that have the specified number of available bug updates. security_updates_available_greater_than (int) – (optional) A filter to return instances that have more available security updates than the number specified. bug_updates_available_greater_than (int) – (optional) A filter to return instances that have more available bug updates than the number specified. location (list[str]) – (optional) A filter to return only resources whose location matches the given value. Allowed values are: “ON_PREMISE”, “OCI_COMPUTE”, “AZURE”, “EC2”, “GCP” location_not_equal_to (list[str]) – (optional) A filter to return only resources whose location does not match the given value. Allowed values are: “ON_PREMISE”, “OCI_COMPUTE”, “AZURE”, “EC2”, “GCP” os_family (list[str]) – (optional) A filter to return only resources that match the given operating system family. Allowed values are: “ORACLE_LINUX_9”, “ORACLE_LINUX_8”, “ORACLE_LINUX_7”, “ORACLE_LINUX_6”, “WINDOWS_SERVER_2016”, “WINDOWS_SERVER_2019”, “WINDOWS_SERVER_2022”, “ALL” is_managed_by_autonomous_linux (bool) – (optional) Indicates whether to list only resources managed by the Autonomous Linux service. report_format (str) – (optional) The format of the report to download. Default is CSV. Allowed values are: “csv”, “json”, “xml” report_type (str) – (optional) The type of the report the user wants to download. Default is ALL. Allowed values are: “SECURITY”, “BUGFIX”, “ACTIVITY”, “ALL” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type stream
Return type:	`Response`
Example:

Click here to see an example of how to use get_managed_instance_analytic_content API.

get_managed_instance_content(managed_instance_id, vulnerability_type, **kwargs)¶

Returns a report for a single managed instance whose associated erratas match the given filters. You can select CSV, XML, or JSON format.

Parameters:	managed_instance_id (str) – (required) The OCID of the managed instance. vulnerability_type (oci.os_management_hub.models.list[str]) – (required) A filter to return only vulnerabilities matching the given types. Allowed values are: “SECURITY”, “BUGFIX”, “ENHANCEMENT”, “OTHER”, “ALL” advisory_name (list[str]) – (optional) The assigned erratum name. It’s unique and not changeable. Example: ELSA-2020-5804 advisory_name_contains (str) – (optional) A filter to return resources that may partially match the erratum advisory name given. advisory_type (list[str]) – (optional) A filter to return only errata that match the given advisory types. Allowed values are: “SECURITY”, “BUGFIX”, “ENHANCEMENT” vulnerability_name (list[str]) – (optional) A filter to return vulnerabilities that match the given name. For Linux instances, this refers to the advisory name. For Windows instances, this refers to the Windows update display name. vulnerability_name_contains (str) – (optional) A filter to return vulnerabilities that partially match the given name. For Linux instances, this refers to the advisory name. For Windows instances, this refers to the Windows update display name. report_format (str) – (optional) The format of the report to download. Default is CSV. Allowed values are: “csv”, “json”, “xml” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type stream
Return type:	`Response`
Example:

Click here to see an example of how to use get_managed_instance_content API.

summarize_managed_instance_analytics(metric_names, **kwargs)¶

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

Parameters:	metric_names (oci.os_management_hub.models.list[str]) – (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”, “DELETING_INSTANCE_COUNT”, “ONBOARDING_INSTANCE_COUNT”, “INSTANCE_SECURITY_UPDATES_COUNT”, “INSTANCE_BUGFIX_UPDATES_COUNT”, “INSTANCE_SECURITY_ADVISORY_COUNT”, “INSTANCE_BUGFIX_ADVISORY_COUNT” compartment_id (str) – (optional) The OCID of the compartment. This filter returns only resources contained within the specified compartment. managed_instance_group_id (str) – (optional) The OCID of the managed instance group. This filter returns resources associated with this group. lifecycle_environment_id (str) – (optional) The OCID of the lifecycle environment. This filter returns only resource contained with the specified lifecycle environment. lifecycle_stage_id (str) – (optional) The OCID of the lifecycle stage. This resource returns resources associated with this lifecycle stage. status (list[str]) – (optional) A filter to return only managed instances whose status matches the status provided. Allowed values are: “NORMAL”, “UNREACHABLE”, “ERROR”, “WARNING”, “REGISTRATION_ERROR”, “DELETING”, “ONBOARDING” location (list[str]) – (optional) A filter to return only resources whose location matches the given value. Allowed values are: “ON_PREMISE”, “OCI_COMPUTE”, “AZURE”, “EC2”, “GCP” location_not_equal_to (list[str]) – (optional) A filter to return only resources whose location does not match the given value. Allowed values are: “ON_PREMISE”, “OCI_COMPUTE”, “AZURE”, “EC2”, “GCP” os_family (list[str]) – (optional) A filter to return only resources that match the given operating system family. Allowed values are: “ORACLE_LINUX_9”, “ORACLE_LINUX_8”, “ORACLE_LINUX_7”, “ORACLE_LINUX_6”, “WINDOWS_SERVER_2016”, “WINDOWS_SERVER_2019”, “WINDOWS_SERVER_2022”, “ALL” is_managed_by_autonomous_linux (bool) – (optional) Indicates whether to list only resources managed by the Autonomous Linux service. display_name (list[str]) – (optional) A filter to return resources that match the given display names. display_name_contains (str) – (optional) A filter to return resources that may partially match the given display name. limit (int) – (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 (str) – (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 (str) – (optional) The field to sort by. Only one sort order may be provided. The default is to sort in ascending order by metricName (previously name, which is now depricated). You can also sort by displayName (default is ascending order). Allowed values are: “name”, “metricName”, “displayName” sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ManagedInstanceAnalyticCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use summarize_managed_instance_analytics API.