W3cubDocs

/Ansible

efs_facts - Get information about Amazon EFS file systems

New in version 2.2.

Synopsis

Module searches Amazon EFS file systems

Requirements (on host that executes module)

  • boto
  • boto3
  • python >= 2.6

Options

parameter required default choices comments
aws_access_key
 no
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
 no
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
 no
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.
id
 no None
ID of Amazon EFS.
name
 no None
Creation Token of Amazon EFS file system.
profile
(added in 1.6)
 no
Uses a boto profile. Only works with boto >= 2.24.0.
security_token
(added in 1.6)
 no
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
tags
 no None
List of tags of Amazon EFS. Should be defined as dictionary
</div></td></tr>
<tr>

<td>targets<br/><div style=”font-size: small;”></div></td> <td>no</td> <td>None</td>

<td><ul></ul></td> <td><div>List of mounted targets. It should be a list of dictionaries, every dictionary should include next attributes:
  • SubnetId - Mandatory. The ID of the subnet to add the mount target in.
  • IpAddress - Optional. A valid IPv4 address within the address range of the specified subnet.
  • SecurityGroups - Optional. List of security group IDs, of the form “sg-xxxxxxxx”. These must be for the same VPC as subnet specified.
</div></td></tr>
<tr>

<td>validate_certs<br/><div style=”font-size: small;”> (added in 1.5)</div></td> <td>no</td> <td>yes</td>

<td><ul><li>yes</li><li>no</li></ul></td> <td><div>When set to “no”, SSL certificates will not be validated for boto versions &gt;= 2.6.0.</div></td></tr> </table>

</br>

Examples

# find all existing efs
- efs_facts:
  register: result

- efs_facts:
    name: myTestNameTag

- efs_facts:
    id: fs-1234abcd

# Searching all EFS instances with tag Name = 'myTestNameTag', in subnet 'subnet-1a2b3c4d' and with security group 'sg-4d3c2b1a'
- efs_facts:
    tags:
        name: myTestNameTag
    targets:
        - subnet-1a2b3c4d
        - sg-4d3c2b1a

Return Values

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

name description returned type sample
creation_token EFS creation token None UUID console-88609e04-9a0e-4a2e-912c-feaa99509961
name name of the file system None str my-efs
tags tags on the efs instance None dict {'name': 'my-efs', 'key': 'Value'}
size_in_bytes size of the file system in bytes as of a timestamp None dict {'timestamp': '2015-12-21 13:59:59-05:00', 'value': 12288}
creation_time timestamp of creation date None datetime 2015-11-16 12:30:57
life_cycle_state state of the EFS file system None str creating, available, deleting, deleted
file_system_id ID of the file system None unique ID fs-xxxxxxxx
mount_point url of file system None str .fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/
number_of_mount_targets the number of targets mounted None int 3
mount_targets list of mount targets None list of dicts [{'mount_target_id': 'fsmt-d8907871', 'life_cycle_state': 'available', 'file_system_id': 'fs-a7ad440e', 'subnet_id': 'subnet-e265c895', 'network_interface_id': 'eni-6e387e26', 'ip_address': '172.31.17.173', 'security_groups': ['sg-a30b22c6'], 'owner_id': '740748460359'}, '...']
performance_mode performance mode of the file system None str generalPurpose
owner_id AWS account ID of EFS owner None str XXXXXXXXXXXX

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_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

Note

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

Note

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

This is an Extras Module

For more information on what this means please read Extras Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.

Next Previous

Copyright © 2016 Red Hat, Inc.
Last updated on Oct 31, 2016.

Ansible docs are generated from GitHub sources using Sphinx using a theme provided by Read the Docs. . Module documentation is not edited directly, but is generated from the source code for the modules. To submit an update to module docs, edit the 'DOCUMENTATION' metadata in the core and extras modules source repositories.

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/efs_facts_module.html