oracle.oci.oci_management_agent_facts – Fetches details about one or multiple ManagementAgent resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.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_management_agent_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple ManagementAgent resources in Oracle Cloud Infrastructure

  • 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.

  • If management_agent_id is specified, the details of a single ManagementAgent will be returned.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
access_level
string
When the value is "ACCESSIBLE", insufficient permissions for a compartment will filter out resources in that compartment without rejecting the request.
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
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.
availability_status
string
    Choices:
  • ACTIVE
  • SILENT
  • NOT_AVAILABLE
Filter to return only Management Agents in the particular availability status.
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 to which a request will be scoped.
Required to list multiple management_agents.
compartment_id_in_subtree
boolean
    Choices:
  • no
  • yes
if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.
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
string
Filter to return only Management Agents having the particular display name.

aliases: name
host_id
string
Filter to return only Management Agents having the particular agent host id.
install_type
string
    Choices:
  • AGENT
  • GATEWAY
A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.
is_customer_deployed
boolean
    Choices:
  • no
  • yes
true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
lifecycle_state
string
    Choices:
  • CREATING
  • UPDATING
  • ACTIVE
  • INACTIVE
  • TERMINATED
  • DELETING
  • DELETED
  • FAILED
Filter to return only Management Agents in the particular lifecycle state.
management_agent_id
string
Unique Management Agent identifier
Required to get a specific management_agent.

aliases: id
platform_type
list / elements=string
    Choices:
  • LINUX
  • WINDOWS
  • SOLARIS
Filter to return only results having the particular platform type.
plugin_name
list / elements=string
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.
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
    Choices:
  • timeCreated
  • displayName
  • host
  • availabilityStatus
  • platformType
  • pluginDisplayNames
  • version
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.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'asc' or 'desc'.
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
version
list / elements=string
Filter to return only Management Agents having the particular agent version.

Examples

- name: Get a specific management_agent
  oci_management_agent_facts:
    # required
    management_agent_id: "ocid1.managementagent.oc1..xxxxxxEXAMPLExxxxxx"

- name: List management_agents
  oci_management_agent_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    plugin_name: [ "plugin_name_example" ]
    version: [ "version_example" ]
    display_name: display_name_example
    lifecycle_state: CREATING
    availability_status: ACTIVE
    host_id: "ocid1.host.oc1..xxxxxxEXAMPLExxxxxx"
    platform_type: [ "LINUX" ]
    is_customer_deployed: true
    install_type: AGENT
    sort_order: ASC
    sort_by: timeCreated
    compartment_id_in_subtree: true
    access_level: access_level_example

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
management_agents
complex
on success
List of ManagementAgent resources

Sample:
[{'availability_status': 'ACTIVE', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'host': 'host_example', 'host_id': 'ocid1.host.oc1..xxxxxxEXAMPLExxxxxx', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'install_key_id': 'ocid1.installkey.oc1..xxxxxxEXAMPLExxxxxx', 'install_path': 'install_path_example', 'install_type': 'AGENT', 'is_agent_auto_upgradable': True, 'is_customer_deployed': True, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'platform_name': 'platform_name_example', 'platform_type': 'LINUX', 'platform_version': 'platform_version_example', 'plugin_list': [{'is_enabled': True, 'plugin_display_name': 'plugin_display_name_example', 'plugin_id': 'ocid1.plugin.oc1..xxxxxxEXAMPLExxxxxx', 'plugin_name': 'plugin_name_example', 'plugin_status': 'RUNNING', 'plugin_status_message': 'plugin_status_message_example', 'plugin_version': 'plugin_version_example'}], 'resource_artifact_version': 'resource_artifact_version_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_last_heartbeat': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'version': 'version_example'}]
 
availability_status
string
on success
The current availability status of managementAgent

Sample:
ACTIVE
 
compartment_id
string
on success
Compartment Identifier

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
Management Agent Name

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
host
string
on success
Management Agent host machine name

Sample:
host_example
 
host_id
string
on success
Host resource ocid

Sample:
ocid1.host.oc1..xxxxxxEXAMPLExxxxxx
 
id
string
on success
agent identifier

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
install_key_id
string
on success
agent install key identifier

Sample:
ocid1.installkey.oc1..xxxxxxEXAMPLExxxxxx
 
install_path
string
on success
Path where Management Agent is installed
Returned for get operation

Sample:
install_path_example
 
install_type
string
on success
The install type, either AGENT or GATEWAY

Sample:
AGENT
 
is_agent_auto_upgradable
boolean
on success
true if the agent can be upgraded automatically; false if it must be upgraded manually. This flag is derived from the tenancy level auto upgrade preference.

Sample:
True
 
is_customer_deployed
boolean
on success
true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.

Sample:
True
 
lifecycle_details
string
on success
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of managementAgent

Sample:
CREATING
 
platform_name
string
on success
Platform Name

Sample:
platform_name_example
 
platform_type
string
on success
Platform Type

Sample:
LINUX
 
platform_version
string
on success
Platform Version

Sample:
platform_version_example
 
plugin_list
complex
on success
list of managementAgentPlugins associated with the agent

   
is_enabled
boolean
on success
flag indicating whether the plugin is in enabled mode or disabled mode.

Sample:
True
   
plugin_display_name
string
on success
Management Agent Plugin Identifier, can be renamed

Sample:
plugin_display_name_example
   
plugin_id
string
on success
Plugin Id

Sample:
ocid1.plugin.oc1..xxxxxxEXAMPLExxxxxx
   
plugin_name
string
on success
Management Agent Plugin Name

Sample:
plugin_name_example
   
plugin_status
string
on success
Plugin Status

Sample:
RUNNING
   
plugin_status_message
string
on success
Status message of the Plugin

Sample:
plugin_status_message_example
   
plugin_version
string
on success
Plugin Version

Sample:
plugin_version_example
 
resource_artifact_version
string
on success
Version of the deployment artifact instantiated by this Management Agent. The format for Standalone resourceMode is YYMMDD.HHMM, and the format for other modes (whose artifacts are based upon Standalone but can advance independently) is YYMMDD.HHMM.VVVVVVVVVVVV. VVVVVVVVVVVV is always a numeric value between 000000000000 and 999999999999

Sample:
resource_artifact_version_example
 
time_created
string
on success
The time the Management Agent was created. An RFC3339 formatted datetime string

Sample:
2013-10-20T19:20:30+01:00
 
time_last_heartbeat
string
on success
The time the Management Agent has last recorded its health status in telemetry. This value will be null if the agent has not recorded its health status in last 7 days. An RFC3339 formatted datetime string

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the Management Agent was updated. An RFC3339 formatted datetime string

Sample:
2013-10-20T19:20:30+01:00
 
version
string
on success
Management Agent Version

Sample:
version_example


Authors

  • Oracle (@oracle)