fwebos_certificate_local_import_certificate.py – Upload local certificates to FortiWeb¶
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.x |
v7.2.x |
v7.4.x |
v7.6.x |
|
| fwebos_certificate_local_import_certificate.py | yes | yes | yes | yes |
Parameters¶
- body Possible parameters to go in the body for the request
- title title type:string
- upload upload type:string
- message message type:string
- hsm hsm type:string
- type type type:string
- password password type:string
- certificateFile certificateFile type:string format:binary
- 512 512 type:string format:binary
- certificateWithKeyFile certificateWithKeyFile type:string format:binary
- keyFile keyFile type:string format:binary
- hsmSlot hsmSlot type:string
Examples¶
- name:
hosts: all
vars:
connection: httpapi
gather_facts: false
tasks:
- name: Upload pkcs12 certificate
fwebos_certificate_local_import_certificate:
action: add
vdom: root
type: PKCS12Certificate
certificateWithKeyFile: ca.p12
password: 12345678
- name: Delete certificate
fwebos_certificate_local_import_certificate:
action: delete
vdom: root
name: ca
- name: Upload certificate
fwebos_certificate_local_import_certificate:
action: add
vdom: root
type: certificate
certificateFile: ca.crt
keyFile: ca.key
hsm: undefined
password: 12345678
- name: Delete certificate
fwebos_certificate_local_import_certificate:
action: delete
vdom: root
name: ca
- name: Upload local certificate
fwebos_certificate_local_import_certificate:
action: add
vdom: root
type: localCertificate
certificateFile: cert.cer
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