paloaltonetworks.panos.panos_http_profile (2.19.1) — module

Manage http server profiles.

| "added in version" 1.0.0 of paloaltonetworks.panos"

Authors: Garfield Lee Freeman (@shinmog)

Install collection

Install with ansible-galaxy collection install paloaltonetworks.panos:==2.19.1


Add to requirements.yml

  collections:
    - name: paloaltonetworks.panos
      version: 2.19.1

Description

Manages http server profiles.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Create a profile
- name: Create http profile with tag registration
  paloaltonetworks.panos.panos_http_profile:
    provider: '{{ provider }}'
    name: 'my-profile'
    tag_registration: true
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# 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",
        }

Inputs

    
name:
    description:
    - Name of the profile.
    type: str

port:
    default: 443
    description:
    - B(Deprecated)
    - Use I(provider) to specify PAN-OS connectivity instead.
    - HORIZONTALLINE
    - The port number to connect to the PAN-OS device on.
    type: int

vsys:
    default: shared
    description:
    - The vsys this object belongs to.
    type: str

state:
    choices:
    - present
    - absent
    - replaced
    - merged
    - deleted
    - gathered
    default: present
    description:
    - The state.
    type: str

api_key:
    description:
    - B(Deprecated)
    - Use I(provider) to specify PAN-OS connectivity instead.
    - HORIZONTALLINE
    - The API key to use instead of generating it using I(username) / I(password).
    type: str

gtp_name:
    description:
    - Name for custom config format.
    type: str

password:
    description:
    - B(Deprecated)
    - Use I(provider) to specify PAN-OS connectivity instead.
    - HORIZONTALLINE
    - The password to use for authentication.  This is ignored if I(api_key) is specified.
    type: str

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      api_key:
        description:
        - The API key to use instead of generating it using I(username) / I(password).
        type: str
      ip_address:
        description:
        - The IP address or hostname of the PAN-OS device being configured.
        type: str
      password:
        description:
        - The password to use for authentication.  This is ignored if I(api_key) is specified.
        type: str
      port:
        default: 443
        description:
        - The port number to connect to the PAN-OS device on.
        type: int
      serial_number:
        description:
        - The serial number of a firewall to use for targeted commands. If I(ip_address)
          is not a Panorama PAN-OS device, then this param is ignored.
        type: str
      username:
        default: admin
        description:
        - The username to use for authentication.  This is ignored if I(api_key) is specified.
        type: str
    type: dict
    version_added: 1.0.0
    version_added_collection: paloaltonetworks.panos

url_name:
    description:
    - Name for custom config format.
    type: str

username:
    default: admin
    description:
    - B(Deprecated)
    - Use I(provider) to specify PAN-OS connectivity instead.
    - HORIZONTALLINE
    - The username to use for authentication.  This is ignored if I(api_key) is specified.
    type: str

auth_name:
    description:
    - Name for custom config format.
    type: str

data_name:
    description:
    - Name for custom config format.
    type: str

sctp_name:
    description:
    - PAN-OS 8.1+.
    - Name for custom config format.
    type: str

ip_address:
    description:
    - B(Deprecated)
    - Use I(provider) to specify PAN-OS connectivity instead.
    - HORIZONTALLINE
    - The IP address or hostname of the PAN-OS device being configured.
    type: str

iptag_name:
    description:
    - PAN-OS 9.0+.
    - Name for custom config format.
    type: str

config_name:
    description:
    - Name for custom config format.
    type: str

gtp_payload:
    description:
    - Payload for custom config format.
    type: str

system_name:
    description:
    - Name for custom config format.
    type: str

threat_name:
    description:
    - Name for custom config format.
    type: str

tunnel_name:
    description:
    - Name for custom config format.
    type: str

url_payload:
    description:
    - Payload for custom config format.
    type: str

auth_payload:
    description:
    - Payload for custom config format.
    type: str

data_payload:
    description:
    - Payload for custom config format.
    type: str

device_group:
    default: shared
    description:
    - (Panorama only) The device group the operation should target.
    type: str

sctp_payload:
    description:
    - PAN-OS 8.1+.
    - Payload for custom config format.
    type: str

traffic_name:
    description:
    - Name for custom config format.
    type: str

user_id_name:
    description:
    - Name for custom config format.
    type: str

iptag_payload:
    description:
    - PAN-OS 9.0+.
    - Payload for custom config format.
    type: str

wildfire_name:
    description:
    - Name for custom config format.
    type: str

config_payload:
    description:
    - Payload for custom config format.
    type: str

gtp_uri_format:
    description:
    - URI format for custom config format.
    type: str

hip_match_name:
    description:
    - Name for custom config format.
    type: str

system_payload:
    description:
    - Payload for custom config format.
    type: str

threat_payload:
    description:
    - Payload for custom config format.
    type: str

tunnel_payload:
    description:
    - Payload for custom config format.
    type: str

url_uri_format:
    description:
    - URI format for custom config format.
    type: str

auth_uri_format:
    description:
    - URI format for custom config format.
    type: str

data_uri_format:
    description:
    - URI format for custom config format.
    type: str

decryption_name:
    description:
    - PAN-OS 10.0+.
    - Name for custom decryption format.
    type: str

gathered_filter:
    description:
    - When I(state=gathered).
    - An advanced filtering option to filter results returned from PAN-OS.
    - Refer to the guide discussing I(gathered_filter) for more information.
    type: str

sctp_uri_format:
    description:
    - PAN-OS 8.1+.
    - URI format for custom config format.
    type: str

traffic_payload:
    description:
    - Payload for custom config format.
    type: str

user_id_payload:
    description:
    - Payload for custom config format.
    type: str

iptag_uri_format:
    description:
    - PAN-OS 9.0+.
    - URI format for custom config format.
    type: str

tag_registration:
    description:
    - The server should have user-ID agent running in order for tag registration to work.
    type: bool

wildfire_payload:
    description:
    - Payload for custom config format.
    type: str

config_uri_format:
    description:
    - URI format for custom config format.
    type: str

hip_match_payload:
    description:
    - Payload for custom config format.
    type: str

system_uri_format:
    description:
    - URI format for custom config format.
    type: str

threat_uri_format:
    description:
    - URI format for custom config format.
    type: str

tunnel_uri_format:
    description:
    - URI format for custom config format.
    type: str

decryption_payload:
    description:
    - PAN-OS 10.0+.
    - Payload for custom decryption format.
    type: str

globalprotect_name:
    description:
    - PAN-OS 9.1+.
    - Name for custom GlobalProtect format.
    type: str

traffic_uri_format:
    description:
    - URI format for custom config format.
    type: str

user_id_uri_format:
    description:
    - URI format for custom config format.
    type: str

wildfire_uri_format:
    description:
    - URI format for custom config format.
    type: str

hip_match_uri_format:
    description:
    - URI format for custom config format.
    type: str

decryption_uri_format:
    description:
    - PAN-OS 10.0+.
    - URI format for custom decryption format.
    type: str

globalprotect_payload:
    description:
    - PAN-OS 9.1+.
    - Payload for custom GlobalProtect format.
    type: str

globalprotect_uri_format:
    description:
    - PAN-OS 9.1+.
    - URI format for custom GlobalProtect format.
    type: str