fwebos_waf_site_publish_authentication_server_pool_member.py – Config FortiWeb Published Site Policy’s Authentication Server Pool’s Members¶
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_waf_site_publish_authentication_server_pool_member.py | yes | yes | yes | yes |
Parameters¶
- body Possible parameters to go in the body for the request required: True
- name The name of the Published Site Policy's Authentication Server Pool. type:string maxLength:63
- id The numerical ID of Authentication Server Pool's member. type:string maxLength:63
- server_type Select the type of the server. type:string choice: radius, ldap,
- radius_server The name of the Radius Server. type:string maxLength:255
- ldap_server The name of the LDAP Server. type:string maxLength:255
- rsa_securid Enable or disable RSA SecurID. 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: add a authentication server pool member
fwebos_waf_site_publish_authentication_server_pool_member:
action: add
name: asp1
server_type: radius
radius_server: radius_server_1
rsa_securid: enable
- name: get a authentication server pool member
fwebos_waf_site_publish_authentication_server_pool_member:
action: get
name: asp1
id: 1
- name: get all authentication server pool member
fwebos_waf_site_publish_authentication_server_pool_member:
action: get
name: asp1
- name: edit a authentication server pool member
fwebos_waf_site_publish_authentication_server_pool_member:
action: edit
name: asp1
id: 1
server_type: ldap
ldap_server: ldap_server1
- name: delete a authentication server pool member
fwebos_waf_site_publish_authentication_server_pool_member:
action: delete
name: asp1
id: 1
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