fortinet.fortimanager.fmgr_fmupdate_fgdsetting module – Cli fmupdate fgd setting

Note

This module is part of the fortinet.fortimanager collection (version 2.10.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_fmupdate_fgdsetting.

New in fortinet.fortimanager 2.10.0

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)
  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)
  • true

fmupdate_fgdsetting

dictionary

The top level parameters set.

as_cache

aliases: as-cache

integer

As cache.

as_log

aliases: as-log

string

As log.

Choices:

  • "disable"
  • "nospam"
  • "all"

as_preload

aliases: as-preload

string

As preload.

Choices:

  • "disable"
  • "enable"

av2_cache

aliases: av2-cache

integer

Av2 cache.

av2_log

aliases: av2-log

string

Av2 log.

Choices:

  • "disable"
  • "noav2"
  • "all"

av2_preload

aliases: av2-preload

string

Av2 preload.

Choices:

  • "disable"
  • "enable"

av_cache

aliases: av-cache

integer

Av cache.

av_log

aliases: av-log

string

Av log.

Choices:

  • "disable"
  • "novirus"
  • "all"

av_preload

aliases: av-preload

string

Av preload.

Choices:

  • "disable"
  • "enable"

eventlog_query

aliases: eventlog-query

string

Eventlog query.

Choices:

  • "disable"
  • "enable"

fgd_pull_interval

aliases: fgd-pull-interval

integer

Fgd pull interval.

fq_cache

aliases: fq-cache

integer

Fq cache.

fq_log

aliases: fq-log

string

Fq log.

Choices:

  • "disable"
  • "nofilequery"
  • "all"

fq_preload

aliases: fq-preload

string

Fq preload.

Choices:

  • "disable"
  • "enable"

iot_cache

aliases: iot-cache

integer

Iot cache.

iot_log

aliases: iot-log

string

Iot log.

Choices:

  • "disable"
  • "noiot"
  • "all"

iot_preload

aliases: iot-preload

string

Iot preload.

Choices:

  • "disable"
  • "enable"

iotv_preload

aliases: iotv-preload

string

Iotv preload.

Choices:

  • "disable"
  • "enable"

linkd_log

aliases: linkd-log

string

Linkd log.

Choices:

  • "emergency"
  • "alert"
  • "critical"
  • "error"
  • "warn"
  • "notice"
  • "info"
  • "debug"
  • "disable"

max_client_worker

aliases: max-client-worker

integer

Max client worker.

max_log_quota

aliases: max-log-quota

integer

Max log quota.

max_unrated_site

aliases: max-unrated-site

integer

Max unrated site.

restrict_as1_dbver

aliases: restrict-as1-dbver

string

Restrict as1 dbver.

restrict_as2_dbver

aliases: restrict-as2-dbver

string

Restrict as2 dbver.

restrict_as4_dbver

aliases: restrict-as4-dbver

string

Restrict as4 dbver.

restrict_av2_dbver

aliases: restrict-av2-dbver

string

Restrict av2 dbver.

restrict_av_dbver

aliases: restrict-av-dbver

string

Restrict av dbver.

restrict_fq_dbver

aliases: restrict-fq-dbver

string

Restrict fq dbver.

restrict_iots_dbver

aliases: restrict-iots-dbver

string

Restrict iots dbver.

restrict_wf_dbver

aliases: restrict-wf-dbver

string

Restrict wf dbver.

server_override

aliases: server-override

dictionary

Server override.

servlist

list / elements=dictionary

Servlist.

id

integer

Id.

ip

string

Ip.

ip6

string

Ip6.

port

integer

Port.

service_type

aliases: service-type

string

Service type.

Choices:

  • "fgd"
  • "fsa"
  • "fgfq"
  • "geoip"
  • "iot-collect"

status

string

Status.

Choices:

  • "disable"
  • "enable"

stat_log

aliases: stat-log

string

Stat log.

Choices:

  • "emergency"
  • "alert"
  • "critical"
  • "error"
  • "warn"
  • "notice"
  • "info"
  • "debug"
  • "disable"

stat_log_interval

aliases: stat-log-interval

integer

Stat log interval.

stat_sync_interval

aliases: stat-sync-interval

integer

Stat sync interval.

update_interval

aliases: update-interval

integer

Update interval.

update_log

aliases: update-log

string

Update log.

Choices:

  • "disable"
  • "enable"

wf_cache

aliases: wf-cache

integer

Wf cache.

wf_dn_cache_expire_time

aliases: wf-dn-cache-expire-time

integer

Wf dn cache expire time.

wf_dn_cache_max_number

aliases: wf-dn-cache-max-number

integer

Wf dn cache max number.

wf_log

aliases: wf-log

string

Wf log.

Choices:

  • "disable"
  • "nourl"
  • "all"

wf_preload

aliases: wf-preload

string

Wf preload.

Choices:

  • "disable"
  • "enable"

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"
  • "set"
  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Cli fmupdate fgd setting
      fortinet.fortimanager.fmgr_fmupdate_fgdsetting:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        fmupdate_fgdsetting:
          # as_cache: <integer>
          # as_log: <value in [disable, nospam, all]>
          # as_preload: <value in [disable, enable]>
          # av_cache: <integer>
          # av_log: <value in [disable, novirus, all]>
          # av_preload: <value in [disable, enable]>
          # av2_cache: <integer>
          # av2_log: <value in [disable, noav2, all]>
          # av2_preload: <value in [disable, enable]>
          # eventlog_query: <value in [disable, enable]>
          # fgd_pull_interval: <integer>
          # fq_cache: <integer>
          # fq_log: <value in [disable, nofilequery, all]>
          # fq_preload: <value in [disable, enable]>
          # iot_cache: <integer>
          # iot_log: <value in [disable, noiot, all]>
          # iot_preload: <value in [disable, enable]>
          # iotv_preload: <value in [disable, enable]>
          # linkd_log: <value in [emergency, alert, critical, ...]>
          # max_client_worker: <integer>
          # max_log_quota: <integer>
          # max_unrated_site: <integer>
          # restrict_as1_dbver: <string>
          # restrict_as2_dbver: <string>
          # restrict_as4_dbver: <string>
          # restrict_av_dbver: <string>
          # restrict_av2_dbver: <string>
          # restrict_fq_dbver: <string>
          # restrict_iots_dbver: <string>
          # restrict_wf_dbver: <string>
          # server_override:
          #   servlist:
          #     - id: <integer>
          #       ip: <string>
          #       ip6: <string>
          #       port: <integer>
          #       service_type: <value in [fgd, fsa, fgfq, ...]>
          #   status: <value in [disable, enable]>
          # stat_log: <value in [emergency, alert, critical, ...]>
          # stat_log_interval: <integer>
          # stat_sync_interval: <integer>
          # update_interval: <integer>
          # update_log: <value in [disable, enable]>
          # wf_cache: <integer>
          # wf_dn_cache_expire_time: <integer>
          # wf_dn_cache_max_number: <integer>
          # wf_log: <value in [disable, nourl, all]>
          # wf_preload: <value in [disable, enable]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_fmupdate_fgdsetting_module.html