Try SpotterFetches details about one or multiple VolumeGroup resources in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0Fetches details about one or multiple VolumeGroup resources in Oracle Cloud Infrastructure
Lists the volume groups in the specified compartment and availability domain. For more information, see L(Volume Groups,https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/volumegroups.htm).
If I(volume_group_id) is specified, the details of a single VolumeGroup will be returned.
- name: Get a specific volume_group
oci_blockstorage_volume_group_facts:
# required
volume_group_id: "ocid1.volumegroup.oc1..xxxxxxEXAMPLExxxxxx"
- name: List volume_groups
oci_blockstorage_volume_group_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
availability_domain: Uocm:PHX-AD-1
display_name: display_name_example
sort_by: TIMECREATED
sort_order: ASC
lifecycle_state: PROVISIONING
region:
description:
- 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 C(config_file_location)).
Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm)
for more information on OCI regions.
type: str
sort_by:
choices:
- TIMECREATED
- DISPLAYNAME
description:
- The field to sort by. You can provide one sort order (`sortOrder`). Default order
for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
sort order is case sensitive.
- '**Note:** In general, some "List" operations (for example, `ListInstances`) let
you optionally filter by availability domain if the scope of the resource type is
within a single availability domain. If you call one of these "List" operations
without specifying an availability domain, the resources are grouped by availability
domain, then sorted.'
type: str
tenancy:
description:
- 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 C(config_file_location)). To get the tenancy OCID, please
refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm)
type: str
api_user:
description:
- 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 C(config_file_location)).
To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
auth_type:
choices:
- api_key
- instance_principal
- instance_obo_user
- resource_principal
- security_token
default: api_key
description:
- The type of authentication to use for making API requests. By default C(auth_type="api_key")
based authentication is performed and the API key (see I(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 C(auth_type="instance_principal")
to use instance principal based authentication when running ansible playbooks within
an OCI compute instance.
type: str
sort_order:
choices:
- ASC
- DESC
description:
- The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME
sort order is case sensitive.
type: str
cert_bundle:
description:
- 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.
type: str
auth_purpose:
choices:
- service_principal
description:
- The auth purpose which can be used in conjunction with 'auth_type=instance_principal'.
The default auth_purpose for instance_principal is None.
type: str
display_name:
aliases:
- name
description:
- A filter to return only resources that match the given display name exactly.
type: str
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the compartment.
- Required to list multiple volume_groups.
type: str
lifecycle_state:
choices:
- PROVISIONING
- AVAILABLE
- TERMINATING
- TERMINATED
- FAULTY
- UPDATE_PENDING
description:
- A filter to only return resources that match the given lifecycle state. The state
value is case-insensitive.
type: str
volume_group_id:
aliases:
- id
description:
- The Oracle Cloud ID (OCID) that uniquely identifies the volume group.
- Required to get a specific volume_group.
type: str
api_user_key_file:
description:
- 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 C(config_file_location)).
If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option
must also be provided.
type: str
availability_domain:
description:
- The name of the availability domain.
- 'Example: `Uocm:PHX-AD-1`'
type: str
config_profile_name:
description:
- The profile to load from the config file referenced by C(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 C(config_file_location).
type: str
api_user_fingerprint:
description:
- 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 C(config_file_location)). To
get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
config_file_location:
description:
- 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.
type: str
api_user_key_pass_phrase:
description:
- Passphrase used by the key referenced in C(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 C(config_file_location)).
type: str
realm_specific_endpoint_template_enabled:
description:
- 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.
type: bool
volume_groups:
contains:
availability_domain:
description:
- The availability domain of the volume group.
returned: on success
sample: Uocm:PHX-AD-1
type: str
compartment_id:
description:
- The OCID of the compartment that contains the volume group.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Operations": {"CostCenter": "42"}}`'
returned: on success
sample:
Operations:
CostCenter: US
type: dict
display_name:
description:
- A user-friendly name. Does not have to be unique, and it's changeable. Avoid
entering confidential information.
returned: on success
sample: display_name_example
type: str
freeform_tags:
description:
- 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 L(Resource
Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
returned: on success
sample:
Department: Finance
type: dict
id:
description:
- The OCID for the volume group.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
is_hydrated:
description:
- Specifies whether the newly created cloned volume group's data has finished
copying from the source volume group or backup.
returned: on success
sample: true
type: bool
lifecycle_state:
description:
- The current state of a volume group.
returned: on success
sample: PROVISIONING
type: str
size_in_gbs:
description:
- The aggregate size of the volume group in GBs.
returned: on success
sample: 56
type: int
size_in_mbs:
description:
- The aggregate size of the volume group in MBs.
returned: on success
sample: 56
type: int
source_details:
contains:
type:
description:
- ''
returned: on success
sample: volumeGroupBackupId
type: str
volume_group_backup_id:
description:
- The OCID of the volume group backup to restore from.
returned: on success
sample: ocid1.volumegroupbackup.oc1..xxxxxxEXAMPLExxxxxx
type: str
volume_group_id:
description:
- The OCID of the volume group to clone from.
returned: on success
sample: ocid1.volumegroup.oc1..xxxxxxEXAMPLExxxxxx
type: str
volume_group_replica_id:
description:
- The OCID of the volume group replica.
returned: on success
sample: ocid1.volumegroupreplica.oc1..xxxxxxEXAMPLExxxxxx
type: str
volume_ids:
description:
- OCIDs for the volumes in this volume group.
returned: on success
sample: []
type: list
description:
- ''
returned: on success
type: complex
time_created:
description:
- The date and time the volume group was created. Format defined by L(RFC3339,https://tools.ietf.org/html/rfc3339).
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
volume_group_replicas:
contains:
availability_domain:
description:
- The availability domain of the boot volume replica replica.
- 'Example: `Uocm:PHX-AD-1`'
returned: on success
sample: Uocm:PHX-AD-1
type: str
display_name:
description:
- A user-friendly name. Does not have to be unique, and it's changeable.
Avoid entering confidential information.
returned: on success
sample: display_name_example
type: str
volume_group_replica_id:
description:
- The volume group replica's Oracle ID (OCID).
returned: on success
sample: ocid1.volumegroupreplica.oc1..xxxxxxEXAMPLExxxxxx
type: str
description:
- The list of volume group replicas of this volume group.
returned: on success
type: complex
volume_ids:
description:
- OCIDs for the volumes in this volume group.
returned: on success
sample: []
type: list
description:
- List of VolumeGroup resources
returned: on success
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: []
type: complex