panos_http_profile_param – Manage HTTP params for a HTTP profile

New in version 2.8.

Synopsis

  • NOTE: The modules in this role are deprecated in favour of the modules in the collection https://paloaltonetworks.github.io/pan-os-ansible

  • Manages HTTP params for a HTTP profile.

Requirements

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

  • pan-python

  • pandevice >= 0.11.1

  • PAN-OS >= 8.0

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.
device_group
string
Default:
"shared"
(Panorama only) The device group the operation should target.
http_profile
- / required
Name of the http server profile.
ip_address
string
Deprecated
Use provider to specify PAN-OS connectivity instead.
The IP address or hostname of the PAN-OS device being configured.
log_type
- / required
    Choices:
  • config
  • system
  • threat
  • traffic
  • hip match
  • url
  • data
  • wildfire
  • tunnel
  • user id
  • gtp
  • auth
  • sctp
  • iptag
The log type for this parameter.
param
- / required
The param 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.
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.
value
-
The value to assign the param.
vsys
string
Default:
"shared"
The vsys this object belongs to.

Notes

Note

  • Panorama is supported.

  • Check mode 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: Add a param to the config log type
  panos_http_profile_param:
    provider: '{{ provider }}'
    http_profile: 'my-profile'
    log_type: 'user id'
    param: 'serial'
    value: '$serial'

Status

Authors

  • Garfield Lee Freeman (@shinmog)