oracle.oci.oci_vault_secret_version_facts – Fetches details about one or multiple SecretVersion resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.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_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple SecretVersion resources in Oracle Cloud Infrastructure

  • Lists all secret versions for the specified secret.

  • If secret_version_number is specified, the details of a single SecretVersion will be returned.

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_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
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.
name
string
Use name along with the other options to return only resources that match the given name exactly.
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
The version number of the secret.
Required to get a specific secret_version.
sort_by
string
    Choices:
  • VERSION_NUMBER
The field to sort by. Only one sort order may be provided. Time created is default ordered as descending. Display name is default ordered as ascending.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either ascending (`ASC`) or descending (`DESC`).
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

Examples

- name: Get a specific secret_version
  oci_vault_secret_version_facts:
    # required
    secret_version_number: 56
    secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"

- name: List secret_versions
  oci_vault_secret_version_facts:
    # required
    secret_id: "ocid1.secret.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    sort_by: VERSION_NUMBER
    sort_order: ASC

Return Values

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

Key Returned Description
secret_versions
complex
on success
List of SecretVersion resources

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', 'time_of_expiry': '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`
Returned for get operation

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
 
time_of_expiry
string
on success
An optional property indicating when the secret version will expire, expressed in RFC 3339 timestamp format. Example: `2019-04-03T21:10:29.600Z`
Returned for list operation

Sample:
2013-10-20T19:20:30+01:00
 
version_number
integer
on success
The version number of the secret.

Sample:
56


Authors

  • Oracle (@oracle)