oracle.oci.oci_blockstorage_volume – Manage a Volume 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_blockstorage_volume.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, creates a new volume in the specified compartment. Volumes can be created in sizes ranging from 50 GB (51200 MB) to 32 TB (33554432 MB), in 1 GB (1024 MB) increments. By default, volumes are 1 TB (1048576 MB). For general information about block volumes, see Overview of Block Volume Service.

  • A volume and instance can be in separate compartments but must be in the same availability domain. For information about access control and compartments, see Overview of the IAM Service. For information about availability domains, see Regions and Availability Domains. To get a list of availability domains, use the ListAvailabilityDomains operation in the Identity and Access Management Service API.

  • You may optionally specify a display name for the volume, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information.

  • This resource has the following action operations in the oracle.oci.oci_blockstorage_volume_actions module: change_compartment.

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.
autotune_policies
list / elements=dictionary
The list of autotune policies to be enabled for this volume.
This parameter is updatable.
autotune_type
string / required
    Choices:
  • DETACHED_VOLUME
  • PERFORMANCE_BASED
This specifies the type of autotunes supported by OCI.
max_vpus_per_gb
integer
This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring.
Required when autotune_type is 'PERFORMANCE_BASED'
availability_domain
string
The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume.
Example: `Uocm:PHX-AD-1`
backup_policy_id
string
If provided, specifies the ID of the volume backup policy to assign to the newly created volume. If omitted, no policy will be assigned.
block_volume_replicas
list / elements=dictionary
The list of block volume replicas to be enabled for this volume in the specified destination availability domains.
This parameter is updatable.
availability_domain
string / required
The availability domain of the block volume replica.
Example: `Uocm:PHX-AD-1`
display_name
string
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

aliases: name
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 that contains the volume.
Required for create using state=present.
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. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Required for create, update, delete 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.
is_auto_tune_enabled
boolean
    Choices:
  • no
  • yes
Specifies whether the auto-tune performance is enabled for this volume. This field is deprecated. Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune.
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.
kms_key_id
string
The OCID of the Vault service key to assign as the master encryption key for the volume.
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.
size_in_gbs
integer
The size of the volume in GBs.
This parameter is updatable.
size_in_mbs
integer
The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Use sizeInGBs instead.
source_details
dictionary
id
string / required
The OCID of the block volume replica.
type
string / required
    Choices:
  • blockVolumeReplica
  • volume
  • volumeBackup
state
string
    Choices:
  • present ←
  • absent
The state of the Volume.
Use state=present to create or update a Volume.
Use state=absent to delete a Volume.
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
volume_backup_id
string
The OCID of the volume backup from which the data should be restored on the newly created volume. This field is deprecated. Use the sourceDetails field instead to specify the backup for the volume.
volume_id
string
The OCID of the volume.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
vpus_per_gb
integer
The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
Allowed values:
* `0`: Represents Lower Cost option.
* `10`: Represents Balanced option.
* `20`: Represents Higher Performance option.
* `30`-`120`: Represents the Ultra High Performance option.
For performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB.
This parameter is updatable.
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 volume
  oci_blockstorage_volume:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    availability_domain: Uocm:PHX-AD-1
    backup_policy_id: "ocid1.backuppolicy.oc1..xxxxxxEXAMPLExxxxxx"
    kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
    size_in_mbs: 56
    source_details:
      # required
      type: blockVolumeReplica
      id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
    volume_backup_id: "ocid1.volumebackup.oc1..xxxxxxEXAMPLExxxxxx"
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    display_name: display_name_example
    freeform_tags: {'Department': 'Finance'}
    vpus_per_gb: 56
    size_in_gbs: 56
    is_auto_tune_enabled: true
    block_volume_replicas:
    - # required
      availability_domain: Uocm:PHX-AD-1

      # optional
      display_name: display_name_example
    autotune_policies:
    - # required
      autotune_type: DETACHED_VOLUME

- name: Update volume
  oci_blockstorage_volume:
    # required
    volume_id: "ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    display_name: display_name_example
    freeform_tags: {'Department': 'Finance'}
    vpus_per_gb: 56
    size_in_gbs: 56
    is_auto_tune_enabled: true
    block_volume_replicas:
    - # required
      availability_domain: Uocm:PHX-AD-1

      # optional
      display_name: display_name_example
    autotune_policies:
    - # required
      autotune_type: DETACHED_VOLUME

- name: Update volume using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_blockstorage_volume:
    # required
    display_name: display_name_example

    # optional
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    freeform_tags: {'Department': 'Finance'}
    vpus_per_gb: 56
    size_in_gbs: 56
    is_auto_tune_enabled: true
    block_volume_replicas:
    - # required
      availability_domain: Uocm:PHX-AD-1

      # optional
      display_name: display_name_example
    autotune_policies:
    - # required
      autotune_type: DETACHED_VOLUME

- name: Delete volume
  oci_blockstorage_volume:
    # required
    volume_id: "ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete volume using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_blockstorage_volume:
    # required
    display_name: display_name_example
    state: absent

Return Values

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

Key Returned Description
volume
complex
on success
Details of the Volume resource acted upon by the current operation

Sample:
{'auto_tuned_vpus_per_gb': 56, 'autotune_policies': [{'autotune_type': 'DETACHED_VOLUME', 'max_vpus_per_gb': 56}], 'availability_domain': 'Uocm:PHX-AD-1', 'block_volume_replicas': [{'availability_domain': 'Uocm:PHX-AD-1', 'block_volume_replica_id': 'ocid1.blockvolumereplica.oc1..xxxxxxEXAMPLExxxxxx', 'display_name': 'display_name_example'}], 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_auto_tune_enabled': True, 'is_hydrated': True, 'kms_key_id': 'ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'PROVISIONING', 'size_in_gbs': 56, 'size_in_mbs': 56, 'source_details': {'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'type': 'blockVolumeReplica'}, 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'volume_group_id': 'ocid1.volumegroup.oc1..xxxxxxEXAMPLExxxxxx', 'vpus_per_gb': 56}
 
auto_tuned_vpus_per_gb
integer
on success
The number of Volume Performance Units per GB that this volume is effectively tuned to.

Sample:
56
 
autotune_policies
complex
on success
The list of autotune policies enabled for this volume.
   
autotune_type
string
on success
This specifies the type of autotunes supported by OCI.

Sample:
DETACHED_VOLUME
   
max_vpus_per_gb
integer
on success
This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring.

Sample:
56
 
availability_domain
string
on success
The availability domain of the volume.
Example: `Uocm:PHX-AD-1`

Sample:
Uocm:PHX-AD-1
 
block_volume_replicas
complex
on success
The list of block volume replicas of this volume.
   
availability_domain
string
on success
The availability domain of the block volume replica.
Example: `Uocm:PHX-AD-1`

Sample:
Uocm:PHX-AD-1
   
block_volume_replica_id
string
on success
The block volume replica's Oracle ID (OCID).

Sample:
ocid1.blockvolumereplica.oc1..xxxxxxEXAMPLExxxxxx
   
display_name
string
on success
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Sample:
display_name_example
 
compartment_id
string
on success
The OCID of the compartment that contains the volume.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
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. Does not have to be unique, and it's 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 volume.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_auto_tune_enabled
boolean
on success
Specifies whether the auto-tune performance is enabled for this volume. This field is deprecated. Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune.

Sample:
True
 
is_hydrated
boolean
on success
Specifies whether the cloned volume's data has finished copying from the source volume or backup.

Sample:
True
 
kms_key_id
string
on success
The OCID of the Vault service key which is the master encryption key for the volume.

Sample:
ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The current state of a volume.

Sample:
PROVISIONING
 
size_in_gbs
integer
on success
The size of the volume in GBs.

Sample:
56
 
size_in_mbs
integer
on success
The size of the volume in MBs. This field is deprecated. Use sizeInGBs instead.

Sample:
56
 
source_details
complex
on success

   
id
string
on success
The OCID of the block volume replica.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
   
type
string
on success

Sample:
blockVolumeReplica
 
system_tags
dictionary
on success
System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
 
time_created
string
on success
The date and time the volume was created. Format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
volume_group_id
string
on success
The OCID of the source volume group.

Sample:
ocid1.volumegroup.oc1..xxxxxxEXAMPLExxxxxx
 
vpus_per_gb
integer
on success
The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
Allowed values:
* `0`: Represents Lower Cost option.
* `10`: Represents Balanced option.
* `20`: Represents Higher Performance option.
* `30`-`120`: Represents the Ultra High Performance option.
For performance autotune enabled volumes, It would be the Default(Minimum) VPUs/GB.

Sample:
56


Authors

  • Oracle (@oracle)