Skip to content
This repository has been archived by the owner on May 1, 2021. It is now read-only.

Latest commit

 

History

History
531 lines (481 loc) · 34.7 KB

oci_volume_group_facts_module.rst

File metadata and controls

531 lines (481 loc) · 34.7 KB
Raw
source:cloud/oracle/oci_volume_group_facts.py
orphan:

oci_volume_group_facts -- Retrieve facts of volume groups in OCI Block Volume service

.. versionadded:: 2.5

Synopsis

  • This module retrieves information of a specified volume group or all the volume groups in a specified 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_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).
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.
availability_domain
-
The name of the Availability Domain.
compartment_id
-
The OCID of the compartment. Required to get information of all the volume groups in a specified compartment.
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.
display_name
string
Use display_name along with the other options to return only resources that match the given display name exactly.
lifecycle_state
-
    Choices:
  • PROVISIONING
  • RESTORING
  • AVAILABLE
  • TERMINATING
  • TERMINATED
  • FAULTY
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. Allowed values are "PROVISIONING", "RESTORING", "AVAILABLE", "TERMINATING", "TERMINATED", "FAULTY".
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.
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
-
The OCID of the volume group. Required to get information of the specified volume group.

aliases: id

Notes

Examples

- name: Get information of all the volume groups for a specific availability domain & compartment_id
  oci_volume_group_facts:
    availability_domain: BnQb:PHX-AD-1
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx

- name: Get information of a volume group
  oci_volume_group_facts:
    volume_group_id: ocid1.volumegroup.oc1.phx.xxxxxEXAMPLExxxxx

Return Values

Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:

Key Returned Description
volume_groups
complex
 On success
List of volume group information

Sample:
[{'lifecycle_state': 'AVAILABLE', 'availability_domain': 'IwGV:US-ASHBURN-AD-2', 'display_name': 'ansible_test_volume_group', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'size_in_mbs': 51200, 'time_created': '2017-12-05T15:35:28.747000+00:00', 'source_details': {'type': 'volumeGroupBackupId', 'id': 'ocid1.volumegroupbackup.oc1.iad.xxxxxEXAMPLExxxxx'}, 'volume_ids': ['ocid1.volume.oc1.iad.xxxxxEXAMPLExxxxx'], 'is_hydrated': True, 'id': 'ocid1.volumegroup.oc1.iad.xxxxxEXAMPLExxxxx', 'size_in_gbs': 50}]
  availability_domain
string
 always
The Availability Domain of the volume group.

Sample:
IwGV:US-ASHBURN-AD-2
  compartment_id
string
 always
The OCID of the compartment that contains the volume group.

Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
  defined_tags
string
 always
Defined tags for this resource. Each key is predefined and scoped to a namespace.

Sample:
{'Operations': {'CostCenter': '42'}}
  display_name
string
 always
Name of the volume group.

Sample:
ansible_test_volume
  freeform_tags
string
 always
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

Sample:
{'Department': 'Finance'}
  id
string
 always
The OCID of the volume group.

Sample:
ocid1.volumegroup.oc1.iad.xxxxxEXAMPLExxxxx
  is_hydrated
boolean
 always
Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
  lifecycle_state
string
 always
The current state of a volume group.

Sample:
PROVISIONING
  size_in_gbs
integer
 always
The aggregate size of the volume group in GBs.

Sample:
50
  size_in_mbs
integer
 always
The aggregate size of the volume group in MBs.

Sample:
51200
  source_details
dictionary
 always
The volume group source. The source is either another list of volume IDs in the same availability domain, another volume group, or a volume group backup.

Sample:
{'type': 'volumeGroupBackupId', 'id': 'ocid1.volumegroupbackup.oc1.iad.xxxxxEXAMPLExxxxx'}
    id
string
 always
The OCID of the volume group to clone from or OCIDs for the volumes in this volume group or OCID of the volume group backup to restore from.

Sample:
ocid1.volumegroupbackup.oc1.iad.xxxxxEXAMPLExxxxx
    type
string
 always
Type of volume group source either 'volumeGroupBackupId' or 'volumeGroupId' or 'volumeIds'.

Sample:
volumeGroupBackupId
  time_created
datetime
 always
The date and time the volume group was created. Format defined by RFC3339.

Sample:
2017-11-22 19:40:08.871000
  volume_ids
datetime
 always
OCIDs for the volumes in this volume group.

Sample:
['ocid1.volume.oc1.iad.xxxxxEXAMPLExxxxx']


Status

Authors

  • Rohit Chaware (@rohitChaware)

Hint

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