panos_http_server – Manage HTTP servers in a HTTP server profile

New in version 2.8.

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 Choices/Defaults Comments
address
- / required
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
-
PAN-OS 9.0+
Certificate profile for validating server cert.
device_group
string
Default:
"shared"
(Panorama only) The device group the operation should target.
http_method
-
Default:
"POST"
HTTP method to use.
http_password
-
Password for basic HTTP auth.
http_port
integer
Default:
443
Port number.
http_profile
- / required
Name of the http server profile.
http_username
-
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
- / required
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
Default:
443
Deprecated
Use provider to specify PAN-OS connectivity instead.

The port number to connect to the PAN-OS device on.
protocol
-
    Choices:
  • HTTP
  • HTTPS ←
The protocol.
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.
tls_version
-
    Choices:
  • 1.0
  • 1.1
  • 1.2
PAN-OS 9.0+
TLS handshake protocol version
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.
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: Create http server
  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'

Status

Authors

  • Garfield Lee Freeman (@shinmog)