oracle.oci.oci_os_management_hub_managed_instance_analytic_facts – Fetches details about one or multiple ManagedInstanceAnalytic resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.5.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install oracle.oci.
To use it in a playbook, specify: oracle.oci.oci_os_management_hub_managed_instance_analytic_facts.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple ManagedInstanceAnalytic resources in Oracle Cloud Infrastructure
Returns a list of user specified metrics for a collection of managed instances.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
| Parameter | Choices/Defaults | Comments |
|---|---|---|
|
api_user
string
|
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See
config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|
|
api_user_fingerprint
string
|
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See
config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|
|
api_user_key_file
string
|
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See
config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided. |
|
|
api_user_key_pass_phrase
string
|
Passphrase used by the key referenced in
api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location). |
|
|
auth_purpose
string
|
|
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
|
|
auth_type
string
|
|
The type of authentication to use for making API requests. By default
auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance. |
|
cert_bundle
string
|
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
|
|
|
compartment_id
string
|
The OCID of the compartment. This filter returns only resources contained within the specified compartment.
|
|
|
config_file_location
string
|
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
|
|
|
config_profile_name
string
|
The profile to load from the config file referenced by
config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location. |
|
|
display_name
list
/ elements=string
|
A filter to return resources that match the given display names.
|
|
|
display_name_contains
string
|
A filter to return resources that may partially match the given display name.
|
|
|
is_managed_by_autonomous_linux
boolean
|
|
Indicates whether to list only resources managed by the Autonomous Linux service.
|
|
lifecycle_environment_id
string
|
The OCID of the lifecycle environment. This filter returns only resource contained with the specified lifecycle environment.
|
|
|
lifecycle_stage_id
string
|
The OCID of the lifecycle stage. This resource returns resources associated with this lifecycle stage.
|
|
|
location
list
/ elements=string
|
|
A filter to return only resources whose location matches the given value.
|
|
location_not_equal_to
list
/ elements=string
|
|
A filter to return only resources whose location does not match the given value.
|
|
managed_instance_group_id
string
|
The OCID of the managed instance group. This filter returns resources associated with this group.
|
|
|
metric_names
list
/ elements=string / required
|
|
A filter to return only metrics whose name matches the given metric names.
|
|
name
string
|
Use name along with the other options to return only resources that match the given name exactly.
|
|
|
os_family
list
/ elements=string
|
|
A filter to return only resources that match the given operating system family.
|
|
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
|
region
string
|
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See
config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions. |
|
|
sort_by
string
|
|
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).
|
|
sort_order
string
|
|
The sort order to use, either 'ASC' or 'DESC'.
|
|
status
list
/ elements=string
|
|
A filter to return only managed instances whose status matches the status provided.
|
|
tenancy
string
|
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See
config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: List managed_instance_analytics
oci_os_management_hub_managed_instance_analytic_facts:
# required
metric_names: [ "TOTAL_INSTANCE_COUNT" ]
# optional
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
managed_instance_group_id: "ocid1.managedinstancegroup.oc1..xxxxxxEXAMPLExxxxxx"
lifecycle_environment_id: "ocid1.lifecycleenvironment.oc1..xxxxxxEXAMPLExxxxxx"
lifecycle_stage_id: "ocid1.lifecyclestage.oc1..xxxxxxEXAMPLExxxxxx"
status: [ "NORMAL" ]
location: [ "ON_PREMISE" ]
location_not_equal_to: [ "ON_PREMISE" ]
os_family: [ "ORACLE_LINUX_9" ]
is_managed_by_autonomous_linux: true
display_name: [ "display_name_example" ]
display_name_contains: display_name_contains_example
sort_by: name
sort_order: ASC
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Oracle (@oracle)