fwebos_fortiguard_config.py – Config FortiWeb System FortiGuard info

New in version 1.0.1.

Synopsis

Config FortiWeb System FortiGuard info

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_fortiguard_config.py yes yes yes yes

Parameters

  • body Possible parameters to go in the body for the request required: True
    • svrip svrip type:string
    • svrport svrport type:integer
    • override override type:string
    • address address type:string
    • scheduled scheduled type:string
    • scheduleType scheduleType type:string
    • everySelect everySelect type:integer
    • dailySelect dailySelect type:integer
    • weeklyDaySelect weeklyDaySelect type:integer
    • weeklyHourSelect weeklyHourSelect type:integer
    • dbVersionType dbVersionType type:integer
    • bufferSize bufferSize type:integer
    • useFSD useFSD type:integer
    • oversvr oversvr type:string

Examples

- name:
  hosts: all
  vars:
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Edit fortigurad config
      fwebos_fortiguard_config:
       action: edit
       override: True
       scheduled: True
       isUpdating: False
       updateControl: []
       address: 1.1.1.1
       scheduleType: every
       everySelect: 2
       dailySelect: 0
       weeklyDaySelect: 0
       weeklyHourSelect: 0
       dbVersionType: 2
       bufferSize: 5500
       useFSD: 1
       _id: only

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

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Jie Li
  • Brad Zhang

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.