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:==4.3.0
collections:
- name: community.aws
version: 4.3.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. 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:
- Uses a boto profile. Only works with boto >= 2.24.0.
- 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
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
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.
- Only used for boto3 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:
- 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.
- 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:
- 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.
- 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:
- AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or 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 boto versions >= 2.6.0.
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
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