paloaltonetworks.panos.panos_http_profile module – Manage http server profiles.

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.

New in paloaltonetworks.panos 1.0.0

Synopsis 

Manages http server profiles.

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.
auth_name string	Name for custom config format.
auth_payload string	Payload for custom config format.
auth_uri_format string	URI format for custom config format.
config_name string	Name for custom config format.
config_payload string	Payload for custom config format.
config_uri_format string	URI format for custom config format.
data_name string	Name for custom config format.
data_payload string	Payload for custom config format.
data_uri_format string	URI format for custom config format.
decryption_name string	PAN-OS 10.0+. Name for custom decryption format.
decryption_payload string	PAN-OS 10.0+. Payload for custom decryption format.
decryption_uri_format string	PAN-OS 10.0+. URI format for custom decryption format.
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.
globalprotect_name string	PAN-OS 9.1+. Name for custom GlobalProtect format.
globalprotect_payload string	PAN-OS 9.1+. Payload for custom GlobalProtect format.
globalprotect_uri_format string	PAN-OS 9.1+. URI format for custom GlobalProtect format.
gtp_name string	Name for custom config format.
gtp_payload string	Payload for custom config format.
gtp_uri_format string	URI format for custom config format.
hip_match_name string	Name for custom config format.
hip_match_payload string	Payload for custom config format.
hip_match_uri_format string	URI format for custom config format.
ip_address string	Deprecated Use provider to specify PAN-OS connectivity instead. The IP address or hostname of the PAN-OS device being configured.
iptag_name string	PAN-OS 9.0+. Name for custom config format.
iptag_payload string	PAN-OS 9.0+. Payload for custom config format.
iptag_uri_format string	PAN-OS 9.0+. URI format for custom config format.
name string	Name of the profile.
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"`
sctp_name string	PAN-OS 8.1+. Name for custom config format.
sctp_payload string	PAN-OS 8.1+. Payload for custom config format.
sctp_uri_format string	PAN-OS 8.1+. URI format for custom config format.
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"`
system_name string	Name for custom config format.
system_payload string	Payload for custom config format.
system_uri_format string	URI format for custom config format.
tag_registration boolean	The server should have user-ID agent running in order for tag registration to work. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
threat_name string	Name for custom config format.
threat_payload string	Payload for custom config format.
threat_uri_format string	URI format for custom config format.
traffic_name string	Name for custom config format.
traffic_payload string	Payload for custom config format.
traffic_uri_format string	URI format for custom config format.
tunnel_name string	Name for custom config format.
tunnel_payload string	Payload for custom config format.
tunnel_uri_format string	URI format for custom config format.
url_name string	Name for custom config format.
url_payload string	Payload for custom config format.
url_uri_format string	URI format for custom config format.
user_id_name string	Name for custom config format.
user_id_payload string	Payload for custom config format.
user_id_uri_format string	URI format for custom config format.
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"`
vsys string	The vsys this object belongs to. Default: :ansible-option-default:`"shared"`
wildfire_name string	Name for custom config format.
wildfire_payload string	Payload for custom config format.
wildfire_uri_format string	URI format for custom config format.

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 

# Create a profile
- name: Create http profile with tag registration
  paloaltonetworks.panos.panos_http_profile:
    provider: '{{ provider }}'
    name: 'my-profile'
    tag_registration: true

# Create a profile with log forwarding
- name: Create http profile for traffic log forwarding
  paloaltonetworks.panos.panos_http_profile:
    provider: '{{ provider }}'
    name: 'my-profile'
    traffic_name: 'traffic-logs-exporter'
    traffic_uri_format: 'https://test.local'
    traffic_payload: >
        {
            "category": "network",
            "action": "$action",
            "app": "$app",
            "dst": "$dst",
            "src": "$src",
            "receive_time": "$receive_time",
            "rule": "$rule",
            "rule_uuid": "$rule_uuid",
            "sessionid": "$sessionid",
        }

Authors

Garfield Lee Freeman (@shinmog)

Collection links

Issue Tracker Homepage Repository (Sources)

paloaltonetworks.panos.panos_http_profile module – Manage http server profiles.

Synopsis

Requirements

Parameters

Notes

Examples