oracle.oci.oci_apm_config_config_facts – Fetches details about one or multiple Config 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_apm_config_config_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Returns all configuration items, which can optionally be filtered by configuration type.

  • If config_id is specified, the details of a single Config will be returned.

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).
apm_domain_id
string / required
The APM Domain ID the request is intended for.
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.
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_id
string
The OCID of the configuration item.
Required to get a specific config.

aliases: id
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.
config_type
string
A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.
defined_tag_equals
list / elements=string
A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "{namespace}.{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
defined_tag_exists
list / elements=string
A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag) or "{namespace}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
display_name
string
A filter to return resources that match the given display name.

aliases: name
freeform_tag_equals
list / elements=string
A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
freeform_tag_exists
list / elements=string
A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "{tagName}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
options_group
string
A filter to return OPTIONS resources that match the given group.
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:
  • displayName
  • timeCreated
  • timeUpdated
The field to sort by. You can provide one "sortBy" value. The default order for displayName, timeCreated and timeUpdated is ascending. The displayName sort by is case-sensitive.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either ascending (`ASC`) or descending (`DESC`). The displayName sort order is case-sensitive.
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 config
  oci_apm_config_config_facts:
    # required
    config_id: "ocid1.config.oc1..xxxxxxEXAMPLExxxxxx"
    apm_domain_id: "ocid1.apmdomain.oc1..xxxxxxEXAMPLExxxxxx"

- name: List configs
  oci_apm_config_config_facts:
    # required
    apm_domain_id: "ocid1.apmdomain.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    config_type: config_type_example
    display_name: display_name_example
    sort_order: ASC
    sort_by: displayName
    options_group: options_group_example
    defined_tag_equals: [ "defined_tag_equals_example" ]
    freeform_tag_equals: [ "freeform_tag_equals_example" ]
    defined_tag_exists: [ "defined_tag_exists_example" ]
    freeform_tag_exists: [ "freeform_tag_exists_example" ]

Return Values

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

Key Returned Description
configs
complex
on success
List of Config resources

Sample:
[{'config_type': 'SPAN_FILTER', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'dimensions': [{'name': 'name_example', 'value_source': 'value_source_example'}], 'display_name': 'display_name_example', 'filter_id': 'ocid1.filter.oc1..xxxxxxEXAMPLExxxxxx', 'filter_text': 'filter_text_example', 'freeform_tags': {'Department': 'Finance'}, 'group': 'group_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'metrics': [{'description': 'description_example', 'name': 'name_example', 'unit': 'unit_example', 'value_source': 'value_source_example'}], 'namespace': 'namespace_example', 'options': {}, 'rules': [{'display_name': 'display_name_example', 'filter_text': 'filter_text_example', 'is_apply_to_error_spans': True, 'is_enabled': True, 'priority': 56, 'satisfied_response_time': 56, 'tolerating_response_time': 56}], 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
 
config_type
string
on success
The type of configuration item.

Sample:
SPAN_FILTER
 
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'}}
 
description
string
on success
An optional string that describes what the options are intended or used for.
Returned for get operation

Sample:
description_example
 
dimensions
complex
on success
A list of dimensions for the metric. This variable should not be used.
Returned for get operation

   
name
string
on success
The name of the dimension.

Sample:
name_example
   
value_source
string
on success
The source to populate the dimension. This must not be specified.

Sample:
value_source_example
 
display_name
string
on success
The name by which a configuration entity is displayed to the end user.
Returned for get operation

Sample:
display_name_example
 
filter_id
string
on success
The OCID of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId is generated when a Span Filter is created.
Returned for get operation

Sample:
ocid1.filter.oc1..xxxxxxEXAMPLExxxxxx
 
filter_text
string
on success
The string that defines the Span Filter expression.
Returned for get operation

Sample:
filter_text_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'}
 
group
string
on success
A string that specifies the group that an OPTIONS item belongs to.
Returned for get operation

Sample:
group_example
 
id
string
on success
The OCID of the configuration item. An OCID is generated when the item is created.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
metrics
complex
on success
The list of metrics in this group.
Returned for get operation

   
description
string
on success
A description of the metric.

Sample:
description_example
   
name
string
on success
The name of the metric. This must be a known metric name.

Sample:
name_example
   
unit
string
on success
The unit of the metric.

Sample:
unit_example
   
value_source
string
on success
This must not be set.

Sample:
value_source_example
 
namespace
string
on success
The namespace to which the metrics are published. It must be one of several predefined namespaces.
Returned for get operation

Sample:
namespace_example
 
options
dictionary
on success
The options are stored here as JSON.
Returned for get operation

 
rules
complex
on success
Returned for get operation

   
display_name
string
on success
The name by which a configuration entity is displayed to the end user.

Sample:
display_name_example
   
filter_text
string
on success
The string that defines the Span Filter expression.

Sample:
filter_text_example
   
is_apply_to_error_spans
boolean
on success
Specifies whether an Apdex score should be computed for error spans. Setting it to "true" means that the Apdex score is computed in the usual way. Setting it to "false" skips the Apdex computation and sets the Apdex score to "frustrating" regardless of the configured thresholds. The default is "false".

Sample:
True
   
is_enabled
boolean
on success
Specifies whether the Apdex score should be computed for spans matching the rule. This can be used to disable Apdex score for spans that do not need or require it. The default is "true".

Sample:
True
   
priority
integer
on success
The priority controls the order in which multiple rules in a rule set are applied. Lower values indicate higher priorities. Rules with higher priority are applied first, and once a match is found, the rest of the rules are ignored. Rules within the same rule set cannot have the same priority.

Sample:
56
   
satisfied_response_time
integer
on success
The maximum response time in milliseconds that is considered "satisfactory" for the end user.

Sample:
56
   
tolerating_response_time
integer
on success
The maximum response time in milliseconds that is considered "tolerable" for the end user. A response time beyond this threshold is considered "frustrating". This value cannot be lower than "satisfiedResponseTime".

Sample:
56
 
time_created
string
on success
The time the resource was created, expressed in RFC 3339 timestamp format. Example: `2020-02-12T22:47:12.613Z`

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the resource was updated, expressed in RFC 3339 timestamp format. Example: `2020-02-13T22:47:12.613Z`

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


Authors

  • Oracle (@oracle)