New in version 2.2.
Module allows create, search and destroy Amazon EFS file systems
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. Either name or ID required for delete. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | no | None | Creation Token of Amazon EFS file system. Required for create. Either name or ID required for delete. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
performance_mode | no | general_purpose |
| File system's performance mode to use. Only takes effect during creation. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
state | no | present |
| Allows to create, search and destroy Amazon EFS file system |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tags | no | None |
List of tags of Amazon EFS. Should be defined as dictionary In case of ‘present’ state with list of tags and existing EFS (matched by ‘name’), tags of EFS will be replaced with provided data. </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:
This data may be modified for existing EFS using state ‘present’ and new list of mount targets. </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 >= 2.6.0.</div></td></tr> <tr><td>wait<br/><div style=”font-size: small;”></div></td> <td>no</td> <td>no</td> <td><ul><li>yes</li><li>no</li></ul></td> <td><div>In case of ‘present’ state should wait for EFS ‘available’ life cycle state (of course, if current state not ‘deleting’ or ‘deleted’)In case of ‘absent’ state should wait for EFS ‘deleted’ life cycle state </div></td></tr> <tr><td>wait_timeout<br/><div style=”font-size: small;”></div></td> <td>no</td> <td></td> <td><ul></ul></td> <td><div>How long the module should wait (in seconds) for desired state before returning. Zero means wait as long as necessary.</div></td></tr> </table></br> Examples# EFS provisioning - efs: state: present name: myTestEFS tags: name: myTestNameTag purpose: file-storage targets: - subnet_id: subnet-748c5d03 security_groups: [ "sg-1a2b3c4d" ] # Modifying EFS data - efs: state: present name: myTestEFS tags: name: myAnotherTestTag targets: - subnet_id: subnet-7654fdca security_groups: [ "sg-4c5d6f7a" ] # Deleting EFS - efs: state: absent name: myTestEFS Return ValuesCommon return values are documented here Common Return Values, the following are the fields unique to this module:
NotesNote If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence 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
This is an Extras ModuleFor 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. |
© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/efs_module.html