panos_http_profile – Manage http server profiles¶
New in version 2.8.
Synopsis¶
NOTE: The modules in this role are deprecated in favour of the modules in the collection https://paloaltonetworks.github.io/pan-os-ansible
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 | Choices/Defaults | 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
-
|
Name for custom config format.
|
||
auth_payload
-
|
Payload for custom config format.
|
||
auth_uri_format
-
|
URI format for custom config format.
|
||
config_name
-
|
Name for custom config format.
|
||
config_payload
-
|
Payload for custom config format.
|
||
config_uri_format
-
|
URI format for custom config format.
|
||
data_name
-
|
Name for custom config format.
|
||
data_payload
-
|
Payload for custom config format.
|
||
data_uri_format
-
|
URI format for custom config format.
|
||
device_group
string
|
Default: "shared"
|
(Panorama only) The device group the operation should target.
|
|
gtp_name
-
|
Name for custom config format.
|
||
gtp_payload
-
|
Payload for custom config format.
|
||
gtp_uri_format
-
|
URI format for custom config format.
|
||
hip_match_name
-
|
Name for custom config format.
|
||
hip_match_payload
-
|
Payload for custom config format.
|
||
hip_match_uri_format
-
|
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
-
|
PAN-OS 9.0+.
Name for custom config format.
|
||
iptag_payload
-
|
PAN-OS 9.0+.
Payload for custom config format.
|
||
iptag_uri_format
-
|
PAN-OS 9.0+.
URI format for custom config format.
|
||
name
-
/ required
|
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
|
Default: 443
|
Deprecated
Use provider to specify PAN-OS connectivity instead.
The port number to connect to the PAN-OS device on.
|
|
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.
|
|
sctp_name
-
|
PAN-OS 8.1+.
Name for custom config format.
|
||
sctp_payload
-
|
PAN-OS 8.1+.
Payload for custom config format.
|
||
sctp_uri_format
-
|
PAN-OS 8.1+.
URI format for custom config format.
|
||
system_name
-
|
Name for custom config format.
|
||
system_payload
-
|
Payload for custom config format.
|
||
system_uri_format
-
|
URI format for custom config format.
|
||
tag_registration
boolean
|
|
The server should have user-ID agent running in order for tag registration to work.
|
|
threat_name
-
|
Name for custom config format.
|
||
threat_payload
-
|
Payload for custom config format.
|
||
threat_uri_format
-
|
URI format for custom config format.
|
||
traffic_name
-
|
Name for custom config format.
|
||
traffic_payload
-
|
Payload for custom config format.
|
||
traffic_uri_format
-
|
URI format for custom config format.
|
||
tunnel_name
-
|
Name for custom config format.
|
||
tunnel_payload
-
|
Payload for custom config format.
|
||
tunnel_uri_format
-
|
URI format for custom config format.
|
||
url_name
-
|
Name for custom config format.
|
||
url_payload
-
|
Payload for custom config format.
|
||
url_uri_format
-
|
URI format for custom config format.
|
||
user_id_name
-
|
Name for custom config format.
|
||
user_id_payload
-
|
Payload for custom config format.
|
||
user_id_uri_format
-
|
URI format for custom config format.
|
||
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.
|
|
wildfire_name
-
|
Name for custom config format.
|
||
wildfire_payload
-
|
Payload for custom config format.
|
||
wildfire_uri_format
-
|
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
panos_http_profile:
provider: '{{ provider }}'
name: 'my-profile'
tag_registration: true
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community.