oracle.oci.oci_vault_secret_version_actions – Perform actions on a SecretVersion resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.0.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_version_actions
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Perform actions on a SecretVersion resource in Oracle Cloud Infrastructure
For action=cancel_secret_version_deletion, cancels the scheduled deletion of a secret version.
For action=schedule_secret_version_deletion, schedules the deletion of the specified secret version. This deletes it after the specified retention period ends. You can only delete a secret version if the secret version rotation state is marked as DEPRECATED.
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
|
|
The action to perform on the SecretVersion.
|
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
|
|
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
|
|
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.
|
|
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
|
|
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.
|
|
secret_version_number
integer
/ required
|
The version number of the secret.
|
|
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. Example: `2019-04-03T21:10:29.600Z`
Applicable only for action=schedule_secret_version_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_version_deletion on secret_version
oci_vault_secret_version_actions:
# required
secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
secret_version_number: 56
action: cancel_secret_version_deletion
- name: Perform action schedule_secret_version_deletion on secret_version
oci_vault_secret_version_actions:
# required
secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"
secret_version_number: 56
action: schedule_secret_version_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_version
complex
|
on success |
Details of the SecretVersion resource acted upon by the current operation
Sample:
{'content_type': 'BASE64', 'name': 'name_example', 'secret_id': 'ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx', 'stages': [], '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', 'version_number': 56}
|
|
content_type
string
|
on success |
The content type of the secret version's secret contents.
Sample:
BASE64
|
|
name
string
|
on success |
The name of the secret version. A name is unique across versions of a secret.
Sample:
name_example
|
|
secret_id
string
|
on success |
The OCID of the secret.
Sample:
ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx
|
|
stages
list
/ elements=string
|
on success |
A list of possible rotation states for the secret version. A secret version marked `CURRENT` is currently in use. A secret version marked `PENDING` is staged and available for use, but has not been applied on the target system and, therefore, has not been rotated into current, active use. The secret most recently uploaded to a vault is always marked `LATEST`. (The first version of a secret is always marked as both `CURRENT` and `LATEST`.) A secret version marked `PREVIOUS` is the secret version that was most recently marked `CURRENT`, before the last secret version rotation. A secret version marked `DEPRECATED` is neither current, pending, nor the previous one in use. Only secret versions marked `DEPRECATED` can be scheduled for deletion.
|
|
time_created
string
|
on success |
A optional property indicating when the secret version 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 version, expressed in RFC 3339 timestamp format. Example: `2019-04-03T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
|
version_number
integer
|
on success |
The version number of the secret.
Sample:
56
|
Authors¶
Oracle (@oracle)