fwebos_certificate_local_csr.py – Config FortiWeb server objects Local¶
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_csr.py | yes | yes | yes | yes |
Parameters¶
- body Possible parameters to go in the body for the request required: True
- name name type:string
- idType idType type:string
- ip ip type:string
- domainName domainName type:string
- subjectEmail subjectEmail type:string
- keyType keyType type:integer
- keySize keySize type:integer
- organization organization type:string
- localityCity localityCity type:string
- stateProvince stateProvince type:string
- countryRegion countryRegion type:string
- email email type:string
- hsmSlot hsmSlot type:string
- organizationUnit organizationUnit type:string
- organizationUnit_1 organizationUnit 1 type:string
- organizationUnit_2 organizationUnit 2 type:string
- organizationUnit_3 organizationUnit 3 type:string
- organizationUnit_4 organizationUnit 4 type:string
- organizationUnit_5 organizationUnit 5 type:string
- alt_type alt type type:integer
- enrollmentMethod enrollmentMethod type:string
- hsm hsm type:string
- challengePassword challengePassword type:string
- caServerURL caServerURL type:string
Examples¶
- name:
hosts: all
vars:
connection: httpapi
gather_facts: false
tasks:
- name: Create certificate csr
fwebos_certificate_local_csr:
action: add
vdom: root1
idType: hostIp
alt_name_type: 2
ip: 0.0.0.0
keySize: 1024
enrollmentMethod: file
name: test_1
organization: org
localityCity: city1
stateProvince: state1
countryRegion: US
email: test@test.com
organizationUnit_1: orgunit
alt_name_type_1: 2
alt_name_text_1: aaaaaa.com
- name: delete certificate csr
fwebos_certificate_local_csr:
action: delete
vdom: root1
name: test_1
- name: Create certificate csr
fwebos_certificate_local_csr:
action: add
vdom: root1
idType: email
subjectEmail: test@gmail.com
alt_name_type: 2
ip: 0.0.0.0
keySize: 1024
enrollmentMethod: file
name: test_2
organization: org
localityCity: city1
stateProvince: state1
countryRegion: US
email: test@test.com
organizationUnit_1: orgunit
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