Try SpotterFetch AWS Storage Gateway information
| "added in version" 1.0.0 of community.aws"
Authors: Loic Blot (@nerzhul) <loic.blot@unix-experience.fr>
Install with ansible-galaxy collection install community.aws:==5.1.0
collections:
- name: community.aws
version: 5.1.0Fetch AWS Storage Gateway information
Prior to release 5.0.0 this module was called C(community.aws.aws_sgw_info). The usage did not change.
# 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
region:
aliases:
- aws_region
- ec2_region
description:
- The AWS region to use.
- For global services such as IAM, Route53 and CloudFront, I(region) is ignored.
- The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used.
- See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region).
- The C(ec2_region) alias has been deprecated and will be removed in a release after
2024-12-01
- Support for the C(EC2_REGION) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
profile:
aliases:
- aws_profile
description:
- A named AWS profile to use for authentication.
- See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
- The C(AWS_PROFILE) environment variable may also be used.
- The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
and I(security_token) options.
type: str
access_key:
aliases:
- aws_access_key_id
- aws_access_key
- ec2_access_key
description:
- AWS access key ID.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables
may also be used in decreasing order of preference.
- The I(aws_access_key) and I(profile) options are mutually exclusive.
- The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the
AWS botocore SDK.
- The I(ec2_access_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
type: dict
secret_key:
aliases:
- aws_secret_access_key
- aws_secret_key
- ec2_secret_key
description:
- AWS secret access key.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment
variables may also be used in decreasing order of preference.
- The I(secret_key) and I(profile) options are mutually exclusive.
- The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with
the AWS botocore SDK.
- The I(ec2_secret_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
endpoint_url:
aliases:
- ec2_url
- aws_endpoint_url
- s3_url
description:
- URL to connect to instead of the default AWS endpoints. While this can be used
to connection to other AWS-compatible services the amazon.aws and community.aws
collections are only tested against AWS.
- The C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing
order of preference.
- The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in
a release after 2024-12-01.
- Support for the C(EC2_URL) environment variable has been deprecated and will be
removed in a release after 2024-12-01.
type: str
gather_tapes:
default: true
description:
- Gather tape information for storage gateways in tape mode.
required: false
type: bool
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- The C(AWS_CA_BUNDLE) environment variable may also be used.
type: path
session_token:
aliases:
- aws_session_token
- security_token
- aws_security_token
- access_token
description:
- AWS STS session token for use with temporary credentials.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment
variables may also be used in decreasing order of preference.
- The I(security_token) and I(profile) options are mutually exclusive.
- Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with
the parameter being renamed from I(security_token) to I(session_token) in release
6.0.0.
- The I(security_token), I(aws_security_token), and I(access_token) aliases have been
deprecated and will be removed in a release after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables
has been deprecated and will be removed in a release after 2024-12-01.
type: str
gather_volumes:
default: true
description:
- Gather volume information for storage gateways in iSCSI (cached & stored) modes.
required: false
type: bool
validate_certs:
default: true
description:
- When set to C(false), SSL certificates will not be validated for communication with
the AWS APIs.
- Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider
setting I(aws_ca_bundle) instead.
type: bool
gather_file_shares:
default: true
description:
- Gather file share information for storage gateways in s3 mode.
required: false
type: bool
gather_local_disks:
default: true
description:
- Gather local disks attached to the storage gateway.
required: false
type: bool
debug_botocore_endpoint_logs:
default: false
description:
- Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action")
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the C(aws_resource_action) callback to output to total list made
during a playbook.
- The C(ANSIBLE_DEBUG_BOTOCORE_LOGS) environment variable may also be used.
type: bool
gateways:
contains:
file_shares:
contains:
file_share_arn:
description: File share ARN
returned: always
sample: arn:aws:storagegateway:eu-west-1:123456789012:share/share-AF999C88
type: str
file_share_id:
description: File share ID
returned: always
sample: share-AF999C88
type: str
file_share_status:
description: File share status
returned: always
sample: AVAILABLE
type: str
description: Storage gateway file shares
returned: when gateway_type == "FILE_S3"
type: complex
gateway_arn:
description: Storage Gateway ARN
returned: always
sample: arn:aws:storagegateway:eu-west-1:123456789012:gateway/sgw-9999F888
type: str
gateway_id:
description: Storage Gateway ID
returned: always
sample: sgw-9999F888
type: str
gateway_name:
description: Storage Gateway friendly name
returned: always
sample: my-sgw-01
type: str
gateway_operational_state:
description: Storage Gateway operational state
returned: always
sample: ACTIVE
type: str
gateway_type:
description: Storage Gateway type
returned: always
sample: FILE_S3
type: str
local_disks:
contains:
disk_allocation_type:
description: Disk allocation type
returned: always
sample: CACHE STORAGE
type: str
disk_id:
description: Disk ID on the system
returned: always
sample: pci-0000:00:1f.0
type: str
disk_node:
description: Disk parent block device
returned: always
sample: /dev/sdb
type: str
disk_path:
description: Disk path used for the cache
returned: always
sample: /dev/nvme1n1
type: str
disk_size_in_bytes:
description: Disk size in bytes
returned: always
sample: 107374182400
type: int
disk_status:
description: Disk status
returned: always
sample: present
type: str
description: Storage gateway local disks
returned: always
type: complex
tapes:
contains:
tape_arn:
description: Tape ARN
returned: always
sample: arn:aws:storagegateway:eu-west-1:123456789012:tape/tape-AF999C88
type: str
tape_barcode:
description: Tape ARN
returned: always
sample: tape-AF999C88
type: str
tape_size_in_bytes:
description: Tape ARN
returned: always
sample: 555887569
type: int
tape_status:
description: Tape ARN
returned: always
sample: AVAILABLE
type: str
description: Storage Gateway tapes
returned: when gateway_type == "VTL"
type: complex
description: list of gateway objects
returned: always
type: complex