oci_volume_backup_policy_assignment – Manage volume backup policy assignments in OCI Block Volume service

New in version 2.5.

Synopsis

  • This module allows the user to perform create & delete operations on volume backup policy assignments in OCI Block Volume service.

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_OCID 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).
asset_id
-
The OCID of the asset (e.g. a volume) to which to assign the policy. Required to create a volume backup policy assignment with state=present.
auth_type
string
    Choices:
  • api_key ←
  • instance_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.
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.
policy_assignment_id
-
OCID of the volume backup policy assignment. Required to delete a volume backup policy assignment.

aliases: id
policy_id
-
The OCID of the volume backup policy to assign to an asset. Required to create a volume backup policy assignment with state=present.
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
-
    Choices:
  • present ←
  • absent
Use state=present to create a volume backup policy assignment. Use state=absent to delete a volume backup policy assignment.
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: Create a volume backup policy assignment
  oci_volume_backup_policy_assignment:
    asset_id: ocid1.volume.oc1.iad.xxxxxEXAMPLExxxxx
    policy_id: ocid1.volumebackuppolicy.oc1..xxxxxEXAMPLExxxxx

- name: Delete a volume backup policy assignment
  oci_volume_backup_policy_assignment:
    id: ocid1.volumebackuppolicyassign.oc1.iad.xxxxxEXAMPLExxxxx
    state: absent

Return Values

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

Key Returned Description
volume_backup_policy_assignment
complex
on successful operation
Information about the volume backup policy assignment

Sample:
{'asset_id': 'ocid1.volume.oc1.iad.xxxxxEXAMPLExxxxx', 'id': 'ocid1.volumebackuppolicyassign.oc1.iad.xxxxxEXAMPLExxxxx', 'time_created': '2017-12-22T15:40:53.219000+00:00', 'policy_id': 'ocid1.volumebackuppolicy.oc1..xxxxxEXAMPLExxxxx'}
  asset_id
string
always
The OCID of the asset (e.g. a volume) to which the policy has been assigned.

Sample:
ocid1.volume.oc1.iad.xxxxxEXAMPLExxxxx
  id
string
always
The OCID of the volume backup policy assignment.

Sample:
ocid1.volumebackuppolicyassign.oc1.iad.xxxxxEXAMPLExxxxx
  policy_id
string
always
The OCID of the volume backup policy that has been assigned to an asset.

Sample:
ocid1.volumebackuppolicy.oc1..xxxxxEXAMPLExxxxx
  time_created
string
always
The date and time the volume backup policy assignment was created. Format defined by RFC3339.

Sample:
2017-12-22 15:40:53.219000


Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]
  • This module is maintained by the Ansible Community. [community]

Authors

  • Rohit Chaware (@rohitChaware)

Hint

If you notice any issues in this documentation you can edit this document to improve it.