community / community.aws / 0.1.2 / module / efs_facts Get information about Amazon EFS file systems | "added in version" 1.0.0 of community.aws" Authors: Ryan Sydnor (@ryansydnor)community.aws.efs_facts (0.1.2) — module
Install with ansible-galaxy collection install community.aws:==0.1.2
collections: - name: community.aws version: 0.1.2
This module can be used to search Amazon EFS file systems.
This module was called C(efs_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(community.aws.efs_info) module no longer returns C(ansible_facts)!
- name: Find all existing efs community.aws.efs_info: register: result
- name: Find efs using id community.aws.efs_info: id: fs-1234abcd register: result
- name: Searching all EFS instances with tag Name = 'myTestNameTag', in subnet 'subnet-1a2b3c4d' and with security group 'sg-4d3c2b1a' community.aws.efs_info: tags: Name: myTestNameTag targets: - subnet-1a2b3c4d - sg-4d3c2b1a register: result
- debug: msg: "{{ result['efs'] }}"
id: description: - ID of Amazon EFS. type: str name: aliases: - creation_token description: - Creation Token of Amazon EFS file system. type: str tags: description: - List of tags of Amazon EFS. Should be defined as dictionary. type: dict 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: - 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 targets: description: - List of targets on which to filter the returned results. - Result must match all of the specified targets, each of which can be a security group ID, a subnet ID or an IP address. elements: str type: list 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 aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Not used by boto 2 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: - 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. - 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: - 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. - 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 security_token: aliases: - 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. - 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 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: always sample: '2015-11-16 07:30:57-05:00' type: str creation_token: description: EFS creation token returned: always sample: console-88609e04-9a0e-4a2e-912c-feaa99509961 type: str file_system_id: description: ID of the file system returned: always sample: fs-xxxxxxxx type: str filesystem_address: description: url of file system returned: always sample: fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/ type: str life_cycle_state: description: state of the EFS file system returned: always sample: creating, available, deleting, deleted type: str mount_point: description: url of file system with leading dot from the time AWS EFS required to add network suffix to EFS address returned: always sample: .fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/ type: str mount_targets: description: list of mount targets returned: always 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 name: description: name of the file system returned: always sample: my-efs type: str number_of_mount_targets: description: the number of targets mounted returned: always sample: 3 type: int owner_id: description: AWS account ID of EFS owner returned: always sample: XXXXXXXXXXXX type: str performance_mode: description: performance mode of the file system returned: always sample: generalPurpose type: str provisioned_throughput_in_mibps: description: throughput provisioned in Mibps returned: when botocore >= 1.10.57 and throughput_mode is set to "provisioned" sample: 15.0 type: float size_in_bytes: description: size of the file system in bytes as of a timestamp returned: always sample: timestamp: '2015-12-21 13:59:59-05:00' value: 12288 type: dict tags: description: tags on the efs instance returned: always sample: key: Value name: my-efs type: dict throughput_mode: description: mode of throughput for the file system returned: when botocore >= 1.10.57 sample: bursting type: str