oci_group_facts - Fetches details of all the OCI groups of a tenancy and the users associated¶
New in version 2.5.
Synopsis¶
- Fetches details of all the OCI groups of a tenancy and the users associated with them.
Requirements¶
The below requirements are needed on the host that executes this module.
- python >= 2.6
- Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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 |
|
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. |
| 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. |
| group_id |
Identifier of the group whose details should be fetched
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 |
Notes¶
Note
- For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
#Fetch a specific group details
- name : List OCI user group facts
oci_group_facts:
group_id: 'ocid1.group.oci.asdx'
#Fetch all groups
- name : List all OCI user groups
oci_group_facts:
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |
|---|---|---|---|
|
groups
complex
|
always |
List of group details
Sample:
[{'lifecycle_state': 'ACTIVE', 'inactive_status': None, 'description': 'Test Ansible Group', 'compartment_id': 'ocidv1:tenancy:oc1:phx:xxxxxEXAMPLExxxxx', 'defined_tags': {'product': {'type': 'server'}}, 'freeform_tags': {'group_name': 'designer'}, 'time_created': '2017-10-31T16:38:22.289000+00:00', 'members': [{'lifecycle_state': 'ACTIVE', 'inactive_status': None, 'name': 'test_user1', 'compartment_id': 'ocidv1:tenancy:oc1:phx:xxxxxEXAMPLExxxxx', 'defined_tags': {'department': {'division': 'engineering'}}, 'freeform_tags': {'user_type': 'admin'}, 'time_created': '2017-09-25T09:20:10.768000+00:00', 'id': 'ocid1.user.oc1..xxxxxEXAMPLExxxxx', 'description': 'Test User One'}, {'lifecycle_state': 'ACTIVE', 'inactive_status': None, 'name': 'test_user2', 'compartment_id': 'ocidv1:tenancy:oc1:phx:xxxxxEXAMPLExxxxx', 'defined_tags': {'department': {'division': 'engineering'}}, 'freeform_tags': {'user_type': 'admin'}, 'time_created': '2017-03-22T04:28:34.943000+00:00', 'id': 'ocid1.user.oc1..xxxxxEXAMPLExxxxx', 'description': 'Test User Two'}], 'id': 'ocid1.group.oc1..xxxxxEXAMPLExxxxx', 'name': 'test_ansible_group'}]
|
|
|
lifecycle_state
string
|
always |
Current state of the group
Sample:
ACTIVE
|
|
|
inactive_status
string
|
when group's lifecycle_state is INACTIVE |
The detailed status of INACTIVE life cycle state
|
|
|
description
string
|
always |
Description of the group
Sample:
Network Admin group
|
|
|
compartment_id
string
|
always |
Identifier of the tenancy containing the group
Sample:
ocid1.xzvf..oifds
|
|
|
time_created
datetime
|
always |
Date and time the group was created, in the format defined by RFC3339
Sample:
2016-08-25 21:10:29.600000
|
|
|
members
list
|
always |
A list of all members that are part of this group.
Sample:
[{'lifecycle_state': 'ACTIVE', 'inactive_status': None, 'name': 'test_user1', 'compartment_id': 'ocidv1:tenancy:oc1:phx:xxxxxEXAMPLExxxxx', 'id': 'ocid1.user.oc1..xxxxxEXAMPLExxxxx', 'time_created': '2017-09-25T09:20:10.768000+00:00', 'description': 'Test User One'}]
|
|
|
id
string
|
always |
Identifier of the group
Sample:
ocid1.group.oc1.axdf
|
|
|
name
string
|
always |
Unique name of the group
Sample:
network_admin
|
|
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¶
- Debayan Gupta(@debayan_gupta)
Hint
If you notice any issues in this documentation you can edit this document to improve it.