oracle.oci.oci_blockstorage_volume_group – Manage a VolumeGroup 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_group
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a VolumeGroup resource in Oracle Cloud Infrastructure
For state=present, creates a new volume group in the specified compartment. A volume group is a collection of volumes and may be created from a list of volumes, cloning an existing volume group, or by restoring a volume group backup. You may optionally specify a display name for the volume group, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information.
For more information, see Volume Groups.
This resource has the following action operations in the oracle.oci.oci_blockstorage_volume_group_actions module: change_compartment.
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. |
|
availability_domain
string
|
The availability domain of the volume group.
Required for create using state=present.
|
||
backup_policy_id
string
|
If provided, specifies the ID of the volume backup policy to assign to the newly created volume group. If omitted, no policy will be assigned.
|
||
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 group.
Required for create using state=present.
Required for update when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.Required for delete 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. 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
|
|
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.
|
||
preserve_volume_replica
boolean
|
|
Specifies whether to disable or preserve the individual volume replication when removing a volume from the replication enabled volume group. When set to `true`, the individual volume replica is preserved. The default value is `true`.
This parameter is updatable.
|
|
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. |
||
source_details
dictionary
|
Required for create using state=present.
|
||
type
string
/ required
|
|
||
volume_group_backup_id
string
|
The OCID of the volume group backup to restore from.
Required when type is 'volumeGroupBackupId'
|
||
volume_group_id
string
|
The OCID of the volume group to clone from.
Required when type is 'volumeGroupId'
|
||
volume_group_replica_id
string
|
The OCID of the volume group replica.
Required when type is 'volumeGroupReplicaId'
|
||
volume_ids
list
/ elements=string
|
OCIDs for the volumes in this volume group.
Required when type is 'volumeIds'
|
||
state
string
|
|
The state of the VolumeGroup.
Use state=present to create or update a VolumeGroup.
Use state=absent to delete a VolumeGroup.
|
|
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_group_id
string
|
The Oracle Cloud ID (OCID) that uniquely identifies the volume group.
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 |
||
volume_group_replicas
list
/ elements=dictionary
|
The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
This parameter is updatable.
|
||
availability_domain
string
/ required
|
The availability domain of the volume group 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 |
||
volume_ids
list
/ elements=string
|
OCIDs for the volumes in this volume group.
This parameter is updatable.
|
||
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 volume_group
oci_blockstorage_volume_group:
# required
availability_domain: Uocm:PHX-AD-1
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
source_details:
# required
volume_group_replica_id: "ocid1.volumegroupreplica.oc1..xxxxxxEXAMPLExxxxxx"
type: volumeGroupReplicaId
# optional
backup_policy_id: "ocid1.backuppolicy.oc1..xxxxxxEXAMPLExxxxxx"
defined_tags: {'Operations': {'CostCenter': 'US'}}
display_name: display_name_example
freeform_tags: {'Department': 'Finance'}
volume_group_replicas:
- # required
availability_domain: Uocm:PHX-AD-1
# optional
display_name: display_name_example
- name: Update volume_group
oci_blockstorage_volume_group:
# required
volume_group_id: "ocid1.volumegroup.oc1..xxxxxxEXAMPLExxxxxx"
# optional
defined_tags: {'Operations': {'CostCenter': 'US'}}
display_name: display_name_example
freeform_tags: {'Department': 'Finance'}
volume_ids: [ "volume_ids_example" ]
volume_group_replicas:
- # required
availability_domain: Uocm:PHX-AD-1
# optional
display_name: display_name_example
preserve_volume_replica: true
- name: Update volume_group using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_blockstorage_volume_group:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
# optional
defined_tags: {'Operations': {'CostCenter': 'US'}}
freeform_tags: {'Department': 'Finance'}
volume_ids: [ "volume_ids_example" ]
volume_group_replicas:
- # required
availability_domain: Uocm:PHX-AD-1
# optional
display_name: display_name_example
preserve_volume_replica: true
- name: Delete volume_group
oci_blockstorage_volume_group:
# required
volume_group_id: "ocid1.volumegroup.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete volume_group using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_blockstorage_volume_group:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
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_group
complex
|
on success |
Details of the VolumeGroup resource acted upon by the current operation
Sample:
{'availability_domain': 'Uocm:PHX-AD-1', '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_hydrated': True, 'lifecycle_state': 'PROVISIONING', 'size_in_gbs': 56, 'size_in_mbs': 56, 'source_details': {'type': 'volumeGroupBackupId', 'volume_group_backup_id': 'ocid1.volumegroupbackup.oc1..xxxxxxEXAMPLExxxxxx', 'volume_group_id': 'ocid1.volumegroup.oc1..xxxxxxEXAMPLExxxxxx', 'volume_group_replica_id': 'ocid1.volumegroupreplica.oc1..xxxxxxEXAMPLExxxxxx', 'volume_ids': []}, 'time_created': '2013-10-20T19:20:30+01:00', 'volume_group_replicas': [{'availability_domain': 'Uocm:PHX-AD-1', 'display_name': 'display_name_example', 'volume_group_replica_id': 'ocid1.volumegroupreplica.oc1..xxxxxxEXAMPLExxxxxx'}], 'volume_ids': []}
|
||
availability_domain
string
|
on success |
The availability domain of the volume group.
Sample:
Uocm:PHX-AD-1
|
||
compartment_id
string
|
on success |
The OCID of the compartment that contains the volume group.
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 for the volume group.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
is_hydrated
boolean
|
on success |
Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
Sample:
True
|
||
lifecycle_state
string
|
on success |
The current state of a volume group.
Sample:
PROVISIONING
|
||
size_in_gbs
integer
|
on success |
The aggregate size of the volume group in GBs.
Sample:
56
|
||
size_in_mbs
integer
|
on success |
The aggregate size of the volume group in MBs.
Sample:
56
|
||
source_details
complex
|
on success |
|
||
type
string
|
on success |
Sample:
volumeGroupBackupId
|
||
volume_group_backup_id
string
|
on success |
The OCID of the volume group backup to restore from.
Sample:
ocid1.volumegroupbackup.oc1..xxxxxxEXAMPLExxxxxx
|
||
volume_group_id
string
|
on success |
The OCID of the volume group to clone from.
Sample:
ocid1.volumegroup.oc1..xxxxxxEXAMPLExxxxxx
|
||
volume_group_replica_id
string
|
on success |
The OCID of the volume group replica.
Sample:
ocid1.volumegroupreplica.oc1..xxxxxxEXAMPLExxxxxx
|
||
volume_ids
list
/ elements=string
|
on success |
OCIDs for the volumes in this volume group.
|
||
time_created
string
|
on success |
The date and time the volume group was created. Format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
||
volume_group_replicas
complex
|
on success |
The list of volume group replicas of this volume group.
|
||
availability_domain
string
|
on success |
The availability domain of the boot volume replica replica.
Example: `Uocm:PHX-AD-1`
Sample:
Uocm:PHX-AD-1
|
||
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
|
||
volume_group_replica_id
string
|
on success |
The volume group replica's Oracle ID (OCID).
Sample:
ocid1.volumegroupreplica.oc1..xxxxxxEXAMPLExxxxxx
|
||
volume_ids
list
/ elements=string
|
on success |
OCIDs for the volumes in this volume group.
|
Authors¶
Oracle (@oracle)