drmofu / drmofu.fortianalyzer / 1.3.0 / module / faz_cli_fmupdate_fwmsetting_upgradetimeout Configure the timeout value of image upgrade process. | "added in version" 1.1.0 of drmofu.fortianalyzer" Authors: Xinwei Du (@dux-fortinet), Link Zheng (@chillancezen), Jie Xue (@JieX19), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communitydrmofu.fortianalyzer.faz_cli_fmupdate_fwmsetting_upgradetimeout (1.3.0) — module
Install with ansible-galaxy collection install drmofu.fortianalyzer:==1.3.0
collections: - name: drmofu.fortianalyzer version: 1.3.0
This module is able to configure a FortiAnalyzer device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- hosts: fortianalyzer_inventory collections: - fortinet.fortianalyzer connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: Configure the timeout value of image upgrade process. faz_cli_fmupdate_fwmsetting_upgradetimeout: bypass_validation: False rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] cli_fmupdate_fwmsetting_upgradetimeout: check-status-timeout: <value of integer> ctrl-check-status-timeout: <value of integer> ctrl-put-image-by-fds-timeout: <value of integer> ha-sync-timeout: <value of integer> license-check-timeout: <value of integer> prepare-image-timeout: <value of integer> put-image-by-fds-timeout: <value of integer> put-image-timeout: <value of integer> reboot-of-fsck-timeout: <value of integer> reboot-of-upgrade-timeout: <value of integer> retrieve-timeout: <value of integer> rpc-timeout: <value of integer> total-timeout: <value of integer>
log_path: default: /tmp/fortianalyzer.ansible.log description: - The path to save log. Used if enable_log is true. - Please use absolute path instead of relative path. - If the log_path setting is incorrect, the log will be saved in /tmp/fortianalyzer.ansible.log required: false type: str rc_failed: description: the rc codes list with which the conditions to fail will be overriden elements: int required: false type: list enable_log: default: false description: Enable/Disable logging for task required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: the rc codes list with which the conditions to succeed will be overriden elements: int required: false type: list proposed_method: choices: - set - update - add description: The overridden method for the underlying Json RPC request required: false type: str bypass_validation: default: false description: only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters required: false type: bool forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str cli_fmupdate_fwmsetting_upgradetimeout: description: the top level parameters set required: false suboptions: check-status-timeout: description: timeout for checking status after tunnnel is up.(1-6000s, default=600) type: int ctrl-check-status-timeout: description: timeout for checking fap/fsw/fext status after request upgrade.(1-12000s, default=1200) type: int ctrl-put-image-by-fds-timeout: description: timeout for waiting device get fap/fsw/fext image from fortiguard.(1-9000ss, default=900) type: int ha-sync-timeout: description: timeout for waiting HA sync.(1-18000s, default=1800) type: int license-check-timeout: description: timeout for waiting fortigate check license.(1-6000s, default=600) type: int prepare-image-timeout: description: timeout for preparing image.(1-6000s, default=600) type: int put-image-by-fds-timeout: description: timeout for waiting device get image from fortiguard.(1-18000s, default=1800) type: int put-image-timeout: description: timeout for waiting send image over tunnel.(1-18000s, default=1800) type: int reboot-of-fsck-timeout: description: timeout for waiting fortigate reboot.(1-18000s, default=1800) type: int reboot-of-upgrade-timeout: description: timeout for waiting fortigate reboot after image upgrade.(1-12000s, default=1200) type: int retrieve-timeout: description: timeout for waiting retrieve.(1-18000s, default=1800) type: int rpc-timeout: description: timeout for waiting fortigate rpc response.(1-1800s, default=180) type: int total-timeout: description: timeout for the whole fortigate upgrade(1-86400s, default=3600) type: int type: dict
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 fortianalyzer version. returned: complex type: list