W3cubDocs

/Ansible

panos_admin - Add or modify PAN-OS user accounts password.

New in version 2.3.

Synopsis

  • PanOS module that allows changes to the user account passwords by doing API calls to the Firewall using pan-api as the protocol.

Requirements (on host that executes module)

  • pan-python

Options

parameter required default choices comments
admin_password
yes
password for admin user
admin_username
no admin
username for admin user
commit
no True
commit if changed
ip_address
yes
IP address (or hostname) of PAN-OS device
password
yes
password for authentication
role
no
role for admin user
username
no admin
username for authentication

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 Return Values, the following are the fields unique to this module:

name description returned type sample
status
success status
success string okey dokey

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/panos_admin_module.html