oci_dynamic_group_facts – Fetches details about one or multiple DynamicGroup resources in Oracle Cloud Infrastructure

New in version 2.5.

Synopsis

  • Fetches details about one or multiple DynamicGroup resources in Oracle Cloud Infrastructure
  • Lists the dynamic groups in your tenancy. You must specify your tenancy’s OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy’s OCID and User’s OCID.
  • If dynamic_group_id is specified, the details of a single DynamicGroup 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).
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
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.
compartment_id
-
The OCID of the compartment (remember that the tenancy is simply the root compartment).
Required to list multiple dynamic_groups.
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.
dynamic_group_id
-
The OCID of the dynamic group.
Required to get a specific dynamic_group.

aliases: id
name
string
Use name along with the other options to return only resources that match the given name exactly.
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.
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: List dynamic_groups
  oci_dynamic_group_facts:
    compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx

- name: Get a specific dynamic_group
  oci_dynamic_group_facts:
    dynamic_group_id: ocid1.dynamicgroup.oc1..xxxxxxEXAMPLExxxxxx

Return Values

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

Key Returned Description
dynamic_groups
complex
on success
List of DynamicGroup resources

Sample:
[{'freeform_tags': {'Department': 'Finance'}, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'matching_rule': 'matching_rule_example', 'description': 'description_example', 'inactive_status': 56, 'name': 'name_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'time_created': '2016-08-25T21:10:29.600Z', 'lifecycle_state': 'CREATING', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}]
  compartment_id
string
on success
The OCID of the tenancy containing the group.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
  defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
  description
string
on success
The description you assign to the group. Does not have to be unique, and it's changeable.

Sample:
description_example
  freeform_tags
dictionary
on success
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
  id
string
on success
The OCID of the group.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
  inactive_status
integer
on success
The detailed status of INACTIVE lifecycleState.

Sample:
56
  lifecycle_state
string
on success
The group's current state. After creating a group, make sure its `lifecycleState` changes from CREATING to ACTIVE before using it.

Sample:
CREATING
  matching_rule
string
on success
A rule string that defines which instance certificates will be matched. For syntax, see Managing Dynamic Groups.

Sample:
matching_rule_example
  name
string
on success
The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.

Sample:
name_example
  time_created
string
on success
Date and time the group was created, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`

Sample:
2016-08-25 21:10:29.600000+00:00


Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]
  • This module is maintained by the Ansible Community. [community]

Authors

  • Manoj Meda (@manojmeda)
  • Mike Ross (@mross22)
  • Nabeel Al-Saber (@nalsaber)

Hint

If you notice any issues in this documentation you can edit this document to improve it.