paloaltonetworks.panos.panos_vlan_interface (2.19.1) — module

Install collection

Install with ansible-galaxy collection install paloaltonetworks.panos:==2.19.1

Add to requirements.yml

  collections:
    - name: paloaltonetworks.panos
      version: 2.19.1

Description

Manage VLAN interfaces.

Requirements

• pan-python
• pandevice

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Create vlan.2 as DHCP
- name: enable DHCP client on ethernet1/1 in zone public
  paloaltonetworks.panos.panos_vlan_interface:
    provider: '{{ provider }}'
    name: "vlan.2"
    zone_name: "public"
    enable_dhcp: true
    create_default_route: true

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Set vlan.7 with a static IP
- name: Configure vlan.7
  paloaltonetworks.panos.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"

Inputs

    
ip:
    description:
    - List of static IP addresses.
    elements: str
    type: list

mtu:
    description:
    - MTU for layer3 interface.
    type: int

name:
    description:
    - Name of the interface to configure.
    - This should be in the format "vlan.<some_number>".
    type: str

port:
    default: 443
    description:
    - B(Deprecated)
    - Use I(provider) to specify PAN-OS connectivity instead.
    - HORIZONTALLINE
    - The port number to connect to the PAN-OS device on.
    type: int

vsys:
    description:
    - 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.
    type: str

state:
    choices:
    - present
    - absent
    - replaced
    - merged
    - deleted
    - gathered
    default: present
    description:
    - The state.
    type: str

api_key:
    description:
    - B(Deprecated)
    - Use I(provider) to specify PAN-OS connectivity instead.
    - HORIZONTALLINE
    - The API key to use instead of generating it using I(username) / I(password).
    type: str

comment:
    description:
    - Interface comment.
    type: str

vr_name:
    description:
    - Name of the virtual router
    type: str

password:
    description:
    - B(Deprecated)
    - Use I(provider) to specify PAN-OS connectivity instead.
    - HORIZONTALLINE
    - The password to use for authentication.  This is ignored if I(api_key) is specified.
    type: str

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      api_key:
        description:
        - The API key to use instead of generating it using I(username) / I(password).
        type: str
      ip_address:
        description:
        - The IP address or hostname of the PAN-OS device being configured.
        type: str
      password:
        description:
        - The password to use for authentication.  This is ignored if I(api_key) is specified.
        type: str
      port:
        default: 443
        description:
        - The port number to connect to the PAN-OS device on.
        type: int
      serial_number:
        description:
        - The serial number of a firewall to use for targeted commands. If I(ip_address)
          is not a Panorama PAN-OS device, then this param is ignored.
        type: str
      username:
        default: admin
        description:
        - The username to use for authentication.  This is ignored if I(api_key) is specified.
        type: str
    type: dict
    version_added: 1.0.0
    version_added_collection: paloaltonetworks.panos

template:
    description:
    - (Panorama only) The template this operation should target.  This param is required
      if the PAN-OS device is Panorama.
    type: str

username:
    default: admin
    description:
    - B(Deprecated)
    - Use I(provider) to specify PAN-OS connectivity instead.
    - HORIZONTALLINE
    - The username to use for authentication.  This is ignored if I(api_key) is specified.
    type: str

vlan_name:
    description:
    - The VLAN to put this interface in.
    - If the VLAN does not exist it is created.
    type: str

zone_name:
    description:
    - Name of the zone for the interface.
    - If the zone does not exist it is created.
    - If the zone already exists it should be I(mode=layer3).
    type: str

ip_address:
    description:
    - B(Deprecated)
    - Use I(provider) to specify PAN-OS connectivity instead.
    - HORIZONTALLINE
    - The IP address or hostname of the PAN-OS device being configured.
    type: str

enable_dhcp:
    description:
    - Enable DHCP on this interface.
    type: bool

ipv6_enabled:
    description:
    - Enable IPv6.
    type: bool

adjust_tcp_mss:
    description:
    - Adjust TCP MSS for layer3 interface.
    type: bool

gathered_filter:
    description:
    - When I(state=gathered).
    - An advanced filtering option to filter results returned from PAN-OS.
    - Refer to the guide discussing I(gathered_filter) for more information.
    type: str

ipv4_mss_adjust:
    description:
    - (7.1+) TCP MSS adjustment for IPv4.
    type: int

ipv6_mss_adjust:
    description:
    - (7.1+) TCP MSS adjustment for IPv6.
    type: int

netflow_profile:
    description:
    - Netflow profile for layer3 interface.
    type: str

management_profile:
    description:
    - Interface management profile name.
    type: str

create_dhcp_default_route:
    description:
    - Whether or not to add default route with router learned via DHCP.
    type: bool

dhcp_default_route_metric:
    description:
    - Metric for the DHCP default route.
    type: int