paloaltonetworks.panos.panos_l2_subinterface module – Manage layer2 subinterface

Note

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

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

New in paloaltonetworks.panos 1.0.0

Synopsis

  • Manage a layer2 subinterface.

Requirements

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

  • pan-python

  • pandevice >= 0.8.0

Parameters

Parameter

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

string

Interface comment.

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_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

lldp_profile

string

Reference to an LLDP profile

name

string

Name of the interface to configure.

netflow_profile

string

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

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

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"`

vlan_name

string

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

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.

  • 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
  paloaltonetworks.panos.panos_l2_subinterface:
    provider: '{{ provider }}'
    name: "ethernet1/1.5"
    tag: 5
    zone_name: "sales"
    vlan_name: "myVlan"

Authors

  • Garfield Lee Freeman (@shinmog)