paloaltonetworks.panos.panos_aggregate_interface (2.19.1) — module

Manage aggregate network interfaces

| "added in version" 1.0.0 of paloaltonetworks.panos"

Authors: Heiko Burghardt (@odysseus107)

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 aggregate network interfaces on PanOS


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Create ae1 interface.
- name: create ae1 interface with IP in untrust zone
  paloaltonetworks.panos.panos_aggregate_interface:
    provider: '{{ provider }}'
    if_name: "ae1"
    ip: '[ "192.168.0.1" ]'
    zone_name: 'untrust'

Inputs

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

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

mode:
    choices:
    - layer3
    - layer2
    - virtual-wire
    - ha
    default: layer3
    description:
    - The interface mode.
    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

commit:
    description:
    - B(Deprecated)
    - Please use M(paloaltonetworks.panos.panos_commit_firewall), M(paloaltonetworks.panos.panos_commit_panorama),
      M(paloaltonetworks.panos.panos_commit_push) instead.
    - HORIZONTALLINE
    - Commit changes after creating object.  If I(ip_address) is a Panorama device, and
      I(device_group) or I(template) are also set, perform a commit to Panorama and a
      commit-all to the device group/template.
    type: bool

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

if_name:
    description:
    - Name of the interface to configure.
    type: str

vr_name:
    default: default
    description:
    - The virtual router to associate with this interface.
    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

lacp_mode:
    choices:
    - active
    - passive
    description:
    - Set LACP mode
    type: str

lacp_rate:
    choices:
    - fast
    - slow
    description:
    - Set LACP transmission rate
    type: str

zone_name:
    description:
    - The zone to put this interface into.
    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

lacp_enable:
    description:
    - Enable LACP on this interface
    type: bool

ipv6_enabled:
    description:
    - Enable IPv6.
    type: bool

lldp_enabled:
    description:
    - (Layer2) Enable LLDP
    type: bool

lldp_profile:
    description:
    - (Layer2) Reference to an lldp profile
    type: str

adjust_tcp_mss:
    description:
    - Adjust TCP MSS.
    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 aggregate interface.
    type: str

lacp_fast_failover:
    description:
    - Enable LACP fast failover
    type: bool

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

create_dhcp_default_route:
    description:
    - Create default route pointing to default gateway provided by server
    type: bool

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

lacp_passive_pre_negotiation:
    description:
    - Enable LACP passive pre-negotiation
    type: bool