oracle.oci.oci_identity_compartment_actions – Perform actions on a Compartment resource in Oracle Cloud Infrastructure¶

Note

This plugin is part of the oracle.oci collection (version 5.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_identity_compartment_actions.

New in version 2.9.0: of oracle.oci

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis ¶

Perform actions on a Compartment resource in Oracle Cloud Infrastructure
For action=bulk_delete_resources, deletes multiple resources in the compartment. All resources must be in the same compartment. You must have the appropriate permissions to delete the resources in the request. This API can only be invoked from the tenancy’s home region. This operation creates a WorkRequest. Use the GetWorkRequest API to monitor the status of the bulk action.
For action=bulk_move_resources, moves multiple resources from one compartment to another. All resources must be in the same compartment. This API can only be invoked from the tenancy’s home region. To move resources, you must have the appropriate permissions to move the resource in both the source and target compartments. This operation creates a WorkRequest. Use the GetWorkRequest API to monitor the status of the bulk action.
For action=move, move the compartment to a different parent compartment in the same tenancy. When you move a compartment, all its contents (subcompartments and resources) are moved with it. Note that the CompartmentId that you specify in the path is the compartment that you want to move. IMPORTANT: After you move a compartment to a new parent compartment, the access policies of the new parent take effect and the policies of the previous parent no longer apply. Ensure that you are aware of the implications for the compartment contents before you move it. For more information, see Moving a Compartment.
For action=recover, recover the compartment from DELETED state to ACTIVE state.

Requirements ¶

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

python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io

Parameters ¶

Parameter		Choices/Defaults	Comments
action string / required		Choices: bulk_delete_resources bulk_move_resources move recover	The action to perform on the Compartment.
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_ID 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_purpose string		Choices: service_principal	The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type string		Choices: api_key ← instance_principal instance_obo_user resource_principal security_token	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.
cert_bundle string			The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id string / required			The OCID of the compartment. 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`.
realm_specific_endpoint_template_enabled boolean		Choices: no yes	Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
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.
resources list / elements=dictionary			The resources to be deleted. Required for action=bulk_delete_resources, action=bulk_move_resources.
	entity_type string / required		The resource-type. To get the list of supported resource-types use ListBulkActionResourceTypes API.
	identifier string / required		The resource OCID.
	metadata dictionary		Additional information that helps to identity the resource for bulk action. The APIs to delete and move most resource types only require the resource identifier (ocid). But some resource-types require additional identifying information. This information is provided in the resource's public API document. It is also available through the ListBulkActionResourceTypes API. Example: The APIs to delete or move the `buckets` resource-type require `namespaceName` and `bucketName` to identify the resource, as shown in the APIs, DeleteBucket and UpdateBucket. To add a bucket for bulk actions, specify `namespaceName` and `bucketName` in the metadata property as shown in this example " { \"identifier\": \"<OCID_of_bucket>\" \"entityType\": \"bucket\", \"metadata\": { \"namespaceName\": \"sampleNamespace\", \"bucketName\": \"sampleBucket\" } }"
target_compartment_id string			The OCID of the destination compartment into which to move the resources. Required for action=bulk_move_resources, action=move.
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			Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

- name: Perform action bulk_delete_resources on compartment
  oci_identity_compartment_actions:
    # required
    resources:
    - # required
      identifier: identifier_example
      entity_type: entity_type_example

      # optional
      metadata: null
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    action: bulk_delete_resources

- name: Perform action bulk_move_resources on compartment
  oci_identity_compartment_actions:
    # required
    resources:
    - # required
      identifier: identifier_example
      entity_type: entity_type_example

      # optional
      metadata: null
    target_compartment_id: "ocid1.targetcompartment.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    action: bulk_move_resources

- name: Perform action move on compartment
  oci_identity_compartment_actions:
    # required
    target_compartment_id: "ocid1.targetcompartment.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    action: move

- name: Perform action recover on compartment
  oci_identity_compartment_actions:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    action: recover

Return Values ¶

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

Key		Returned	Description
compartment complex		on success	Details of the Compartment resource acted upon by the current operation Sample: {'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'inactive_status': 56, 'is_accessible': True, 'lifecycle_state': 'CREATING', 'name': 'name_example', 'time_created': '2013-10-20T19:20:30+01:00'}
	compartment_id string	on success	The OCID of the parent compartment containing the compartment. Sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
	defined_tags dictionary	on success	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}` Sample: {'Operations': {'CostCenter': 'US'}}
	description string	on success	The description you assign to the compartment. Does not have to be unique, and it's changeable. Sample: description_example
	freeform_tags dictionary	on success	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 Resource Tags. Example: `{"Department": "Finance"}` Sample: {'Department': 'Finance'}
	id string	on success	The OCID of the compartment. Sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
	inactive_status integer	on success	The detailed status of INACTIVE lifecycleState. Sample: 56
	is_accessible boolean	on success	Indicates whether or not the compartment is accessible for the user making the request. Returns true when the user has INSPECT permissions directly on a resource in the compartment or indirectly (permissions can be on a resource in a subcompartment). Sample: True
	lifecycle_state string	on success	The compartment's current state. After creating a compartment, make sure its `lifecycleState` changes from CREATING to ACTIVE before using it. Sample: CREATING
	name string	on success	The name you assign to the compartment during creation. The name must be unique across all compartments in the parent. Avoid entering confidential information. Sample: name_example
	time_created string	on success	Date and time the compartment was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` Sample: 2013-10-20T19:20:30+01:00

Authors¶

Oracle (@oracle)

oracle.oci.oci_identity_compartment_actions – Perform actions on a Compartment resource in Oracle Cloud Infrastructure¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶