oracle.oci.oci_management_agent – Manage a ManagementAgent resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to update and delete a ManagementAgent resource in Oracle Cloud Infrastructure

  • This resource has the following action operations in the oracle.oci.oci_management_agent_actions module: deploy_plugins.

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
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 to which a request will be scoped.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
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.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
display_name
string
New displayName of Agent.
Required for update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
freeform_tags
dictionary
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
This parameter is updatable.
management_agent_id
string
Unique Management Agent identifier
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
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.
state
string
    Choices:
  • present ←
  • absent
The state of the ManagementAgent.
Use state=present to update an existing a ManagementAgent.
Use state=absent to delete a ManagementAgent.
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
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Update management_agent
  oci_management_agent:
    # required
    management_agent_id: "ocid1.managementagent.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update management_agent using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_management_agent:
    # required
    display_name: display_name_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete management_agent
  oci_management_agent:
    # required
    management_agent_id: "ocid1.managementagent.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete management_agent using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_management_agent:
    # required
    display_name: display_name_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values

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

Key Returned Description
management_agent
complex
on success
Details of the ManagementAgent resource acted upon by the current operation

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

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)