oci_snapshot_facts – Fetches details of the OCI Snapshot instances¶

New in version 2.5.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis ¶

Fetches details of the OCI Snapshot instances.

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 2.7
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_type string	Choices: api_key ← instance_principal instance_obo_user	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`.
file_system_id -		The identifier of the File System of which Snapshot has been taken
lifecycle_state -	Choices: CREATING ACTIVE DELETING DELETED FAILED	A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
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.
snapshot_id -		Identifier of the Snapshot whose details needs to be fetched. aliases: id
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

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

# Fetch Snapshot
- name: List all Snapshots of a specific File System
  oci_snapshot_facts:
      file_system_id: 'ocid1.filesystem..xxxxxEXAMPLExxxxx'

# Fetch Snapshots, filtered by lifecycle state
- name: List all Snapshots of a specific File System, filtered by lifecycle state
  oci_snapshot_facts:
      file_system_id: 'ocid1.filesystem..xxxxxEXAMPLExxxxx'
      lifecycle_state: 'CREATING'

# Fetch specific Snapshot
- name: List a specific Snapshot
  oci_snapshot_facts:
      snapshot_id: 'ocid1.snapshot..xxxxxEXAMPLExxxxx'

Return Values ¶

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

Key		Returned	Description
snapshots complex		success	Attributes of the Fetched Snapshots. Sample: [{'file_system_id': 'ocid1.filesystem.oc1.iad.xxxxxEXAMPLExxxxx', 'freeform_tags': {'system_license': 'trial'}, 'defined_tags': {'ansible_tag_namespace_integration_test_1': {'ansible_tag_1': 'initial'}}, 'name': 'ansible_snapshot', 'id': 'ocid1.snapshot.oc1.iad.xxxxxEXAMPLExxxxx', 'lifecycle_state': 'ACTIVE', 'time_created': '2018-10-16T09:43:24.328000+00:00'}]
	defined_tags dictionary	always	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm. Sample: {'Department': 'Finance'}
	file_system_id string	always	The identifier of the File System of which Snapshot has been taken Sample: ocid1.filesystem.oc1.xzvf..xxxxxEXAMPLExxxxx
	freeform_tags dictionary	always	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 https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm. Sample: {'Operations': {'CostCenter': '42'}}
	id string	always	The identifier of the Snapshot Sample: ocid1.snapshot.oc1.xzvf..xxxxxEXAMPLExxxxx
	lifecycle_state string	always	The current state of the Snapshot. Sample: ACTIVE
	name string	always	The user-friendly name for the Snapshot. Sample: ansible-snapshot
	time_created datetime	always	Date and time when the Snapshot was created, in the format defined by RFC3339 Sample: 2018-10-16 09:43:24.328000+00:00

Status ¶

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

Authors¶

Debayan Gupta(@debayan_gupta)

Hint

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

oci_snapshot_facts – Fetches details of the OCI Snapshot instances¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶