community.aws.aws_sgw_info – Fetch AWS Storage Gateway information

Note

This plugin is part of the community.aws collection (version 1.5.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 community.aws.

To use it in a playbook, specify: community.aws.aws_sgw_info.

New in version 1.0.0: of community.aws

Synopsis

  • Fetch AWS Storage Gateway information

  • This module was called aws_sgw_facts before Ansible 2.9. The usage did not change.

Requirements

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

  • boto

  • boto3

  • python >= 2.6

Parameters

Parameter

Comments

aws_access_key

aliases: ec2_access_key, access_key

string

AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.

If profile is set this parameter is ignored.

Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

Only used for boto3 based modules.

Note: The CA Bundle is read ‘module’ side and may need to be explicitly copied from the controller if not run locally.

aws_config

dictionary

A dictionary to modify the botocore configuration.

Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

Only the ‘user_agent’ key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.

aws_secret_key

aliases: ec2_secret_key, secret_key

string

AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.

If profile is set this parameter is ignored.

Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

debug_botocore_endpoint_logs

boolean

Use a botocore.endpoint logger to parse the unique (rather than total) “resource:action” API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.

Choices:

  • no ← (default)

  • yes

ec2_url

aliases: aws_endpoint_url, endpoint_url

string

Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

gather_file_shares

boolean

Gather file share information for storage gateways in s3 mode.

Choices:

  • no

  • yes ← (default)

gather_local_disks

boolean

Gather local disks attached to the storage gateway.

Choices:

  • no

  • yes ← (default)

gather_tapes

boolean

Gather tape information for storage gateways in tape mode.

Choices:

  • no

  • yes ← (default)

gather_volumes

boolean

Gather volume information for storage gateways in iSCSI (cached & stored) modes.

Choices:

  • no

  • yes ← (default)

profile

aliases: aws_profile

string

Uses a boto profile. Only works with boto >= 2.24.0.

Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.

aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

region

aliases: aws_region, ec2_region

string

The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

security_token

aliases: aws_security_token, access_token

string

AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.

If profile is set this parameter is ignored.

Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

validate_certs

boolean

When set to “no”, SSL certificates will not be validated for boto versions >= 2.6.0.

Choices:

  • no

  • yes ← (default)

Notes

Note

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE

  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html

  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Examples

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: "Get AWS storage gateway information"
  community.aws.aws_sgw_info:

- name: "Get AWS storage gateway information for region eu-west-3"
  community.aws.aws_sgw_info:
    region: eu-west-3

Return Values

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

Key

Description

gateways

complex

list of gateway objects

Returned: always

file_shares

complex

Storage gateway file shares

Returned: when gateway_type == “FILE_S3”

file_share_arn

string

File share ARN

Returned: always

Sample: “arn:aws:storagegateway:eu-west-1:399805793479:share/share-AF999C88”

file_share_id

string

File share ID

Returned: always

Sample: “share-AF999C88”

file_share_status

string

File share status

Returned: always

Sample: “AVAILABLE”

gateway_arn

string

Storage Gateway ARN

Returned: always

Sample: “arn:aws:storagegateway:eu-west-1:367709993819:gateway/sgw-9999F888”

gateway_id

string

Storage Gateway ID

Returned: always

Sample: “sgw-9999F888”

gateway_name

string

Storage Gateway friendly name

Returned: always

Sample: “my-sgw-01”

gateway_operational_state

string

Storage Gateway operational state

Returned: always

Sample: “ACTIVE”

gateway_type

string

Storage Gateway type

Returned: always

Sample: “FILE_S3”

local_disks

complex

Storage gateway local disks

Returned: always

disk_allocation_type

string

Disk allocation type

Returned: always

Sample: “CACHE STORAGE”

disk_id

string

Disk ID on the system

Returned: always

Sample: “pci-0000:00:1f.0”

disk_node

string

Disk parent block device

Returned: always

Sample: “/dev/sdb”

disk_path

string

Disk path used for the cache

Returned: always

Sample: “/dev/nvme1n1”

disk_size_in_bytes

integer

Disk size in bytes

Returned: always

Sample: 107374182400

disk_status

string

Disk status

Returned: always

Sample: “present”

tapes

complex

Storage Gateway tapes

Returned: when gateway_type == “VTL”

tape_arn

string

Tape ARN

Returned: always

Sample: “arn:aws:storagegateway:eu-west-1:399805793479:tape/tape-AF999C88”

tape_barcode

string

Tape ARN

Returned: always

Sample: “tape-AF999C88”

tape_size_in_bytes

integer

Tape ARN

Returned: always

Sample: 555887569

tape_status

string

Tape ARN

Returned: always

Sample: “AVAILABLE”

Authors