fwebos_admin_profiles.py – Configure FortiWeb admin profiles¶
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_admin_profiles.py | yes | yes | yes | yes |
Parameters¶
- body Possible parameters to go in the body for the request required: True
- name profile name type:string maxLength:63
- mntgrp Access permission for maintain group policy/profile type:string choice: none, r, rw,
- admingrp Access permission for admin group policy/profile type:string choice: none, r, rw,
- sysgrp Access permission for system group policy/profile type:string choice: none, r, rw,
- netgrp Access permission for network group policy/profile type:string choice: none, r, rw,
- loggrp Access permission for log group policy/profile type:string choice: none, r, rw,
- authusergrp Access permission for auth user group policy/profile type:string choice: none, r, rw,
- traroutegrp Access permission for traffic route group policy/profile type:string choice: none, r, rw,
- wafgrp Access permission for waf group policy/profile type:string choice: none, r, rw,
- wadgrp Access permission for wad group policy/profile type:string choice: none, r, rw,
- wvsgrp Access permission for wvs group policy/profile type:string choice: none, r, rw,
- mlgrp Access permission for ml group policy/profile type:string choice: none, r, rw,
- 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 profile
fwebos_admin_profiles:
action: add
name: test
mntgrp: r
admingrp: rw
sysgrp: none
netgrp: none
loggrp: none
authusergrp: none
traroutegrp: none
wafgrp: none
wadgrp: none
wvsgrp: none
mlgrp: none
- name: Edit profile
fwebos_admin_profiles:
action: edit
name: test
mntgrp: rw
admingrp: r
sysgrp: none
netgrp: none
loggrp: none
authusergrp: none
traroutegrp: none
wafgrp: none
wadgrp: none
wvsgrp: none
mlgrp: none
- name: delete profile
fwebos_admin_profiles:
action: delete
name: test
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