oracle.oci.oci_cloud_bridge_agent_facts – Fetches details about one or multiple Agent resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.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_cloud_bridge_agent_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple Agent resources in Oracle Cloud Infrastructure
Returns a list of Agents.
If agent_id is specified, the details of a single Agent will be returned.
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 |
---|---|---|
agent_id
string
|
Unique Agent identifier path parameter.
Required to get a specific agent.
aliases: id |
|
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 ID of the compartment in which to list resources.
Required to list multiple agents.
|
|
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
|
A filter to return only resources that match the entire display name given.
aliases: name |
|
environment_id
string
|
A filter to return only resources that match the given environment ID.
|
|
lifecycle_state
string
|
|
A filter to return only resources their lifecycleState matches the given lifecycleState.
|
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. Default order for timeCreated is descending. Default order for displayName is ascending.
|
sort_order
string
|
|
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 |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific agent
oci_cloud_bridge_agent_facts:
# required
agent_id: "ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx"
- name: List agents
oci_cloud_bridge_agent_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
environment_id: "ocid1.environment.oc1..xxxxxxEXAMPLExxxxxx"
lifecycle_state: CREATING
display_name: display_name_example
agent_id: "ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx"
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 | ||
---|---|---|---|---|
agents
complex
|
on success |
List of Agent resources
Sample:
[{'agent_pub_key': 'agent_pub_key_example', 'agent_type': 'APPLIANCE', 'agent_version': 'agent_version_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'environment_id': 'ocid1.environment.oc1..xxxxxxEXAMPLExxxxxx', 'freeform_tags': {'Department': 'Finance'}, 'heart_beat_status': 'HEALTHY', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'os_version': 'os_version_example', 'plugin_list': [{'agent_id': 'ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'freeform_tags': {'Department': 'Finance'}, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'lifecycle_state_example', 'name': 'name_example', 'plugin_version': 'plugin_version_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}], 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_expire_agent_key_in_ms': '2013-10-20T19:20:30+01:00', 'time_last_sync_received': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
|
||
agent_pub_key
string
|
on success |
Resource principal public key.
Returned for get operation
Sample:
agent_pub_key_example
|
||
agent_type
string
|
on success |
Type of the Agent.
Sample:
APPLIANCE
|
||
agent_version
string
|
on success |
Agent identifier.
Sample:
agent_version_example
|
||
compartment_id
string
|
on success |
Compartment identifier.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
defined_tags
dictionary
|
on success |
The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||
display_name
string
|
on success |
Agent identifier, can be renamed.
Sample:
display_name_example
|
||
environment_id
string
|
on success |
Environment identifier.
Sample:
ocid1.environment.oc1..xxxxxxEXAMPLExxxxxx
|
||
freeform_tags
dictionary
|
on success |
The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: `{"Department": "Finance"}`
Sample:
{'Department': 'Finance'}
|
||
heart_beat_status
string
|
on success |
The current heartbeat status of the Agent based on its timeLastSyncReceived value.
Sample:
HEALTHY
|
||
id
string
|
on success |
Unique identifier that is immutable on creation.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
lifecycle_details
string
|
on success |
A message describing the current state of the Agent in more detail. For example, it 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 the Agent.
Sample:
CREATING
|
||
os_version
string
|
on success |
OS version.
Sample:
os_version_example
|
||
plugin_list
complex
|
on success |
List of plugins associated with the agent.
Returned for get operation
|
||
agent_id
string
|
on success |
Agent identifier.
Sample:
ocid1.agent.oc1..xxxxxxEXAMPLExxxxxx
|
||
defined_tags
dictionary
|
on success |
The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||
freeform_tags
dictionary
|
on success |
The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: `{"Department": "Finance"}`
Sample:
{'Department': 'Finance'}
|
||
lifecycle_details
string
|
on success |
A message describing the current state in more detail. For example, it 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 the plugin.
Sample:
lifecycle_state_example
|
||
name
string
|
on success |
Plugin identifier, which can be renamed.
Sample:
name_example
|
||
plugin_version
string
|
on success |
Plugin version.
Sample:
plugin_version_example
|
||
time_created
string
|
on success |
The time when the plugin was created. An RFC3339 formatted datetime string.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_updated
string
|
on success |
The time when the plugin was updated. An RFC3339 formatted datetime string.
Sample:
2013-10-20T19:20:30+01:00
|
||
system_tags
dictionary
|
on success |
The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: `{orcl-cloud: {free-tier-retain: true}}`
|
||
time_created
string
|
on success |
The time when the Agent was created. An RFC3339 formatted datetime string.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_expire_agent_key_in_ms
string
|
on success |
The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.
Returned for get operation
Sample:
2013-10-20T19:20:30+01:00
|
||
time_last_sync_received
string
|
on success |
The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_updated
string
|
on success |
The time when the Agent was updated. An RFC3339 formatted datetime string.
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)