fwebos_certificate_public_key_pinning.py – Config FortiWeb server objects Public Key Pinning¶
New in version 1.0.1.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.11
FortiWeb Version Compatibility¶
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
|
| fwebos_certificate_public_key_pinning.py | yes | yes | yes | yes |
Parameters¶
- body Possible parameters to go in the body for the request required: True
- name hpkp name type:string maxLength:63
- pin-sha256 base64 encoded SPKI fingerprint type:string maxLength:127
- max-age max age(0 - 31536000 seconds) type:integer maximum:31536000 minimum:0
- subdomains include subdomains type:string choice: enable, disable,
- report-uri report URI type:string maxLength:255
- report-only report only mode type:string choice: enable, disable,
- mkey If present, objects will be filtered on property with this name type:string
- vdom Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs) type:array
- clone_mkey Use *clone_mkey* to specify the ID for the new resource to be cloned. If *clone_mkey* is set, *mkey* must be provided which is cloned from. type:string
Examples¶
- name:
hosts: all
vars:
connection: httpapi
gather_facts: false
tasks:
- name: Create certificate public key pinning
fwebos_certificate_public_key_pinning:
action: add
vdom: root1
name: aaa
pin_sha256: 111 aaa
max_age: 1296000
subdomains: disable
subdomains_val: 0
report_uri: aaa.com
report_only: enable
report_only_val: 1
- name: edit certificate public key pining
fwebos_certificate_public_key_pinning:
action: edit
vdom: root1
name: aaa
pin_sha256: 111 aaa
max_age: 1296011
subdomains: disable
subdomains_val: 0
report_uri: aaa.com
report_only: enable
report_only_val: 1
- name: delete certificate public key pinning
fwebos_certificate_public_key_pinning:
action: delete
vdom: root1
name: aaa
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- 200 : OK: Request returns successful
- 400 : Bad Request: Request cannot be processed by the API
- 401 : Not Authorized: Request without successful login session
- 403 : Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
- 404 : Resource Not Found: Unable to find the specified resource.
- 405 : Method Not Allowed: Specified HTTP method is not allowed for this resource.
- 413 : Request Entity Too Large: Request cannot be processed due to large entity
- 424 : Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
- 429 : Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
- 500 : Internal Server Error: Internal error when processing the request
For errorcode please check FortiWeb API errorcode at : https://documenter.getpostman.com/view/11233300/TVetbkaK#887b9eb4-7c13-4338-a8db-16cc117f0119