Try SpotterGet information about Amazon EFS file systems
| "added in version" 2.2 of ansible.builtin"
Authors: Ryan Sydnor (@ryansydnor)
preview | supported by curated
pipInstall with pip install ansible==2.3.3.0.post1
Module searches Amazon EFS file systems
# 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
id:
default: None
description:
- ID of Amazon EFS.
required: false
name:
default: None
description:
- Creation Token of Amazon EFS file system.
required: false
tags:
default: None
description:
- List of tags of Amazon EFS. Should be defined as dictionary
required: false
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:
- The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
and I(security_token) options.
type: str
targets:
default: None
description:
- '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.'
required: false
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).
type: dict
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- '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:
- C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
or C(EC2_ACCESS_KEY) environment variable is used.
- The I(aws_access_key) and I(profile) options are mutually exclusive.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
or C(EC2_SECRET_KEY) environment variable is used.
- The I(aws_secret_key) and I(profile) options are mutually exclusive.
type: str
security_token:
aliases:
- aws_session_token
- session_token
- aws_security_token
- access_token
description:
- C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
or C(EC2_SECURITY_TOKEN) environment variable is used.
- The I(security_token) and I(profile) options are mutually exclusive.
- Aliases I(aws_session_token) and I(session_token) have been added in version 3.2.0.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for communication with
the AWS APIs.
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
creation_time:
description: timestamp of creation date
returned: null
sample: '2015-11-16T07:30:57-05:00'
type: datetime
creation_token:
description: EFS creation token
returned: null
sample: console-88609e04-9a0e-4a2e-912c-feaa99509961
type: UUID
file_system_id:
description: ID of the file system
returned: null
sample: fs-xxxxxxxx
type: unique ID
life_cycle_state:
description: state of the EFS file system
returned: null
sample: creating, available, deleting, deleted
type: str
mount_point:
description: url of file system
returned: null
sample: .fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/
type: str
mount_targets:
description: list of mount targets
returned: null
sample:
- file_system_id: fs-a7ad440e
ip_address: 172.31.17.173
life_cycle_state: available
mount_target_id: fsmt-d8907871
network_interface_id: eni-6e387e26
owner_id: '740748460359'
security_groups:
- sg-a30b22c6
subnet_id: subnet-e265c895
- '...'
type: list of dicts
name:
description: name of the file system
returned: null
sample: my-efs
type: str
number_of_mount_targets:
description: the number of targets mounted
returned: null
sample: 3
type: int
owner_id:
description: AWS account ID of EFS owner
returned: null
sample: XXXXXXXXXXXX
type: str
performance_mode:
description: performance mode of the file system
returned: null
sample: generalPurpose
type: str
size_in_bytes:
description: size of the file system in bytes as of a timestamp
returned: null
sample:
timestamp: '2015-12-21 13:59:59-05:00'
value: 12288
type: dict
tags:
description: tags on the efs instance
returned: null
sample:
key: Value
name: my-efs
type: dict