fmgr_system_log_settings_rollingregular – Log rolling policy for device logs.

New in version 2.0.0.

Synopsis

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

Requirements

The below requirements are needed on the host that executes this module.

• ansible>=2.9.0

FortiManager Version Compatibility

6.0.0
True
6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
True	True	True	True	True	True	True	True	True	True	True
6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
True	True	True	True	True	True	True	True	True	True	True	True	True
7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
True	True	True	True	True	True	True	True	True
7.2.0	7.2.1	7.2.2	7.2.3
True	True	True	True
7.4.0
True

Parameters

• access_token -The token to access FortiManager without using username and password. type: str required: false
• bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
• enable_log - Enable/Disable logging for task. type: bool required: false default: False
• forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
• proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
• rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
• rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
• workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
• workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
• system_log_settings_rollingregular - Log rolling policy for device logs. type: dict
• days - Log files rolling schedule (days of week). type: array choices: [sun, mon, tue, wed, thu, fri, sat] more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• del-files - Enable/disable log file deletion after uploading. type: str choices: [disable, enable] default: disable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• directory - Upload server directory, for Unix server, use absolute type: str more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• file-size - Roll log files when they reach this size (MB). type: int default: 200 more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• gzip-format - Enable/disable compression of uploaded log files. type: str choices: [disable, enable] default: disable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• hour - Log files rolling schedule (hour). type: int default: 0 more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• ip - Upload server IP address. type: str default: 0.0.0.0 more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  False	False	False	False
  7.4.0
  False

• ip2 - Upload server IP2 address. type: str default: 0.0.0.0 more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  False	False	False	False
  7.4.0
  False

• ip3 - Upload server IP3 address. type: str default: 0.0.0.0 more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  False	False	False	False
  7.4.0
  False

• log-format - Format of uploaded log files. type: str choices: [native, text, csv] default: native more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• min - Log files rolling schedule (minutes). type: int default: 0 more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• password - Upload server login password. type: str more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• password2 - Upload server login password2. type: str more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• password3 - Upload server login password3. type: str more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• server-type - Upload server type. type: str choices: [ftp, sftp, scp] default: ftp more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• upload - Enable/disable log file uploads. type: str choices: [disable, enable] default: disable more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• upload-hour - Log files upload schedule (hour). type: int default: 0 more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• upload-mode - Upload mode with multiple servers. type: str choices: [backup, mirror] default: backup more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• upload-trigger - Event triggering log files upload. type: str choices: [on-roll, on-schedule] default: on-roll more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• username - Upload server login username. type: str more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• username2 - Upload server login username2. type: str more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• username3 - Upload server login username3. type: str more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• when - Roll log files periodically. type: str choices: [none, daily, weekly] default: none more...

  6.0.0
  True
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  True	True	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• port - Upload server IP1 port number. type: int default: 0 more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• port2 - Upload server IP2 port number. type: int default: 0 more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• port3 - Upload server IP3 port number. type: int default: 0 more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	True	True	True	True	True	True	True	True	True
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  True	True	True	True	True	True	True	True	True	True	True	True	True
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  True	True	True	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• rolling-upgrade-status - rolling upgrade status (1|0). type: int default: 0 more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	True	True	True	True	True	True
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• server - Upload server FQDN/IP. type: str more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• server2 - Upload server2 FQDN/IP. type: str more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

• server3 - Upload server3 FQDN/IP. type: str more...

  6.0.0
  False
  6.2.0	6.2.1	6.2.2	6.2.3	6.2.5	6.2.6	6.2.7	6.2.8	6.2.9	6.2.10	6.2.11
  False	False	False	False	False	False	False	False	False	False	False
  6.4.0	6.4.1	6.4.2	6.4.3	6.4.4	6.4.5	6.4.6	6.4.7	6.4.8	6.4.9	6.4.10	6.4.11	6.4.12
  False	False	False	False	False	False	False	False	False	False	False	False	False
  7.0.0	7.0.1	7.0.2	7.0.3	7.0.4	7.0.5	7.0.6	7.0.7	7.0.8
  False	False	False	False	False	False	False	False	False
  7.2.0	7.2.1	7.2.2	7.2.3
  True	True	True	True
  7.4.0
  True

Notes

Note

• 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.
• To create or update an object, use state: present directive.
• To delete an object, use state: absent directive
• 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

- 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: Log rolling policy for device logs.
     fmgr_system_log_settings_rollingregular:
        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, ...]
        system_log_settings_rollingregular:
           days:
             - sun
             - mon
             - tue
             - wed
             - thu
             - fri
             - sat
           del-files: <value in [disable, enable]>
           directory: <value of string>
           file-size: <value of integer>
           gzip-format: <value in [disable, enable]>
           hour: <value of integer>
           ip: <value of string>
           ip2: <value of string>
           ip3: <value of string>
           log-format: <value in [native, text, csv]>
           min: <value of integer>
           password: <value of string>
           password2: <value of string>
           password3: <value of string>
           server-type: <value in [ftp, sftp, scp]>
           upload: <value in [disable, enable]>
           upload-hour: <value of integer>
           upload-mode: <value in [backup, mirror]>
           upload-trigger: <value in [on-roll, on-schedule]>
           username: <value of string>
           username2: <value of string>
           username3: <value of string>
           when: <value in [none, daily, weekly]>
           port: <value of integer>
           port2: <value of integer>
           port3: <value of integer>
           rolling-upgrade-status: <value of integer>
           server: <value of string>
           server2: <value of string>
           server3: <value of string>

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:

• meta - The result of the request.returned: always type: dict
• request_url - The full url requested. returned: always type: str sample: /sys/login/user
• response_code - The status of api request. returned: always type: int sample: 0
• response_data - The data body of the api response. returned: optional type: list or dict
• response_message - The descriptive message of the api response. returned: always type: str sample: OK
• system_information - The information of the target system. returned: always type: dict
• rc - The status the request. returned: always type: int 0
• version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0

Status

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

Authors

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

Hint

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