panos_op – execute arbitrary OP commands on PANW devices (e.g. show interface all)¶
New in version 2.5.
Synopsis¶
This module will allow user to pass and execute any supported OP command on the PANW device.
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
pandevice can be obtained from PyPI https://pypi.python.org/pypi/pandevice
Parameters¶
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
api_key
string
|
Deprecated
Use provider to specify PAN-OS connectivity instead.
The API key to use instead of generating it using username / password.
|
||
cmd
-
/ required
|
The OP command to be performed.
|
||
cmd_is_xml
boolean
|
|
The cmd is already given in XML format, so don't convert it.
|
|
ip_address
string
|
Deprecated
Use provider to specify PAN-OS connectivity instead.
The IP address or hostname of the PAN-OS device being configured.
|
||
password
string
|
Deprecated
Use provider to specify PAN-OS connectivity instead.
The password to use for authentication. This is ignored if api_key is specified.
|
||
port
integer
|
Default: 443
|
Deprecated
Use provider to specify PAN-OS connectivity instead.
The port number to connect to the PAN-OS device on.
|
|
provider
-
added in 2.8 |
A dict object containing connection details.
|
||
api_key
string
|
The API key to use instead of generating it using username / password.
|
||
ip_address
string
|
The IP address or hostname of the PAN-OS device being configured.
|
||
password
string
|
The password to use for authentication. This is ignored if api_key is specified.
|
||
port
integer
|
Default: 443
|
The port number to connect to the PAN-OS device on.
|
|
serial_number
string
|
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.
|
||
username
string
|
Default: admin
|
The username to use for authentication. This is ignored if api_key is specified.
|
|
username
string
|
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.
|
Notes¶
Note
Checkmode is NOT supported.
Panorama is 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: show list of all interfaces
panos_op:
provider: '{{ provider }}'
cmd: 'show interfaces all'
- name: show system info
panos_op:
provider: '{{ provider }}'
cmd: 'show system info'
- name: show system info as XML command
panos_op:
provider: '{{ provider }}'
cmd: '<show><system><info/></system></show>'
cmd_is_xml: true
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
stdout
string
|
success |
output of the given OP command as JSON formatted string
Sample:
{system: {app-release-date: 2017/05/01 15:09:12}}
|
stdout_xml
string
|
success |
output of the given OP command as an XML formatted string
Sample:
<response status=success><result><system><hostname>fw2</hostname>
|
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community.
Authors¶
Ivan Bojer (@ivanbojer)