panos_l2_subinterface – configure layer2 subinterface¶
New in version 2.8.
Synopsis¶
NOTE: The modules in this role are deprecated in favour of the modules in the collection https://paloaltonetworks.github.io/pan-os-ansible
Configure a layer2 subinterface.
Requirements¶
The below requirements are needed on the host that executes this module.
pan-python
pandevice >= 0.8.0
Parameters¶
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
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.
|
||
ip_address
string
|
Deprecated
Use provider to specify PAN-OS connectivity instead.
The IP address or hostname of the PAN-OS device being configured.
|
||
lldp_enabled
boolean
|
|
Enable LLDP
|
|
lldp_profile
-
|
Reference to an LLDP profile
|
||
name
-
/ required
|
Name of the interface to configure.
|
||
netflow_profile
-
|
Reference to a netflow profile.
|
||
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
|
|
The state.
|
|
tag
integer
/ required
|
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
|
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.
|
||
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.
|
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.
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
- name: ethernet1/1.5 in zone sales
panos_l2_subinterface:
provider: '{{ provider }}'
name: "ethernet1/1.5"
tag: 5
zone_name: "sales"
vlan_name: "myVlan"
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community.