community / community.aws / 2.6.1 / module / efs_info Get information about Amazon EFS file systems | "added in version" 1.0.0 of community.aws" Authors: Ryan Sydnor (@ryansydnor)community.aws.efs_info (2.6.1) — module
Install with ansible-galaxy collection install community.aws:==2.6.1
collections: - name: community.aws version: 2.6.1
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
- ansible.builtin.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. - For global services such as IAM, Route53 and CloudFront, I(region) is ignored. - The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used. - See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region). - The C(ec2_region) alias has been deprecated and will be removed in a release after 2024-12-01 - Support for the C(EC2_REGION) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str profile: aliases: - aws_profile description: - A named AWS profile to use for authentication. - See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html). - The C(AWS_PROFILE) environment variable may also be used. - 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: 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 access_key: aliases: - aws_access_key_id - aws_access_key - ec2_access_key description: - AWS access key ID. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables may also be used in decreasing order of preference. - The I(aws_access_key) and I(profile) options are mutually exclusive. - The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_access_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). type: dict secret_key: aliases: - aws_secret_access_key - aws_secret_key - ec2_secret_key description: - AWS secret access key. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variables may also be used in decreasing order of preference. - The I(secret_key) and I(profile) options are mutually exclusive. - The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_secret_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str endpoint_url: aliases: - ec2_url - aws_endpoint_url - s3_url description: - URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. - The C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing order of preference. - The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_URL) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - The C(AWS_CA_BUNDLE) environment variable may also be used. type: path session_token: aliases: - aws_session_token - security_token - aws_security_token - access_token description: - AWS STS session token for use with temporary credentials. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variables may also be used in decreasing order of preference. - The I(security_token) and I(profile) options are mutually exclusive. - Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with the parameter being renamed from I(security_token) to I(session_token) in release 6.0.0. - The I(security_token), I(aws_security_token), and I(access_token) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables has been deprecated and will be removed in a release after 2024-12-01. type: str validate_certs: default: true description: - When set to C(false), SSL certificates will not be validated for communication with the AWS APIs. - Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider setting I(aws_ca_bundle) instead. type: bool debug_botocore_endpoint_logs: default: false description: - Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action") API calls made during a task, outputing the set to the resource_actions key in the task results. Use the C(aws_resource_action) callback to output to total list made during a playbook. - The C(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 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: always sample: bursting type: str