paloaltonetworks.panos.panos_ipv6_address module – Manage IPv6 addresses on an interface.

Note

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

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

New in paloaltonetworks.panos 1.1.0

Synopsis

  • Manage IPv6 addresses on an interface.

Requirements

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

  • pan-python

  • pandevice >= 0.14.0

Parameters

Parameter

Comments

address

string

IPv6 address.

advertise_enabled

boolean

anycast

boolean

api_key

string

Deprecated

Use provider to specify PAN-OS connectivity instead.


The API key to use instead of generating it using username / password.

auto_config_flag

boolean

Set the auto address configuration flag.

Choices:

enable_on_interface

boolean

Enable address on interface.

Choices:

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.

iface_name

string / required

The parent interface that this IPv6 address is attached to.

ip_address

string

Deprecated

Use provider to specify PAN-OS connectivity instead.


The IP address or hostname of the PAN-OS device being configured.

boolean

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`

preferred_lifetime

integer

Preferred lifetime.

Default: :ansible-option-default:`604800`

prefix

boolean

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

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

valid_lifetime

integer

Valid lifetime.

Default: :ansible-option-default:`2592000`

Notes

Note

  • Panorama is supported.

  • Checkmode is supported.

  • 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

# Have an IPv6 address on ethernet1/6.2
- name: Assert the given IPv6 address
  paloaltonetworks.panos.panos_ipv6_address:
    provider: '{{ provider }}'
    iface_name: 'ethernet1/6.2'
    address: '2001:db8:123:1::1'

Authors

  • Garfield Lee Freeman (@shinmog)