Try SpotterFetch AWS Storage Gateway facts
| "added in version" 2.6 of ansible.builtin"
Authors: Loic Blot (@nerzhul) <loic.blot@unix-experience.fr>
preview | supported by community
pipInstall with pip install ansible==2.8.19
Fetch AWS Storage Gateway facts
# Note: These examples do not set authentication details, see the AWS Guide for details. - name: "Get AWS storage gateway facts" aws_sgw_facts:
- name: "Get AWS storage gateway facts for region eu-west-3"
aws_sgw_facts:
region: eu-west-3
region:
aliases:
- aws_region
- ec2_region
description:
- 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
ec2_url:
aliases:
- aws_endpoint_url
- endpoint_url
description:
- 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.
type: str
profile:
aliases:
- aws_profile
description:
- Uses a boto profile. Only works with boto >= 2.24.0.
- Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
and support for passing them at the same time as I(profile) has been deprecated.
- I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
exclusive with I(profile) after 2022-06-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(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 U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
for more boto configuration.
type: dict
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.
- 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.'
type: path
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- 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 I(profile) is set this parameter is ignored.
- Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- 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 I(profile) is set this parameter is ignored.
- Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
gather_volumes:
default: true
description:
- Gather volume information for storage gateways in iSCSI (cached & stored) modes.
required: false
type: bool
security_token:
aliases:
- aws_security_token
- access_token
description:
- AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN
environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(security_token) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
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: 'no'
description:
- 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.
type: bool
gateways:
contains:
file_shares:
contains:
file_share_arn:
description: File share ARN
returned: always
sample: arn:aws:storagegateway:eu-west-1:399805793479: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:367709993819: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:399805793479: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