fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_system_backup_allsettings Scheduled backup settings. | "added in version" 2.0.0 of fortinet.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communityfortinet.fortimanager.fmgr_system_backup_allsettings (2.4.0) — module
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections: - name: fortinet.fortimanager version: 2.4.0
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.
- name: Example playbook (generated based on argument schema) hosts: fortimanagers connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Scheduled backup settings. fortinet.fortimanager.fmgr_system_backup_allsettings: # 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_backup_allsettings: cert: <string> crptpasswd: <list or string> directory: <string> passwd: <list or string> protocol: <value in [sftp, ftp, scp]> server: <string> status: <value in [disable, enable]> time: <string> user: <string> week_days: - monday - tuesday - wednesday - thursday - friday - saturday - sunday
rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int type: list enable_log: default: false description: Enable/Disable logging for task. type: bool access_token: description: The token to access FortiManager without using username and password. type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. type: str system_backup_allsettings: description: The top level parameters set. required: false suboptions: cert: description: SSH certificate for authentication. type: str crptpasswd: description: (list) Optional password to protect backup content. type: raw directory: description: Directory in which file will be stored on backup server. type: str passwd: description: (list) Backup server login user password. type: raw protocol: choices: - sftp - ftp - scp description: - Protocol used to backup. - sftp - SFTP. - ftp - FTP. - scp - SCP. type: str server: description: Backup server name/IP. type: str status: choices: - disable - enable description: - Enable/disable schedule backup. - disable - Disable setting. - enable - Enable setting. type: str time: description: Time to backup. type: str user: description: Backup server login user. type: str week_days: choices: - monday - tuesday - wednesday - thursday - friday - saturday - sunday description: - Week days to backup. - monday - Monday. - tuesday - Tuesday. - wednesday - Wednesday. - thursday - Thursday. - friday - Friday. - saturday - Saturday. - sunday - Sunday. elements: str type: list type: dict workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. type: int
meta: contains: request_url: description: The full url requested. returned: always sample: /sys/login/user type: str response_code: description: The status of api request. returned: always sample: 0 type: int response_data: description: The api response. returned: always type: list response_message: description: The descriptive message of the api response. returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: complex type: list