paloaltonetworks.panos.panos_http_profile_header module – Manage HTTP headers for a HTTP profile.

Note

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

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_http_profile_header.

New in paloaltonetworks.panos 1.0.0

Synopsis

• Manages HTTP headers 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	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	(Panorama only) The device group the operation should target. Default: :ansible-option-default:`"shared"`
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.
header string	The header name.
http_profile string / 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 string / required	The log type for this header. Choices: :ansible-option-choices-entry:`"auth"` :ansible-option-choices-entry:`"config"` :ansible-option-choices-entry:`"data"` :ansible-option-choices-entry:`"decryption"` :ansible-option-choices-entry:`"globalprotect"` :ansible-option-choices-entry:`"gtp"` :ansible-option-choices-entry:`"hip match"` :ansible-option-choices-entry:`"iptag"` :ansible-option-choices-entry:`"sctp"` :ansible-option-choices-entry:`"system"` :ansible-option-choices-entry:`"threat"` :ansible-option-choices-entry:`"traffic"` :ansible-option-choices-entry:`"tunnel"` :ansible-option-choices-entry:`"url"` :ansible-option-choices-entry:`"user id"` :ansible-option-choices-entry:`"wildfire"`
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	Deprecated Use provider to specify PAN-OS connectivity instead. The port number to connect to the PAN-OS device on. Default: :ansible-option-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: :ansible-option-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: :ansible-option-default:`"admin"`
state string	The state. Choices: :ansible-option-choices-entry-default:`"present"` ← (default) :ansible-option-choices-entry:`"absent"` :ansible-option-choices-entry:`"replaced"` :ansible-option-choices-entry:`"merged"` :ansible-option-choices-entry:`"deleted"` :ansible-option-choices-entry:`"gathered"`
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: :ansible-option-default:`"admin"`
value string	The value to assign the header.
vsys string	The vsys this object belongs to. Default: :ansible-option-default:`"shared"`

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 header to the config log type
  paloaltonetworks.panos.panos_http_profile_header:
    provider: '{{ provider }}'
    http_profile: 'my-profile'
    log_type: 'user id'
    header: 'Content-Type'
    value: 'application/json'

Authors

• Garfield Lee Freeman (@shinmog)

Collection links

Issue Tracker Homepage Repository (Sources)