panos_admin – Add or modify PAN-OS user accounts password¶

New in version 2.3.

DEPRECATED
Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

DEPRECATED ¶

Removed in Ansible: version: 2.12
Why: This module is a subset of panos_administrator’s functionality.
Alternative: Use panos_administrator instead.

Synopsis ¶

NOTE: The modules in this role are deprecated in favour of the modules in the collection https://paloaltonetworks.github.io/pan-os-ansible
PanOS module that allows changes to the user account passwords by doing API calls to the Firewall using pan-api as the protocol.

Requirements ¶

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

pan-python can be obtained from PyPI https://pypi.python.org/pypi/pan-python

Parameters ¶

Parameter	Choices/Defaults	Comments
admin_password - / required		New password for admin_username user
admin_username -	Default: "admin"	Username that needs password change.
api_key -		API key that can be used instead of username/password credentials.
commit -	Default: "yes"	Commit configuration if changed.
ip_address - / required		IP address (or hostname) of PAN-OS device being configured.
password - / required		Password credentials to use for auth unless api_key is set.
port -	Default: 443	Port used to connect to the PAN-OS device being configured.
role -	Default: null	role for admin user
username -	Default: "admin"	Username credentials to use for auth unless api_key is set.

Notes ¶

Note

Checkmode is not supported.

Examples ¶

# Set the password of user admin to "badpassword"
# Doesn't commit the candidate config
  - name: set admin password
    panos_admin:
      ip_address: "192.168.1.1"
      password: "admin"
      admin_username: admin
      admin_password: "badpassword"
      commit: False

Return Values ¶

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

Key	Returned	Description
status string	success	success status Sample: okey dokey

Status ¶

This module will be removed in version 2.12. [deprecated]
For more information see DEPRECATED.

Authors¶

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