a10_health_monitor_method_https
Synopsis
HTTPS type
Parameters
Parameters |
Choices/Defaults |
Comment |
|
|---|---|---|---|
state str/required |
[‘noop’, ‘present’, ‘absent’] |
State of the object to be created. |
|
ansible_host str/required |
Host for AXAPI authentication |
||
ansible_username str/required |
Username for AXAPI authentication |
||
ansible_password str/required |
Password for AXAPI authentication |
||
ansible_port int/required |
Port for AXAPI authentication |
||
a10_device_context_id int |
[‘1-8’] |
Device ID for aVCS configuration |
|
a10_partition str |
Destination/target partition for object/command |
||
monitor_name str/required |
Key to identify parent object |
||
https bool |
HTTPS type |
||
web_port int |
Specify HTTPS port (Port Number (default 443)) |
||
disable_sslv2hello bool |
Disable SSLv2Hello for HTTPs |
||
http_version str |
‘http-version2’= HTTP version 2 for HTTPs; ‘http-version3’= HTTP version 3 for HTTPs; |
||
https_host str |
Specify ‘Host=’ header used in request (enclose IPv6 address in []) |
||
sni bool |
Server Name Indication for HTTPs |
||
https_expect bool |
Specify what you expect from the response message |
||
https_response_code str |
Specify response code range (e.g. 200,400-430) (Format is xx,xx-xx (xx between [100, 899]) |
||
response_code_regex str |
Specify response code range with Regex (code with Regex, such as [2-5][0-9][0-9]) |
||
https_text str |
Specify text expected |
||
text_regex str |
Specify text expected with Regex |
||
https_url bool |
Specify URL string, default is GET / |
||
url_type str |
‘GET’= HTTP GET method; ‘POST’= HTTP POST method; ‘HEAD’= HTTP HEAD method; |
||
url_path str |
Specify URL path, default is ‘/’ |
||
post_path str |
Specify URL path, default is ‘/’ |
||
post_type str |
‘postdata’= Specify the HTTP post data; ‘postfile’= Specify the HTTP post data; |
||
https_postdata str |
Specify the HTTP post data (Input post data here) |
||
https_postfile str |
Specify the HTTP post data (Input post data file name here) |
||
https_maintenance_code str |
Specify response code for maintenance (Format is xx,xx-xx (xx between [100, 899]) |
||
maintenance bool |
Specify response text for maintenance |
||
maintenance_text str |
Specify text for maintenance |
||
maintenance_text_regex str |
Specify Regex text for maintenance |
||
https_username str |
Specify the username |
||
https_server_cert_name str |
Expect Server Cert commonName |
||
https_password bool |
Specify the user password |
||
https_password_string str |
Configure password, ‘’ means empty password |
||
https_encrypted str |
Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string) |
||
https_kerberos_auth bool |
Https Kerberos Auth |
||
https_kerberos_realm str |
Specify realm of Kerberos server |
||
https_kerberos_kdc dict |
Field https_kerberos_kdc |
||
https_kerberos_hostip str |
Kdc’s hostname(length=1-31) or IP address |
||
https_kerberos_hostipv6 str |
Server’s IPV6 address |
||
https_kerberos_port int |
Specify the kdc port |
||
https_kerberos_portv6 int |
Specify the kdc port |
||
cert_key_shared bool |
Select shared partition |
||
cert str |
Specify client certificate (Certificate name) |
||
key str |
Specify client private key (Key name) |
||
key_pass_phrase bool |
Client private key password phrase |
||
key_phrase str |
Password Phrase |
||
https_key_encrypted str |
Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string) |
||
uuid str |
uuid of the object |
||
Examples
Return Values
- modified_values (changed, dict, )
Values modified (or potential changes if using check_mode) as a result of task operation
- axapi_calls (always, list, )
Sequential list of AXAPI calls made by the task
- endpoint (, str, [‘/axapi/v3/slb/virtual_server’, ‘/axapi/v3/file/ssl-cert’])
The AXAPI endpoint being accessed.
- http_method (, str, [‘POST’, ‘GET’])
HTTP method being used by the primary task to interact with the AXAPI endpoint.
- request_body (, complex, )
Params used to query the AXAPI
- response_body (, complex, )
Response from the AXAPI
Status
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by community.