panos_mgtconfig – Module used to configure some of the device management¶
New in version 2.4.
Synopsis¶
NOTE: The modules in this role are deprecated in favour of the modules in the collection https://paloaltonetworks.github.io/pan-os-ansible
Configure management settings of device. Not all configuration options are configurable at this time.
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.
|
||
commit
boolean
|
|
Commit configuration if changed.
|
|
devicegroup
-
|
Removed
|
||
dns_server_primary
-
|
IP address of primary DNS server.
|
||
dns_server_secondary
-
|
IP address of secondary DNS server.
|
||
domain
-
|
The domain of the device
|
||
hostname
-
|
The hostname of the device.
|
||
ip_address
string
|
Deprecated
Use provider to specify PAN-OS connectivity instead.
The IP address or hostname of the PAN-OS device being configured.
|
||
login_banner
-
|
Login banner text.
|
||
ntp_server_primary
-
|
IP address (or hostname) of primary NTP server.
|
||
ntp_server_secondary
-
|
IP address (or hostname) of secondary NTP server.
|
||
panorama_primary
-
|
IP address (or hostname) of primary Panorama server.
|
||
panorama_secondary
-
|
IP address (or hostname) of secondary Panorama server.
|
||
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.
|
|
timezone
-
|
Device timezone.
|
||
update_server
-
|
IP or hostname of the update server.
|
||
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.
|
|
verify_update_server
boolean
|
|
Verify the identify of the update server.
|
Notes¶
Note
Checkmode is 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: set dns and panorama
panos_mgtconfig:
provider: '{{ provider }}'
dns_server_primary: "1.1.1.1"
dns_server_secondary: "1.1.1.2"
panorama_primary: "1.1.1.3"
panorama_secondary: "1.1.1.4"
ntp_server_primary: "1.1.1.5"
ntp_server_secondary: "1.1.1.6"
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community.