New in version 2.6.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
aws_access_key | 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. aliases: ec2_access_key, access_key | |
aws_secret_key | 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. aliases: ec2_secret_key, secret_key | |
ec2_url | 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 bool |
| Gather file share information for storage gateways in s3 mode. |
gather_local_disks bool |
| Gather local disks attached to the storage gateway. |
gather_tapes bool |
| Gather tape information for storage gateways in tape mode. |
gather_volumes bool |
| Gather volume information for storage gateways in iSCSI (cached & stored) modes. |
profile (added in 1.6) | Uses a boto profile. Only works with boto >= 2.24.0. | |
region | 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 (added in 1.6) | AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. aliases: access_token | |
validate_certs bool (added in 1.5) |
| When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. |
Note
AWS_URL
or EC2_URL
, 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_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# 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
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 | ||
gateway_id string | always | Storage Gateway ID Sample: sgw-9999F888 | ||
gateway_name string | always | Storage Gateway friendly name Sample: my-sgw-01 | ||
tapes complex | when gateway_type == "VTL" | Storage Gateway tapes | ||
tape_barcode string | always | Tape ARN Sample: tape-AF999C88 | ||
tape_arn string | always | Tape ARN Sample: arn:aws:storagegateway:eu-west-1:399805793479:tape/tape-AF999C88 | ||
tape_size_in_bytes integer | always | Tape ARN Sample: 555887569 | ||
tape_status string | always | Tape ARN Sample: AVAILABLE | ||
gateway_arn string | always | Storage Gateway ARN Sample: arn:aws:storagegateway:eu-west-1:367709993819:gateway/sgw-9999F888 | ||
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_status string | always | File share status Sample: AVAILABLE | ||
file_share_id string | always | File share ID Sample: share-AF999C88 | ||
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_status string | always | Disk status Sample: present | ||
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_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 |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/aws_sgw_facts_module.html