oracle.oci.oci_management_agent_install_key_facts – Fetches details about one or multiple ManagementAgentInstallKey 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_install_key_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Returns a list of Management Agent installed Keys.

  • If management_agent_install_key_id is specified, the details of a single ManagementAgentInstallKey will be returned.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
access_level
string
Value of this is always "ACCESSIBLE" and any other value is not supported.
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 to list multiple management_agent_install_keys.
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
The display name for which the Key needs to be listed.

aliases: name
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_install_key_id
string
Unique Management Agent Install Key identifier
Required to get a specific management_agent_install_key.

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.
sort_by
string
    Choices:
  • timeCreated
  • displayName
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

Examples

- name: Get a specific management_agent_install_key
  oci_management_agent_install_key_facts:
    # required
    management_agent_install_key_id: "ocid1.managementagentinstallkey.oc1..xxxxxxEXAMPLExxxxxx"

- name: List management_agent_install_keys
  oci_management_agent_install_key_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    compartment_id_in_subtree: true
    access_level: access_level_example
    lifecycle_state: CREATING
    display_name: display_name_example
    sort_order: ASC
    sort_by: timeCreated

Return Values

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

Key Returned Description
management_agent_install_keys
complex
on success
List of ManagementAgentInstallKey resources

Sample:
[{'allowed_key_install_count': 56, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'created_by_principal_id': 'ocid1.createdbyprincipal.oc1..xxxxxxEXAMPLExxxxxx', 'current_key_install_count': 56, 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_unlimited': True, 'key': 'key_example', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'time_created': '2013-10-20T19:20:30+01:00', 'time_expires': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
 
allowed_key_install_count
integer
on success
Total number of install for this keys

Sample:
56
 
compartment_id
string
on success
Compartment Identifier

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
created_by_principal_id
string
on success
Principal id of user who created the Agent Install key

Sample:
ocid1.createdbyprincipal.oc1..xxxxxxEXAMPLExxxxxx
 
current_key_install_count
integer
on success
Total number of install for this keys

Sample:
56
 
display_name
string
on success
Management Agent Install Key Name

Sample:
display_name_example
 
id
string
on success
Agent install Key identifier

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_unlimited
boolean
on success
If set to true, the install key has no expiration date or usage limit. Defaults to false

Sample:
True
 
key
string
on success
Management Agent Install Key
Returned for get operation

Sample:
key_example
 
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
Status of Key

Sample:
CREATING
 
time_created
string
on success
The time when Management Agent install Key was created. An RFC3339 formatted date time string

Sample:
2013-10-20T19:20:30+01:00
 
time_expires
string
on success
date after which key would expire after creation

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time when Management Agent install Key was updated. An RFC3339 formatted date time string
Returned for get operation

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)