panos_management_profile – Manage interface management profiles

New in version 2.6.

Synopsis

  • This module will allow you to manage interface management profiles on PAN-OS.

Requirements

The below requirements are needed on the host that executes this module.

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
    Choices:
  • no
  • yes ←
Perform a commit if a change is made.
http
boolean
    Choices:
  • no
  • yes
Enable http
http_ocsp
boolean
    Choices:
  • no
  • yes
Enable http-ocsp
https
boolean
    Choices:
  • no
  • yes
Enable https
ip_address
string
Deprecated
Use provider to specify PAN-OS connectivity instead.

The IP address or hostname of the PAN-OS device being configured.
name
- / required
The management profile name.
panorama_template
-
Deprecated
Use template instead.

(Panorama only) The template name.
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.
permitted_ip
list
The list of permitted IP addresses
ping
boolean
    Choices:
  • no
  • yes
Enable ping
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.
response_pages
boolean
    Choices:
  • no
  • yes
Enable response pages
snmp
boolean
    Choices:
  • no
  • yes
Enable snmp
ssh
boolean
    Choices:
  • no
  • yes
Enable ssh
state
string
    Choices:
  • present ←
  • absent
The state.
telnet
boolean
    Choices:
  • no
  • yes
Enable telnet
template
string
(Panorama only) The template this operation should target. Mutually exclusive with template_stack.
template_stack
string
(Panorama only) The template stack this operation should target. Mutually exclusive with template.
userid_service
boolean
    Choices:
  • no
  • yes
Enable userid service
userid_syslog_listener_ssl
boolean
    Choices:
  • no
  • yes
Enable userid syslog listener ssl
userid_syslog_listener_udp
boolean
    Choices:
  • no
  • yes
Enable userid syslog listener udp
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 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.

  • If the PAN-OS to be configured is Panorama, either template or template_stack must be specified.

Examples

- name: ensure mngt profile foo exists and allows ping and ssh and commit
  panos_management_profile:
    provider: '{{ provider }}'
    name: 'foo'
    ping: true
    ssh: true

- name: make sure mngt profile bar does not exist without doing a commit
  panos_management_profile:
    provider: '{{ provider }}'
    name: 'bar'
    state: 'absent'
    commit: false

Status

Authors

  • Garfield Lee Freeman (@shinmog)