oci_compartment – Manage compartments in OCI

New in version 2.5.

Synopsis

  • This module allows the user to create, delete & update a 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
-
The OCID of the compartment. Use compartment_id to update a compartment. compartment_id may also be set to the tenancy ocid to create a compartment under the root compartment of the tenancy. However it is recommended to use the parent_compartment_ocid for that purpose.

aliases: id
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.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
description
-
The description to be assigned to the compartment. Required when creating a compartment with state=present. description should be minimum 1 character and maximum 100 characters long. Does not have to be unique, and it's changeable.
freeform_tags
dictionary
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 https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
name
-
Name of the compartment. The name must be unique across all compartments in the parent compartment. Required when creating a compartment with state=present.
parent_compartment_id
-
The OCID of the parent compartment containing the compartment. Use parent_compartment_id to create a compartment under a root or a non-root compartment. Required to create a compartment under a non-root compartment with state=present.
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.
state
-
    Choices:
  • present ←
  • absent
Create or update a compartment with state=present. Use state=absent to delete a compartment.
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
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Default:
1200
Time, in seconds, to wait when wait=yes.
wait_until
string
The lifecycle state to wait for the resource to transition into when wait=yes. By default, when wait=yes, we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.

Examples

- name: Create a compartment under root compartment using parent_compartment_id option
  oci_compartment:
    parent_compartment_id: 'ocid1.tenancy.oc1..xxxxxEXAMPLExxxxx'
    name: Project-A
    description: Compartment for Project-A

- name: Create a compartment under root compartment using compartment_id option. Though this is supported, it is
        recommended to use the parent_compartment_id as shown above to create a compartment under the root compartment
        of the tenancy.
  oci_compartment:
    compartment_id: 'ocid1.tenancy.oc1..xxxxxEXAMPLExxxxx'
    name: Project-A
    description: Compartment for Project-A

- name: Create a compartment under a non-root compartment
  oci_compartment:
    parent_compartment_id: 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx'
    name: Project-B
    description: Compartment for Project-B

- name: Update name and description of a non-root compartment
  oci_compartment:
    compartment_id: 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx'
    name: Project-Ansible
    description: Compartment for Project-Ansible

- name: Update description and tags of root compartment
  oci_compartment:
    compartment_id: 'ocid1.tenancy.oc1..xxxxxEXAMPLExxxxx'
    freeform_tags:
      stage: test

- name: Delete compartment
  oci_compartment:
    compartment_id: 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx'
    state: absent

Return Values

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

Key Returned Description
compartment
dictionary
On successful operation
Information about the compartment

Sample:
{'lifecycle_state': 'ACTIVE', 'inactive_status': None, 'description': 'Compartment for Project-Ansible', 'compartment_id': 'ocid1.tenancy.oc1..xxxxxEXAMPLExxxxx', 'is_accessible': None, 'defined_tags': {}, 'freeform_tags': {}, 'time_created': '2017-02-01T03:20:22.160000+00:00', 'id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'name': 'Project-Ansible'}
work_request
dictionary
When a delete compartment request is raised
Information about the work request

Sample:
{'status': 'ACCEPTED', 'time_finished': None, 'errors': None, 'logs': None, 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'operation_type': 'DELETE_COMPARTMENT', 'percent_complete': 0.0, 'time_accepted': '2018-11-30T12:08:28.168000+00:00', 'id': 'ocid1.identityworkrequest.oc1..xxxxxEXAMPLExxxxx', 'resources': None, 'time_started': None}


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.