oci_compartment_facts - Retrieve details of a compartment or all the compartments in a tenancy in OCI¶
New in version 2.5.
Synopsis¶
- This module allows the user to retrieve details of a specific compartment in a tenancy or all the compartments in a tenancy in OCI.
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. |
compartment_id
required |
OCID of a compartment. Use OCID of a tenancy to get details of all the compartments in the tenancy. Use OCID of a compartment in a tenancy to get details of the compartment.
|
|
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 . |
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¶
- name: Get details of all the compartments in a tenancy by specifying OCID of the tenancy
oci_compartment_facts:
compartment_id: 'ocidv1:tenancy:oc1:phx:xxxxxEXAMPLExxxxx:aaaaaaaamx5hilztihors5wfsn2akuyty4'
- name: Get details of a compartment by specifying OCID of the compartment
oci_compartment_facts:
compartment_id: 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx'
- name: Get details of a compartment in a tenancy using the compartment's name
oci_compartment_facts:
compartment_id: 'ocidv1:tenancy:oc1:phx:xxxxxEXAMPLExxxxx:aaaaaaaamx5hilztihors5wfsn2akuyty4'
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': 'ocidv1:tenancy:oc1:phx:xxxxxEXAMPLExxxxx:aaaabcaamx5hilzhdwvds5wfsn2akuyty4', 'id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'time_created': '2017-02-01T03:20:22.160000+00:00', 'description': 'Compartment for Project-Ansible'}]
|
|
lifecycle_state
string
|
always |
The compartment's current state
Sample:
ACTIVE
|
|
inactive_status
string
|
always |
The detailed status of INACTIVE lifecycleState
|
|
name
string
|
always |
The name assigned to the compartment
Sample:
Project-A
|
|
compartment_id
string
|
always |
The OCID of the tenancy containing the compartment
Sample:
ocidv1:tenancy:oc1:phx:xxxxxEXAMPLExxxxx:aaaabcaamx5hilzhdwvds5wfsn2akuyty4
|
|
id
string
|
always |
The OCID of the compartment
Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
|
|
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
|
|
description
string
|
always |
The description assigned to the compartment
Sample:
Compartment for Project-A
|
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.