oci_compartment_facts – Retrieve details of a compartment or all the subcompartments in the specified compartment in OCI

New in version 2.5.

Synopsis

  • This module allows the user to retrieve information of a specific compartment or all the subcompartments in a specified compartment in OCI.

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_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
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
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
- / required
OCID of a compartment. Use OCID of a root compartment with depth to get details of all the subcompartments which are upto depth deep in the root compartment. Use OCID of a root compartment with fetch_subcompartments=False to retrieve information of only the root compartment. Use OCID of a non-root compartment to get details of only the compartment. Use OCID of a non-root compartment with fetch_subcompartments=True and depth to retrieve information of all the subcompartments which are upto depth deep in the non-root compartment.
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.
depth
-
Default:
1
Specify the hierarchy level upto which subcompartments under compartment_id should be retrieved. Use this option with fetch_subcompartments=True to fetch details of all the subcompartments which are upto depth deep under compartment_id.
fetch_subcompartments
boolean
    Choices:
  • no
  • yes
Whether to fetch information of subcompartments under compartment_id. When compartment_id is set to OCID of a root compartment, fetch_subcompartments defaults to True. When compartment_id is set to OCID of a non-root compartment, fetch_subcompartments defaults to False.
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: Get details of all the first-level child compartments of a root compartment
  oci_compartment_facts:
    compartment_id: 'ocid1.tenancy.oc1..xxxxxEXAMPLExxxxx'

- name: Get details of a root compartment
  oci_compartment_facts:
    compartment_id: 'ocid1.tenancy.oc1..xxxxxEXAMPLExxxxx'
    fetch_subcompartments: False

- name: Get details of all the compartments in a tenancy
  oci_compartment_facts:
    compartment_id: 'ocid1.tenancy.oc1..xxxxxEXAMPLExxxxx'
    depth: 100

- name: Get details of all first-level child compartments of a non-root compartment
  oci_compartment_facts:
    compartment_id: 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx'
    fetch_subcompartments: True

- name: Get details of a non-root compartment
  oci_compartment_facts:
    compartment_id: 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx'

- name: Get details of all the subcompartments under a non-root compartment
  oci_compartment_facts:
    compartment_id: 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx'
    fetch_subcompartments: True
    depth: 100

- name: Filter subcompartments by name under a root compartment
  oci_compartment_facts:
    compartment_id: 'ocid1.tenancy.oc1..xxxxxEXAMPLExxxxx'
    name: test_compartment

- name: Filter subcompartments by name under a non-root compartment
  oci_compartment_facts:
    compartment_id: 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx'
    fetch_subcompartments: True
    name: test_compartment

Return Values

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

Key Returned Description
compartments
complex
always
List of compartment details

Sample:
[{'lifecycle_state': 'ACTIVE', 'inactive_status': None, 'name': 'Project-Ansible', 'compartment_id': 'ocid1.tenancy.oc1..xxxxxEXAMPLExxxxx', 'id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'time_created': '2017-02-01T03:20:22.160000+00:00', 'description': 'Compartment for Project-Ansible'}]
  compartment_id
string
always
The OCID of the tenancy containing the compartment

Sample:
ocid1.tenancy.oc1..xxxxxEXAMPLExxxxx
  description
string
always
The description assigned to the compartment

Sample:
Compartment for Project-A
  id
string
always
The OCID of the compartment

Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
  inactive_status
string
always
The detailed status of INACTIVE lifecycleState

  lifecycle_state
string
always
The compartment's current state

Sample:
ACTIVE
  name
string
always
The name assigned to the compartment

Sample:
Project-A
  time_created
string
always
Date and time the compartment was created, in the format defined by RFC3339

Sample:
2017-02-01T03:20:22.160000+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

  • Rohit Chaware (@rohitChaware)

Hint

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