paloaltonetworks.panos.panos_aggregate_interface module – Manage aggregate network interfaces

Note

This module is part of the paloaltonetworks.panos collection (version 2.21.2).

To install it, use: ansible-galaxy collection install paloaltonetworks.panos. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: paloaltonetworks.panos.panos_aggregate_interface.

New in paloaltonetworks.panos 1.0.0

Synopsis

• Manage aggregate network interfaces on PanOS

Requirements

The below requirements are needed on the host that executes this module.

• pan-python can be obtained from PyPi https://pypi.python.org/pypi/pan-python

• pandevice can be obtained from PyPi https://pypi.python.org/pypi/pandevice

Parameters

Parameter	Comments
adjust_tcp_mss boolean	Adjust TCP MSS. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
api_key string	Deprecated Use provider to specify PAN-OS connectivity instead. The API key to use instead of generating it using username / password.
comment string	Interface comment.
commit boolean	Deprecated Please use paloaltonetworks.panos.panos_commit_firewall, paloaltonetworks.panos.panos_commit_panorama, paloaltonetworks.panos.panos_commit_push instead. Commit changes after creating object. If ip_address is a Panorama device, and device_group or template are also set, perform a commit to Panorama and a commit-all to the device group/template. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
create_dhcp_default_route boolean	Create default route pointing to default gateway provided by server Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
dhcp_default_route_metric integer	Metric for the DHCP default route
enable_dhcp boolean	Enable DHCP on this interface Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
gathered_filter string	When state=gathered. An advanced filtering option to filter results returned from PAN-OS. Refer to the guide discussing gathered_filter for more information.
if_name string	Name of the interface to configure.
ip list / elements=string	List of static IP addresses.
ip_address string	Deprecated Use provider to specify PAN-OS connectivity instead. The IP address or hostname of the PAN-OS device being configured.
ipv4_mss_adjust integer	(7.1+) TCP MSS adjustment for IPv4.
ipv6_enabled boolean	Enable IPv6. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
ipv6_mss_adjust integer	(7.1+) TCP MSS adjustment for IPv6.
lacp_enable boolean	Enable LACP on this interface Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
lacp_fast_failover boolean	Enable LACP fast failover Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
lacp_mode string	Set LACP mode Choices: :ansible-option-choices-entry:`"active"` :ansible-option-choices-entry:`"passive"`
lacp_passive_pre_negotiation boolean	Enable LACP passive pre-negotiation Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
lacp_rate string	Set LACP transmission rate Choices: :ansible-option-choices-entry:`"fast"` :ansible-option-choices-entry:`"slow"`
lldp_enabled boolean	(Layer2) Enable LLDP Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
lldp_profile string	(Layer2) Reference to an lldp profile
management_profile string	Interface management profile name.
mode string	The interface mode. Choices: :ansible-option-choices-entry-default:`"layer3"` ← (default) :ansible-option-choices-entry:`"layer2"` :ansible-option-choices-entry:`"virtual-wire"` :ansible-option-choices-entry:`"ha"`
mtu integer	MTU for aggregate interface.
netflow_profile string	Netflow profile for aggregate interface.
password string	Deprecated Use provider to specify PAN-OS connectivity instead. The password to use for authentication. This is ignored if api_key is specified.
port integer	Deprecated Use provider to specify PAN-OS connectivity instead. The port number to connect to the PAN-OS device on. Default: :ansible-option-default:`443`
provider dictionary added in paloaltonetworks.panos 1.0.0	A dict object containing connection details.
api_key string	The API key to use instead of generating it using username / password.
ip_address string	The IP address or hostname of the PAN-OS device being configured.
password string	The password to use for authentication. This is ignored if api_key is specified.
port integer	The port number to connect to the PAN-OS device on. Default: :ansible-option-default:`443`
serial_number string	The serial number of a firewall to use for targeted commands. If ip_address is not a Panorama PAN-OS device, then this param is ignored.
username string	The username to use for authentication. This is ignored if api_key is specified. Default: :ansible-option-default:`"admin"`
state string	The state. Choices: :ansible-option-choices-entry-default:`"present"` ← (default) :ansible-option-choices-entry:`"absent"` :ansible-option-choices-entry:`"replaced"` :ansible-option-choices-entry:`"merged"` :ansible-option-choices-entry:`"deleted"` :ansible-option-choices-entry:`"gathered"`
template string	(Panorama only) The template this operation should target. This param is required if the PAN-OS device is Panorama.
username string	Deprecated Use provider to specify PAN-OS connectivity instead. The username to use for authentication. This is ignored if api_key is specified. Default: :ansible-option-default:`"admin"`
vr_name string	The virtual router to associate with this interface. Default: :ansible-option-default:`"default"`
vsys string	The vsys this object should be imported into. Objects that are imported include interfaces, virtual routers, virtual wires, and VLANs. Interfaces are typically imported into vsys1 if no vsys is specified.
zone_name string	The zone to put this interface into.

Notes

Note

• Checkmode is supported.

• Panorama is supported.

• If the PAN-OS device is a Panorama, vsys should be specified, otherwise the default is null, and zone-name assignment will fail.

• PAN-OS connectivity should be specified using provider or the classic PAN-OS connectivity params (ip_address, username, password, api_key, and port). If both are present, then the classic params are ignored.

Examples

# Create ae1 interface.
- name: create ae1 interface with IP in untrust zone
  paloaltonetworks.panos.panos_aggregate_interface:
    provider: '{{ provider }}'
    if_name: "ae1"
    ip: '[ "192.168.0.1" ]'
    zone_name: 'untrust'

Authors

• Heiko Burghardt (@odysseus107)

Collection links

Issue Tracker Homepage Repository (Sources)