paloaltonetworks.panos.panos_l3_subinterface module – Manage layer3 subinterface

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_l3_subinterface.

New in paloaltonetworks.panos 1.0.0

Synopsis

• Manage a layer3 subinterface.

Requirements

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

• pan-python

• pandevice >= 0.8.0

Parameters

Parameter	Comments
adjust_tcp_mss boolean	Adjust TCP MSS for layer3 interface. 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.
create_default_route boolean	Whether or not to add default route with router learned via DHCP. Choices: :ansible-option-choices-entry-default:`false` ← (default) :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-default:`true` ← (default)
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.
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.
management_profile string	Interface management profile name.
mtu integer	MTU for layer3 interface.
name string	Name of the interface to configure.
netflow_profile string	Netflow profile for layer3 interface.
parent_interface string	Name of the parent 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"`
tag integer	Tag (vlan id) for the interface
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	Virtual router to add this interface to. 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	Name of the zone for the interface. If the zone does not exist it is created.

Notes

Note

• Panorama is supported.

• Checkmode is supported.

• If the PAN-OS device is a firewall and vsys is not specified, then the vsys will default to vsys=vsys1.

• 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 ethernet1/1.5 as DHCP.
- name: enable DHCP client on ethernet1/1.5 in zone public
  paloaltonetworks.panos.panos_l3_subinterface:
    provider: '{{ provider }}'
    name: "ethernet1/1.5"
    tag: 1
    create_default_route: true
    zone_name: "public"

# Update ethernet1/2.7 with a static IP address in zone dmz.
- name: ethernet1/2.7 as static in zone dmz
  paloaltonetworks.panos.panos_l3_subinterface:
    provider: '{{ provider }}'
    name: "ethernet1/2.7"
    tag: 7
    enable_dhcp: false
    ip: ["10.1.1.1/24"]
    zone_name: "dmz"

Authors

• Garfield Lee Freeman (@shinmog)

Collection links

Issue Tracker Homepage Repository (Sources)