oracle.oci.oci_key_management_key_version – Manage a KeyVersion resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.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_key_management_key_version
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create a KeyVersion resource in Oracle Cloud Infrastructure
For state=present, generates a new KeyVersion resource that provides new cryptographic material for a master encryption key. The key must be in an ENABLED state to be rotated.
As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.
This resource has the following action operations in the oracle.oci.oci_key_management_key_version_actions module: cancel_key_version_deletion, schedule_key_version_deletion.
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 |
---|---|---|
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 . |
|
force_create
boolean
|
|
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
|
key_by
list
/ elements=string
|
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
|
|
key_id
string
/ required
|
The OCID of the key.
|
|
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. |
|
service_endpoint
string
/ required
|
The endpoint of the service to call using this client. For example 'https://kms.{region}.{secondLevelDomain}'.
|
|
state
string
|
|
The state of the KeyVersion.
Use state=present to create a KeyVersion.
|
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
|
|
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: Create key_version
oci_key_management_key_version:
# required
key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
service_endpoint: "https://xxx.kms.{region}.oraclecloud.com"
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
key_version
complex
|
on success |
Details of the KeyVersion resource acted upon by the current operation
Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_primary': True, 'key_id': 'ocid1.key.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'CREATING', 'origin': 'INTERNAL', 'public_key': 'ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz...', 'replica_details': {'replication_id': 'ocid1.replication.oc1..xxxxxxEXAMPLExxxxxx'}, 'time_created': '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 that contains this key version.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
id
string
|
on success |
The OCID of the key version.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
is_primary
boolean
|
on success |
Sample:
True
|
||
key_id
string
|
on success |
The OCID of the key associated with this key version.
Sample:
ocid1.key.oc1..xxxxxxEXAMPLExxxxxx
|
||
lifecycle_state
string
|
on success |
The key version's current lifecycle state.
Example: `ENABLED`
Sample:
CREATING
|
||
origin
string
|
on success |
The source of the key material. When this value is `INTERNAL`, Key Management created the key material. When this value is `EXTERNAL`, the key material was imported from an external source.
Sample:
INTERNAL
|
||
public_key
string
|
on success |
The public key in PEM format. (This value pertains only to RSA and ECDSA keys.)
Sample:
ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz...
|
||
replica_details
complex
|
on success |
|
||
replication_id
string
|
on success |
ReplicationId associated with a key version operation
Sample:
ocid1.replication.oc1..xxxxxxEXAMPLExxxxxx
|
||
time_created
string
|
on success |
The date and time this key version was created, expressed in RFC 3339 timestamp format.
Example: "2018-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 key version, 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 that contains this key version.
Sample:
ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx
|
Authors¶
Oracle (@oracle)