oci_dynamic_group_facts - Retrieve facts of dynamic groups

New in version 2.5.

Synopsis

  • This module retrieves information of the specified dynamic group or lists all the dynamic groups in a tenancy.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
api_user
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_OCID 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
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
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
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
    Choices:
  • api_key ←
  • instance_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.
compartment_id
The OCID of the compartment (remember that the tenancy is simply the root compartment). Required to list all the dynamic groups in a tenancy.
config_file_location
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 Default:
DEFAULT
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. dynamic_group_id is required to get a specific dynamic group's information.

aliases: id
name
Use name along with the other options to return only resources that match the given name exactly.
region
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
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 all the dynamic groups in a tenancy
  oci_dynamic_group_facts:
    compartment_id: ocid1.tenancy.oc1..xxxxxEXAMPLExxxxx

- name: Get information of a specific dynamic group
  oci_dynamic_group_facts:
    dynamic_group_id: ocid1.dynamicgroup.oc1..xxxxxEXAMPLExxxxx

Return Values

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

Key Returned Description
dynamic_groups
complex
 always
List of dynamic group details

Sample:
[{'lifecycle_state': 'ACTIVE', 'inactive_status': None, 'description': 'Group for all instances with the tag namespace and tag key operations.department', 'compartment_id': 'ocid1.tenancy.oc1..xxxxxEXAMPLExxxxx', 'matching_rule': 'tag.operations.department.value', 'time_created': '2018-07-05T09:38:27.176000+00:00', 'id': 'ocid1.dynamicgroup.oc1..xxxxxEXAMPLExxxxx', 'name': 'Sample dynamic group'}]
  lifecycle_state
string
 always
The group's current state. After creating a group, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

Sample:
ACTIVE
  inactive_status
int
 always
The detailed status of INACTIVE lifecycleState.

Sample:
1
  description
string
 always
The description you assign to the group. Does not have to be unique, and it's changeable.

Sample:
Group for all instances with the tag namespace and tag key operations.department
  compartment_id
string
 always
The OCID of the tenancy containing the group.

Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
  matching_rule
string
 always
A rule string that defines which instance certificates will be matched. For syntax, see https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Tasks/managingdynamicgroups.htm.

Sample:
tag.operations.department.value
  time_created
datetime
 always
Date and time the group was created, in the format defined by RFC3339.

Sample:
2018-03-28 18:37:56.190000
  id
string
 always
The OCID of the group.

Sample:
ocid1.dynamicgroup.oc1..xxxxxEXAMPLExxxxx
  name
string
 always
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:
Sample dynamic group


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Rohit Chaware (@rohitChaware)

Hint

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