On this page
community.network.panos_admin – Add or modify PAN-OS user accounts password.
Note
This plugin is part of the community.network collection (version 1.3.0).
To install it use: ansible-galaxy collection install community.network
.
To use it in a playbook, specify: community.network.panos_admin
.
DEPRECATED
- Removed in
-
version 2.0.0
- Why
-
Consolidating code base.
- Alternative
-
Use https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks instead.
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
The below requirements are needed on the host that executes this module.
- pan-python
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
admin_password
string / required
|
password for admin user
|
|
admin_username
string
|
Default:
"admin"
|
username for admin user
|
commit
boolean
|
|
commit if changed
|
ip_address
string / required
|
IP address (or hostname) of PAN-OS device.
|
|
password
string / required
|
Password for authentication.
|
|
role
string
|
role for admin user
|
|
username
string
|
Default:
"admin"
|
Username for authentication.
|
Examples
# Set the password of user admin to "badpassword"
# Doesn't commit the candidate config
- name: Set admin password
community.network.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.0.0. [deprecated]
- For more information see DEPRECATED.
Authors
- Luigi Mori (@jtschichold), Ivan Bojer (@ivanbojer)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/panos_admin_module.html