paloaltonetworks.panos.panos_management_profile module – Manage interface management profiles.

Note

This module is part of the paloaltonetworks.panos collection (version 3.1.1).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install paloaltonetworks.panos. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: paloaltonetworks.panos.panos_management_profile.

New in paloaltonetworks.panos 1.0.0

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

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

Deprecated

Please use paloaltonetworks.panos.panos_commit_firewall, paloaltonetworks.panos.panos_commit_panorama, paloaltonetworks.panos.panos_commit_push instead.

Commit changes after creating object. If ip_address is a Panorama device, and device_group or template are also set, perform a commit to Panorama and a commit-all to the device group/template.

Choices:

  • false

  • true

gathered_filter

string

When state=gathered.

An advanced filtering option to filter results returned from PAN-OS.

Refer to the guide discussing gathered_filter for more information.

http

boolean

Enable http

Choices:

  • false

  • true

http_ocsp

boolean

Enable http-ocsp

Choices:

  • false

  • true

https

boolean

Enable https

Choices:

  • false

  • true

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

string

The management profile name.

panorama_template

string

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 / elements=string

The list of permitted IP addresses

ping

boolean

Enable ping

Choices:

  • false

  • true

port

integer

Deprecated

Use provider to specify PAN-OS connectivity instead.

The port number to connect to the PAN-OS device on.

Default: 443

provider

dictionary

added in paloaltonetworks.panos 1.0.0

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

The port number to connect to the PAN-OS device on.

Default: 443

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

The username to use for authentication. This is ignored if api_key is specified.

Default: "admin"

response_pages

boolean

Enable response pages

Choices:

  • false

  • true

snmp

boolean

Enable snmp

Choices:

  • false

  • true

ssh

boolean

Enable ssh

Choices:

  • false

  • true

state

string

The state.

Choices:

  • "present" ← (default)

  • "absent"

  • "replaced"

  • "merged"

  • "deleted"

  • "gathered"

telnet

boolean

Enable telnet

Choices:

  • false

  • true

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

Enable userid service

Choices:

  • false

  • true

userid_syslog_listener_ssl

boolean

Enable userid syslog listener ssl

Choices:

  • false

  • true

userid_syslog_listener_udp

boolean

Enable userid syslog listener udp

Choices:

  • false

  • true

username

string

Deprecated

Use provider to specify PAN-OS connectivity instead.

The username to use for authentication. This is ignored if api_key is specified.

Default: "admin"

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
  paloaltonetworks.panos.panos_management_profile:
    provider: '{{ provider }}'
    name: 'foo'
    ping: true
    ssh: true

- name: make sure mngt profile bar does not exist
  paloaltonetworks.panos.panos_management_profile:
    provider: '{{ provider }}'
    name: 'bar'
    state: 'absent'

Authors

  • Garfield Lee Freeman (@shinmog)