Try Spotterdescribe AWS Network Firewall firewalls
| "added in version" 4.0.0 of community.aws"
Authors: Mark Chappell (@tremble)
Install with ansible-galaxy collection install community.aws:==5.1.0
collections:
- name: community.aws
version: 5.1.0A module for describing AWS Network Firewall firewalls.
# Describe all firewalls in an account
- community.aws.networkfirewall_info: {}
# Describe a firewall by ARN
- community.aws.networkfirewall_info:
arn: arn:aws:network-firewall:us-east-1:123456789012:firewall/ExampleFirewall
# Describe a firewall by name
- community.aws.networkfirewall_info:
name: ExampleFirewall
arn:
description:
- The ARN of the Network Firewall.
- Mutually exclusive with I(name) and I(vpc_ids).
required: false
type: str
name:
description:
- The name of the Network Firewall.
- Mutually exclusive with I(arn) and I(vpc_ids).
required: false
type: str
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
vpc_ids:
aliases:
- vpcs
- vpc_id
description:
- A List of VPCs to retrieve the firewalls for.
- Mutually exclusive with I(name) and I(arn).
elements: str
required: false
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
firewall_list:
description: A list of ARNs of the matching firewalls.
elements: str
example:
- arn:aws:network-firewall:us-east-1:123456789012:firewall/Example1
- arn:aws:network-firewall:us-east-1:123456789012:firewall/Example2
returned: When a firewall name isn't specified
type: list
firewalls:
contains:
firewall:
contains:
delete_protection:
description: A flag indicating whether it is possible to delete the firewall.
example: true
returned: success
type: str
description:
description: A description of the firewall.
example: Description
returned: success
type: str
firewall_arn:
description: The ARN of the firewall.
example: arn:aws:network-firewall:us-east-1:123456789012:firewall/ExampleFirewall
returned: success
type: str
firewall_id:
description: A unique ID for the firewall.
example: 12345678-abcd-1234-abcd-123456789abc
returned: success
type: str
firewall_name:
description: The name of the firewall.
example: ExampleFirewall
returned: success
type: str
firewall_policy_arn:
description: The ARN of the firewall policy used by the firewall.
example: arn:aws:network-firewall:us-east-1:123456789012:firewall-policy/ExamplePolicy
returned: success
type: str
firewall_policy_change_protection:
description:
- A flag indicating whether it is possible to change which firewall policy
is used by the firewall.
example: false
returned: success
type: bool
subnet_change_protection:
description:
- A flag indicating whether it is possible to change which subnets the firewall
endpoints are in.
example: true
returned: success
type: bool
subnet_mappings:
contains:
subnet_id:
description: The ID of the subnet.
example: subnet-12345678
returned: success
type: str
description: A list of the subnets the firewall endpoints are in.
elements: dict
type: list
tags:
description: The tags associated with the firewall.
example: '{"SomeTag": "SomeValue"}'
returned: success
type: dict
vpc_id:
description: The ID of the VPC that the firewall is used by.
example: vpc-0123456789abcdef0
returned: success
type: str
description: The details of the firewall
returned: success
type: dict
firewall_metadata:
contains:
configuration_sync_state_summary:
description:
- A short summary of the synchronization status of the policy and rule groups.
example: IN_SYNC
returned: success
type: str
status:
description:
- A short summary of the status of the firewall endpoints.
example: READY
returned: success
type: str
sync_states:
description:
- A description, broken down by availability zone, of the status of the
firewall endpoints as well as the synchronization status of the policies
and rule groups.
example:
us-east-1a:
attachment:
endpoint_id: vpce-123456789abcdef01
status: READY
subnet_id: subnet-12345678
config:
arn:aws:network-firewall:us-east-1:123456789012:firewall-policy/Ansible-Example:
sync_status: IN_SYNC
update_token: abcdef01-0000-0000-0000-123456789abc
arn:aws:network-firewall:us-east-1:123456789012:stateful-rulegroup/ExampleDomainList:
sync_status: IN_SYNC
update_token: 12345678-0000-0000-0000-abcdef012345
returned: success
type: dict
description: Metadata about the firewall
returned: success
type: dict
description: The details of the firewalls
elements: dict
returned: success
type: list