panos_vlan_interface – configure VLAN interfaces

New in version 2.8.

Synopsis

  • Configure VLAN interfaces.

Requirements

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

  • pan-python

  • pandevice

Parameters

Parameter Choices/Defaults Comments
adjust_tcp_mss
boolean
    Choices:
  • no
  • yes
Adjust TCP MSS for layer3 interface.
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
-
Interface comment.
create_dhcp_default_route
boolean
    Choices:
  • no
  • yes
Whether or not to add default route with router learned via DHCP.
dhcp_default_route_metric
integer
Metric for the DHCP default route.
enable_dhcp
boolean
    Choices:
  • no
  • yes
Enable DHCP on this interface.
ip
list
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
    Choices:
  • no
  • yes
Enable IPv6.
ipv6_mss_adjust
integer
(7.1+) TCP MSS adjustment for IPv6.
management_profile
-
Interface management profile name.
mtu
integer
MTU for layer3 interface.
name
- / required
Name of the interface to configure.
This should be in the format "vlan.<some_number>".
netflow_profile
-
Netflow profile for layer3 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
Default:
443
Deprecated
Use provider to specify PAN-OS connectivity instead.
The port number to connect to the PAN-OS device on.
provider
-
added in 2.8
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
Default:
443
The port number to connect to the PAN-OS device on.
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
Default:
admin
The username to use for authentication. This is ignored if api_key is specified.
state
string
    Choices:
  • present ←
  • absent
The state.
template
string
(Panorama only) The template this operation should target. This param is required if the PAN-OS device is Panorama.
username
string
Default:
admin
Deprecated
Use provider to specify PAN-OS connectivity instead.
The username to use for authentication. This is ignored if api_key is specified.
vlan_name
-
The VLAN to put this interface in.
If the VLAN does not exist it is created.
vr_name
-
Name of the virtual router
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
-
Name of the zone for the interface.
If the zone does not exist it is created.
If the zone already exists it should be mode=layer3.

Notes

Note

  • Checkmode is supported.

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

  • 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 vlan.2 as DHCP
- name: enable DHCP client on ethernet1/1 in zone public
  panos_vlan_interface:
    provider: '{{ provider }}'
    name: "vlan.2"
    zone_name: "public"
    enable_dhcp: true
    create_default_route: true

# Set vlan.7 with a static IP
- name: Configure vlan.7
  panos_vlan_interface:
    provider: '{{ provider }}'
    name: "vlan.7"
    ip: ["10.1.1.1/24"]
    management_profile: "allow ping"
    vlan_name: "dmz"
    zone_name: "L3-untrust"
    vr_name: "default"

Status

Authors

  • Garfield Lee Freeman (@shinmog)