oracle.oci.oci_vault_secret_actions – Perform actions on a Secret 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_vault_secret_actions.

New in version 2.9.0: of oracle.oci

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis ¶

Perform actions on a Secret resource in Oracle Cloud Infrastructure
For action=cancel_secret_deletion, cancels the pending deletion of the specified secret. Canceling a scheduled deletion restores the secret’s lifecycle state to what it was before you scheduled the secret for deletion.
For action=change_compartment, moves a secret into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment. When provided, if-match is checked against the ETag values of the secret.
For action=schedule_secret_deletion, schedules the deletion of the specified secret. This sets the lifecycle state of the secret to PENDING_DELETION and then deletes it after the specified retention period ends.

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: cancel_secret_deletion change_compartment schedule_secret_deletion	The action to perform on the Secret.
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		The OCID of the compartment into which the resource should be moved. Required for action=change_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`.
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.
secret_id string / required		The OCID of the secret. aliases: id
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
time_of_deletion string		An optional property indicating when to delete the secret version, expressed in RFC 3339 timestamp format. Applicable only for action=schedule_secret_deletion.

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 cancel_secret_deletion on secret
  oci_vault_secret_actions:
    # required
    secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
    action: cancel_secret_deletion

- name: Perform action change_compartment on secret
  oci_vault_secret_actions:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
    action: change_compartment

- name: Perform action schedule_secret_deletion on secret
  oci_vault_secret_actions:
    # required
    secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
    action: schedule_secret_deletion

    # optional
    time_of_deletion: time_of_deletion_example

Return Values ¶

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

Key			Returned	Description
secret complex			on success	Details of the Secret resource acted upon by the current operation Sample: {'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'current_version_number': 56, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'key_id': 'ocid1.key.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'metadata': {}, 'secret_name': 'secret_name_example', 'secret_rules': [{'is_enforced_on_deleted_secret_versions': True, 'is_secret_content_retrieval_blocked_on_expiry': True, 'rule_type': 'SECRET_EXPIRY_RULE', 'secret_version_expiry_interval': 'secret_version_expiry_interval_example', 'time_of_absolute_expiry': '2013-10-20T19:20:30+01:00'}], 'time_created': '2013-10-20T19:20:30+01:00', 'time_of_current_version_expiry': '2013-10-20T19:20:30+01:00', 'time_of_deletion': '2013-10-20T19:20:30+01:00', 'vault_id': 'ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx'}
	compartment_id string		on success	The OCID of the compartment where you want to create the secret. Sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
	current_version_number integer		on success	The version number of the secret version that's currently in use. Sample: 56
	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	A brief description of the secret. Avoid entering confidential information. 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 secret. Sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
	key_id string		on success	The OCID of the master encryption key that is used to encrypt the secret. You must specify a symmetric key to encrypt the secret during import to the vault. You cannot encrypt secrets with asymmetric keys. Furthermore, the key must exist in the vault that you specify. Sample: ocid1.key.oc1..xxxxxxEXAMPLExxxxxx
	lifecycle_details string		on success	Additional information about the current lifecycle state of the secret. Sample: lifecycle_details_example
	lifecycle_state string		on success	The current lifecycle state of the secret. Sample: CREATING
	metadata dictionary		on success	Additional metadata that you can use to provide context about how to use the secret or during rotation or other administrative tasks. For example, for a secret that you use to connect to a database, the additional metadata might specify the connection endpoint and the connection string. Provide additional metadata as key-value pairs.
	secret_name string		on success	The user-friendly name of the secret. Avoid entering confidential information. Sample: secret_name_example
	secret_rules complex		on success	A list of rules that control how the secret is used and managed.
		is_enforced_on_deleted_secret_versions boolean	on success	A property indicating whether the rule is applied even if the secret version with the content you are trying to reuse was deleted. Sample: True
		is_secret_content_retrieval_blocked_on_expiry boolean	on success	A property indicating whether to block retrieval of the secret content, on expiry. The default is false. If the secret has already expired and you would like to retrieve the secret contents, you need to edit the secret rule to disable this property, to allow reading the secret content. Sample: True
		rule_type string	on success	The type of rule, which either controls when the secret contents expire or whether they can be reused. Sample: SECRET_EXPIRY_RULE
		secret_version_expiry_interval string	on success	A property indicating how long the secret contents will be considered valid, expressed in ISO 8601 format. The secret needs to be updated when the secret content expires. The timer resets after you update the secret contents. The minimum value is 1 day and the maximum value is 90 days for this property. Currently, only intervals expressed in days are supported. For example, pass `P3D` to have the secret version expire every 3 days. Sample: secret_version_expiry_interval_example
		time_of_absolute_expiry string	on success	An optional property indicating the absolute time when this secret will expire, expressed in RFC 3339 timestamp format. The minimum number of days from current time is 1 day and the maximum number of days from current time is 365 days. Example: `2019-04-03T21:10:29.600Z` Sample: 2013-10-20T19:20:30+01:00
	time_created string		on success	A property indicating when the secret was created, expressed in RFC 3339 timestamp format. Example: `2019-04-03T21:10:29.600Z` Sample: 2013-10-20T19:20:30+01:00
	time_of_current_version_expiry string		on success	An optional property indicating when the current secret version will expire, expressed in RFC 3339 timestamp format. Example: `2019-04-03T21:10:29.600Z` Sample: 2013-10-20T19:20:30+01:00
	time_of_deletion string		on success	An optional property indicating when to delete the secret, expressed in RFC 3339 timestamp format. Example: `2019-04-03T21:10:29.600Z` Sample: 2013-10-20T19:20:30+01:00
	vault_id string		on success	The OCID of the vault where the secret exists. Sample: ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx

Authors¶

Oracle (@oracle)

oracle.oci.oci_vault_secret_actions – Perform actions on a Secret resource in Oracle Cloud Infrastructure¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶