mirror of https://github.com/ansible/ansible.git
PanOS module for admin password change using PanOS API as the transport (#2930)
* PanOS module that allows admin password change. * fixed a typo * empty __init__.py * added require ansible Python extension .py * added version string * added return docstring * changed version to 2.2 * - changes to the format and module as requested by @privateip * changed version back to 2.2 as 2.3 was failing automated tests * Revert "changed version back to 2.2 as 2.3 was failing automated tests" reverting version info This reverts commit 71d520f3b4b69eb017c2b9f287a74cb77fae9d1c.pull/18777/head
parent
badce91e80
commit
3c06e2585a
@ -0,0 +1,200 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Ansible module to manage PaloAltoNetworks Firewall
|
||||
# (c) 2016, techbizdev <techbizdev@paloaltonetworks.com>
|
||||
#
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: panos_admin
|
||||
short_description: Add or modify PAN-OS user accounts password.
|
||||
description:
|
||||
- PanOS module that allows changes to the user account passwords by doing
|
||||
API calls to the Firewall using pan-api as the protocol.
|
||||
author: "Luigi Mori (@jtschichold), Ivan Bojer (@ivanbojer)"
|
||||
version_added: "2.3"
|
||||
requirements:
|
||||
- pan-python
|
||||
options:
|
||||
ip_address:
|
||||
description:
|
||||
- IP address (or hostname) of PAN-OS device
|
||||
required: true
|
||||
password:
|
||||
description:
|
||||
- password for authentication
|
||||
required: true
|
||||
username:
|
||||
description:
|
||||
- username for authentication
|
||||
required: false
|
||||
default: "admin"
|
||||
admin_username:
|
||||
description:
|
||||
- username for admin user
|
||||
required: false
|
||||
default: "admin"
|
||||
admin_password:
|
||||
description:
|
||||
- password for admin user
|
||||
required: true
|
||||
role:
|
||||
description:
|
||||
- role for admin user
|
||||
required: false
|
||||
default: null
|
||||
commit:
|
||||
description:
|
||||
- commit if changed
|
||||
required: false
|
||||
default: true
|
||||
'''
|
||||
|
||||
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 = '''
|
||||
status:
|
||||
description: success status
|
||||
returned: success
|
||||
type: string
|
||||
sample: "okey dokey"
|
||||
'''
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
try:
|
||||
import pan.xapi
|
||||
HAS_LIB = True
|
||||
except ImportError:
|
||||
HAS_LIB = False
|
||||
|
||||
_ADMIN_XPATH = "/config/mgt-config/users/entry[@name='%s']"
|
||||
|
||||
|
||||
def admin_exists(xapi, admin_username):
|
||||
xapi.get(_ADMIN_XPATH % admin_username)
|
||||
e = xapi.element_root.find('.//entry')
|
||||
return e
|
||||
|
||||
|
||||
def admin_set(xapi, module, admin_username, admin_password, role):
|
||||
if admin_password is not None:
|
||||
xapi.op(cmd='request password-hash password "%s"' % admin_password,
|
||||
cmd_xml=True)
|
||||
r = xapi.element_root
|
||||
phash = r.find('.//phash').text
|
||||
if role is not None:
|
||||
rbval = "yes"
|
||||
if role != "superuser" and role != 'superreader':
|
||||
rbval = ""
|
||||
|
||||
ea = admin_exists(xapi, admin_username)
|
||||
if ea is not None:
|
||||
# user exists
|
||||
changed = False
|
||||
|
||||
if role is not None:
|
||||
rb = ea.find('.//role-based')
|
||||
if rb is not None:
|
||||
if rb[0].tag != role:
|
||||
changed = True
|
||||
xpath = _ADMIN_XPATH % admin_username
|
||||
xpath += '/permissions/role-based/%s' % rb[0].tag
|
||||
xapi.delete(xpath=xpath)
|
||||
|
||||
xpath = _ADMIN_XPATH % admin_username
|
||||
xpath += '/permissions/role-based'
|
||||
xapi.set(xpath=xpath,
|
||||
element='<%s>%s</%s>' % (role, rbval, role))
|
||||
|
||||
if admin_password is not None:
|
||||
xapi.edit(xpath=_ADMIN_XPATH % admin_username+'/phash',
|
||||
element='<phash>%s</phash>' % phash)
|
||||
changed = True
|
||||
|
||||
return changed
|
||||
|
||||
# setup the non encrypted part of the monitor
|
||||
exml = []
|
||||
|
||||
exml.append('<phash>%s</phash>' % phash)
|
||||
exml.append('<permissions><role-based><%s>%s</%s>'
|
||||
'</role-based></permissions>' % (role, rbval, role))
|
||||
|
||||
exml = ''.join(exml)
|
||||
# module.fail_json(msg=exml)
|
||||
|
||||
xapi.set(xpath=_ADMIN_XPATH % admin_username, element=exml)
|
||||
|
||||
return True
|
||||
|
||||
|
||||
def main():
|
||||
argument_spec = dict(
|
||||
ip_address=dict(),
|
||||
password=dict(no_log=True),
|
||||
username=dict(default='admin'),
|
||||
admin_username=dict(default='admin'),
|
||||
admin_password=dict(no_log=True),
|
||||
role=dict(),
|
||||
commit=dict(type='bool', default=True)
|
||||
)
|
||||
module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=False)
|
||||
|
||||
if not HAS_LIB:
|
||||
module.fail_json(msg='pan-python required for this module')
|
||||
|
||||
ip_address = module.params["ip_address"]
|
||||
if not ip_address:
|
||||
module.fail_json(msg="ip_address should be specified")
|
||||
password = module.params["password"]
|
||||
if not password:
|
||||
module.fail_json(msg="password is required")
|
||||
username = module.params['username']
|
||||
|
||||
xapi = pan.xapi.PanXapi(
|
||||
hostname=ip_address,
|
||||
api_username=username,
|
||||
api_password=password
|
||||
)
|
||||
|
||||
admin_username = module.params['admin_username']
|
||||
if admin_username is None:
|
||||
module.fail_json(msg="admin_username is required")
|
||||
admin_password = module.params['admin_password']
|
||||
role = module.params['role']
|
||||
commit = module.params['commit']
|
||||
|
||||
changed = admin_set(xapi, module, admin_username, admin_password, role)
|
||||
|
||||
if changed and commit:
|
||||
xapi.commit(cmd="<commit></commit>", sync=True, interval=1)
|
||||
|
||||
module.exit_json(changed=changed, msg="okey dokey")
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
Loading…
Reference in New Issue