paloaltonetworks.panos.panos_http_server module – Manage HTTP servers in a HTTP server profile.

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

New in paloaltonetworks.panos 1.0.0

Synopsis

  • Manages HTTP servers in a HTTP server 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

address

string

IP address or FQDN of the HTTP server

api_key

string

Deprecated

Use provider to specify PAN-OS connectivity instead.

The API key to use instead of generating it using username / password.

certificate_profile

string

PAN-OS 9.0+

Certificate profile for validating server cert.

device_group

string

(Panorama only) The device group the operation should target.

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.

http_method

string

HTTP method to use.

Default: "POST"

http_password

string

Password for basic HTTP auth.

http_port

integer

Port number.

Default: 443

http_profile

string / required

Name of the http server profile.

http_username

string

Username for basic HTTP auth.

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

Server 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

Deprecated

Use provider to specify PAN-OS connectivity instead.

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

Default: 443

protocol

string

The protocol.

Choices:

  • "HTTP"

  • "HTTPS" ← (default)

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"

state

string

The state.

Choices:

  • "present" ← (default)

  • "absent"

  • "replaced"

  • "merged"

  • "deleted"

  • "gathered"

tls_version

string

PAN-OS 9.0+

TLS handshake protocol version

Choices:

  • "1.0"

  • "1.1"

  • "1.2"

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"

vsys

string

The vsys this object belongs to.

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: Create http server
  paloaltonetworks.panos.panos_http_server:
    provider: '{{ provider }}'
    http_profile: 'my-profile'
    name: 'my-http-server'
    address: '192.168.1.5'
    http_method: 'GET'
    http_username: 'jack'
    http_password: 'burton'

Authors

  • Garfield Lee Freeman (@shinmog)