panos_lic – apply authcode to a device/instance

New in version 2.3.

Synopsis

  • Apply an authcode to a device.

  • The authcode should have been previously registered on the Palo Alto Networks support portal.

  • The device should have Internet access.

Requirements

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

  • pan-python

  • pandevice

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.
auth_code
-
authcode to be applied.
If this is not given, then "request license fetch" is performed instead.
force
boolean
    Choices:
  • no ←
  • yes
Whether to apply authcode even if device is already licensed / has a serial number.
ip_address
string
Deprecated
Use provider to specify PAN-OS connectivity instead.

The IP address or hostname of the PAN-OS device being configured.
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.
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.

Notes

Note

  • Panorama is supported

  • Checkmode is not 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

- name: Activate my authcode
  panos_lic:
    provider: '{{ provider }}'
    auth_code: "IBADCODE"
  register: result

- debug:
    msg: 'Serial number is {{ result.serialnumber }}'

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
licenses
list
when not using auth_code
List of PAN-OS licenses (as dicts) as a result of this module's execution.

serialnumber
string
success
PAN-OS serial number when this module began execution.

Sample:
973080716


Status

Authors

  • Luigi Mori (@jtschichold), Ivan Bojer (@ivanbojer)