oracle.oci.oci_os_management_hub_managed_instance_analytic_content_facts – Fetches details about a ManagedInstanceAnalyticContent resource 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_content_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about a ManagedInstanceAnalyticContent resource in Oracle Cloud Infrastructure

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

Requirements

The below requirements are needed on the host that executes this module.

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
    Choices:
  • service_principal
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
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
  • security_token
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.
bug_updates_available_equals_to
integer
A filter to return instances that have the specified number of available bug updates.
bug_updates_available_greater_than
integer
A filter to return instances that have more available bug updates than the number specified.
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.
dest
string / required
The destination file path to write the output. The file will be created if it does not exist. If the file already exists, the content will be overwritten.
display_name
list / elements=string
A filter to return resources that match the given display names.

aliases: name
display_name_contains
string
A filter to return resources that may partially match the given display name.
is_managed_by_autonomous_linux
boolean
    Choices:
  • no
  • yes
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
    Choices:
  • ON_PREMISE
  • OCI_COMPUTE
  • AZURE
  • EC2
  • GCP
A filter to return only resources whose location matches the given value.
location_not_equal_to
list / elements=string
    Choices:
  • ON_PREMISE
  • OCI_COMPUTE
  • AZURE
  • EC2
  • GCP
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.
os_family
list / elements=string
    Choices:
  • ORACLE_LINUX_9
  • ORACLE_LINUX_8
  • ORACLE_LINUX_7
  • ORACLE_LINUX_6
  • WINDOWS_SERVER_2016
  • WINDOWS_SERVER_2019
  • WINDOWS_SERVER_2022
  • ALL
A filter to return only resources that match the given operating system family.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
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.
report_format
string
    Choices:
  • csv
  • json
  • xml
The format of the report to download. Default is CSV.
report_type
string
    Choices:
  • SECURITY
  • BUGFIX
  • ACTIVITY
  • ALL
The type of the report the user wants to download. Default is ALL.
security_updates_available_equals_to
integer
A filter to return instances that have the specified number of available security updates.
security_updates_available_greater_than
integer
A filter to return instances that have more available security updates than the number specified.
status
list / elements=string
    Choices:
  • NORMAL
  • UNREACHABLE
  • ERROR
  • WARNING
  • REGISTRATION_ERROR
  • DELETING
  • ONBOARDING
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

Examples

- name: Get a specific managed_instance_analytic_content
  oci_os_management_hub_managed_instance_analytic_content_facts:
    # required
    dest: /tmp/myfile

    # 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" ]
    display_name: [ "display_name_example" ]
    display_name_contains: display_name_contains_example
    security_updates_available_equals_to: 56
    bug_updates_available_equals_to: 56
    security_updates_available_greater_than: 56
    bug_updates_available_greater_than: 56
    location: [ "ON_PREMISE" ]
    location_not_equal_to: [ "ON_PREMISE" ]
    os_family: [ "ORACLE_LINUX_9" ]
    is_managed_by_autonomous_linux: true
    report_format: csv
    report_type: SECURITY

Authors

  • Oracle (@oracle)