oracle.oci.oci_key_management_vault – Manage a Vault 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_key_management_vault.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create and update a Vault resource in Oracle Cloud Infrastructure

  • For state=present, creates a new vault. The type of vault you create determines key placement, pricing, and available options. Options include storage isolation, a dedicated service endpoint instead of a shared service endpoint for API calls, and either a dedicated hardware security module (HSM) or a multitenant HSM.

  • As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning 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_vault_actions module: cancel_vault_deletion, change_compartment, create_vault_replica, delete_vault_replica, schedule_vault_deletion.

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
  • 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 where you want to create this vault.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
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.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
display_name
string
A user-friendly name for the vault. It does not have to be unique, and it is changeable. Avoid entering confidential information.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
force_create
boolean
    Choices:
  • no ←
  • yes
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.
freeform_tags
dictionary
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"}`
This parameter is updatable.
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.
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.
state
string
    Choices:
  • present ←
The state of the Vault.
Use state=present to create or update a Vault.
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
vault_id
string
The OCID of the vault.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
vault_type
string
    Choices:
  • VIRTUAL_PRIVATE
  • DEFAULT
The type of vault to create. Each type of vault stores the key with different degrees of isolation and has different options and pricing.
Required for create using state=present.
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.

Examples

- name: Create vault
  oci_key_management_vault:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    vault_type: VIRTUAL_PRIVATE
    display_name: display_name_example

    # optional
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    freeform_tags: {'Department': 'Finance'}

- name: Update vault
  oci_key_management_vault:
    # required
    vault_id: "ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    display_name: display_name_example
    freeform_tags: {'Department': 'Finance'}

- name: Update vault using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_key_management_vault:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    freeform_tags: {'Department': 'Finance'}

Return Values

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

Key Returned Description
vault
complex
on success
Details of the Vault resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'crypto_endpoint': 'crypto_endpoint_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_primary': True, 'lifecycle_state': 'CREATING', 'management_endpoint': 'management_endpoint_example', '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_type': 'VIRTUAL_PRIVATE', 'wrappingkey_id': 'ocid1.wrappingkey.oc1..xxxxxxEXAMPLExxxxxx'}
 
compartment_id
string
on success
The OCID of the compartment that contains this vault.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
crypto_endpoint
string
on success
The service endpoint to perform cryptographic operations against. Cryptographic operations include Encrypt, Decrypt, and GenerateDataEncryptionKey operations.

Sample:
crypto_endpoint_example
 
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'}}
 
display_name
string
on success
A user-friendly name for the vault. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Sample:
display_name_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 vault.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_primary
boolean
on success
The value to assign to the is_primary property of this Vault.

Sample:
True
 
lifecycle_state
string
on success
The vault's current lifecycle state.
Example: `DELETED`

Sample:
CREATING
 
management_endpoint
string
on success
The service endpoint to perform management operations against. Management operations include "Create," "Update," "List," "Get," and "Delete" operations.

Sample:
management_endpoint_example
 
replica_details
complex
on success
The value to assign to the replica_details property of this Vault.

   
replication_id
string
on success
ReplicationId associated with a vault operation

Sample:
ocid1.replication.oc1..xxxxxxEXAMPLExxxxxx
 
time_created
string
on success
The date and time this vault 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 to indicate when to delete the vault, expressed in RFC 3339 timestamp format. Example: `2018-04-03T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
vault_type
string
on success
The type of vault. Each type of vault stores the key with different degrees of isolation and has different options and pricing.

Sample:
VIRTUAL_PRIVATE
 
wrappingkey_id
string
on success
The OCID of the vault's wrapping key.

Sample:
ocid1.wrappingkey.oc1..xxxxxxEXAMPLExxxxxx


Authors

  • Oracle (@oracle)