paloaltonetworks.panos.panos_lic module – apply authcode to a device/instance
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_lic
.
New in paloaltonetworks.panos 1.0.0
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 |
Comments |
---|---|
Deprecated Use provider to specify PAN-OS connectivity instead. The API key to use instead of generating it using username / password. |
|
authcode to be applied. If this is not given, then “request license fetch” is performed instead. |
|
Whether to apply authcode even if device is already licensed / has a serial number. For example, set the force option to “true” when adding extra subscription or features licenses to a device which already has a serial number. Choices: |
|
Deprecated Use provider to specify PAN-OS connectivity instead. The IP address or hostname of the PAN-OS device being configured. |
|
Deprecated Use provider to specify PAN-OS connectivity instead. The password to use for authentication. This is ignored if api_key is specified. |
|
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` |
|
A dict object containing connection details. |
|
The API key to use instead of generating it using username / password. |
|
The IP address or hostname of the PAN-OS device being configured. |
|
The password to use for authentication. This is ignored if api_key is specified. |
|
The port number to connect to the PAN-OS device on. Default: :ansible-option-default:`443` |
|
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. |
|
The username to use for authentication. This is ignored if api_key is specified. Default: :ansible-option-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. Default: :ansible-option-default:`"admin"` |
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
paloaltonetworks.panos.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 |
Description |
---|---|
List of PAN-OS licenses (as dicts) as a result of this module’s execution. Returned: when not using auth_code |
|
PAN-OS serial number when this module began execution. Returned: success |