fortinet.fortimanager.fmgr_system_global – Global range attributes.
Note
This plugin is part of the fortinet.fortimanager collection (version 1.0.5).
To install it use: ansible-galaxy collection install fortinet.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_global.
New in version 2.10: of fortinet.fortimanager
Synopsis
- This module is able to configure a FortiManager device by allowing the user to [ get set update ] the following apis.
- /cli/global/system/global
- Examples include all parameters and values need to be adjusted to data sources before usage.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| loose_validation boolean |
| Do parameter validation in a loose way |
| method string / required |
| The method in request |
| params list / elements=string | The parameters for each method See full parameters list in https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest | |
| url_params dictionary | The parameters for each API request URL Also see full URL parameters in https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest | |
| workspace_locking_adom string | the adom name to lock in case FortiManager running in workspace mode it can be global or any other custom adom names | |
| workspace_locking_timeout integer | Default: 300 | the maximum time in seconds to wait for other user to release the workspace lock |
Notes
Note
- There are only three top-level parameters where ‘method’ is always required while other two ‘params’ and ‘url_params’ can be optional
- Due to the complexity of fortimanager api schema, the validation is done out of Ansible native parameter validation procedure.
- The syntax of OPTIONS doen not comply with the standard Ansible argument specification, but with the structure of fortimanager API schema, we need a trivial transformation when we are filling the ansible playbook
Examples
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: REQUESTING /CLI/SYSTEM/GLOBAL
fmgr_system_global:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [set, update]>
params:
-
data:
admin-lockout-duration: <value of integer>
admin-lockout-threshold: <value of integer>
adom-mode: <value in [normal, advanced]>
adom-rev-auto-delete: <value in [disable, by-revisions, by-days]>
adom-rev-max-backup-revisions: <value of integer>
adom-rev-max-days: <value of integer>
adom-rev-max-revisions: <value of integer>
adom-select: <value in [disable, enable]>
adom-status: <value in [disable, enable]>
clt-cert-req: <value in [disable, enable, optional]>
console-output: <value in [standard, more]>
country-flag: <value in [disable, enable]>
create-revision: <value in [disable, enable]>
daylightsavetime: <value in [disable, enable]>
default-disk-quota: <value of integer>
detect-unregistered-log-device: <value in [disable, enable]>
device-view-mode: <value in [regular, tree]>
dh-params: <value in [1024, 1536, 2048, ...]>
disable-module:
- <value in [fortiview-noc]>
enc-algorithm: <value in [low, medium, high]>
faz-status: <value in [disable, enable]>
fgfm-local-cert: <value of string>
fgfm-ssl-protocol: <value in [sslv3, tlsv1.0, tlsv1.1, ...]>
ha-member-auto-grouping: <value in [disable, enable]>
hitcount_concurrent: <value of integer>
hitcount_interval: <value of integer>
hostname: <value of string>
import-ignore-addr-cmt: <value in [disable, enable]>
language: <value in [english, simch, japanese, ...]>
latitude: <value of string>
ldap-cache-timeout: <value of integer>
ldapconntimeout: <value of integer>
lock-preempt: <value in [disable, enable]>
log-checksum: <value in [none, md5, md5-auth]>
log-forward-cache-size: <value of integer>
longitude: <value of string>
max-log-forward: <value of integer>
max-running-reports: <value of integer>
oftp-ssl-protocol: <value in [sslv3, tlsv1.0, tlsv1.1, ...]>
partial-install: <value in [disable, enable]>
partial-install-force: <value in [disable, enable]>
partial-install-rev: <value in [disable, enable]>
perform-improve-by-ha: <value in [disable, enable]>
policy-hit-count: <value in [disable, enable]>
policy-object-in-dual-pane: <value in [disable, enable]>
pre-login-banner: <value in [disable, enable]>
pre-login-banner-message: <value of string>
remoteauthtimeout: <value of integer>
search-all-adoms: <value in [disable, enable]>
ssl-low-encryption: <value in [disable, enable]>
ssl-protocol:
- <value in [tlsv1.2, tlsv1.1, tlsv1.0, ...]>
ssl-static-key-ciphers: <value in [disable, enable]>
task-list-size: <value of integer>
tftp: <value in [disable, enable]>
timezone: <value in [00, 01, 02, ...]>
tunnel-mtu: <value of integer>
usg: <value in [disable, enable]>
vdom-mirror: <value in [disable, enable]>
webservice-proto:
- <value in [tlsv1.2, tlsv1.1, tlsv1.0, ...]>
workflow-max-sessions: <value of integer>
workspace-mode: <value in [disabled, normal, workflow]>
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| data dictionary | always | The payload returned in the request |
| status dictionary | always | The status of api request |
| url string | always | The full url requested Sample: /sys/login/user |
Authors
- Frank Shen (@fshen01)
- Link Zheng (@zhengl)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortimanager/fmgr_system_global_module.html