community.aws.aws_sgw_info – Fetch AWS Storage Gateway information

From Get docs
Ansible/docs/2.11/collections/community/aws/aws sgw info module


community.aws.aws_sgw_info – Fetch AWS Storage Gateway information

Note

This plugin is part of the community.aws collection (version 1.3.0).

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 Choices/Defaults Comments

aws_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.


aliases: ec2_access_key, access_key

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.

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

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.


aliases: ec2_secret_key, secret_key

debug_botocore_endpoint_logs

boolean

  • no

  • yes

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.

ec2_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.


aliases: aws_endpoint_url, endpoint_url

gather_file_shares

boolean

  • no
  • yes

Gather file share information for storage gateways in s3 mode.

gather_local_disks

boolean

  • no
  • yes

Gather local disks attached to the storage gateway.

gather_tapes

boolean

  • no
  • yes

Gather tape information for storage gateways in tape mode.

gather_volumes

boolean

  • no
  • yes

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

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.


aliases: aws_profile

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


aliases: aws_region, ec2_region

security_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.


aliases: aws_security_token, access_token

validate_certs

boolean

  • no
  • yes

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



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 Returned Description

gateways

complex

always

list of gateway objects


file_shares

complex

when gateway_type == "FILE_S3"

Storage gateway file shares


file_share_arn

string

always

File share ARN


Sample:

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

file_share_id

string

always

File share ID


Sample:

share-AF999C88

file_share_status

string

always

File share status


Sample:

AVAILABLE

gateway_arn

string

always

Storage Gateway ARN


Sample:

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

gateway_id

string

always

Storage Gateway ID


Sample:

sgw-9999F888

gateway_name

string

always

Storage Gateway friendly name


Sample:

my-sgw-01

gateway_operational_state

string

always

Storage Gateway operational state


Sample:

ACTIVE

gateway_type

string

always

Storage Gateway type


Sample:

FILE_S3

local_disks

complex

always

Storage gateway local disks


disk_allocation_type

string

always

Disk allocation type


Sample:

CACHE STORAGE

disk_id

string

always

Disk ID on the system


Sample:

pci-0000:00:1f.0

disk_node

string

always

Disk parent block device


Sample:

/dev/sdb

disk_path

string

always

Disk path used for the cache


Sample:

/dev/nvme1n1

disk_size_in_bytes

integer

always

Disk size in bytes


Sample:

107374182400

disk_status

string

always

Disk status


Sample:

present

tapes

complex

when gateway_type == "VTL"

Storage Gateway tapes


tape_arn

string

always

Tape ARN


Sample:

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

tape_barcode

string

always

Tape ARN


Sample:

tape-AF999C88

tape_size_in_bytes

integer

always

Tape ARN


Sample:

555887569

tape_status

string

always

Tape ARN


Sample:

AVAILABLE




Authors

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/aws_sgw_info_module.html