dux_fortinet / dux_fortinet.fortianalyzer_dev / 1.4.0 / module / faz_um_image_upgrade The older API for updating the firmware of specific device. | "added in version" 1.1.0 of dux_fortinet.fortianalyzer_dev" Authors: Xinwei Du (@dux-fortinet), Link Zheng (@chillancezen), Jie Xue (@JieX19), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communitydux_fortinet.fortianalyzer_dev.faz_um_image_upgrade (1.4.0) — module
Install with ansible-galaxy collection install dux_fortinet.fortianalyzer_dev:==1.4.0
collections: - name: dux_fortinet.fortianalyzer_dev version: 1.4.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.
- name: Example playbook hosts: fortianalyzers connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: The older API for updating the firmware of specific device. fortinet.fortianalyzer.faz_um_image_upgrade: # bypass_validation: false # rc_succeeded: [0, -2, -3, ...] # rc_failed: [-2, -3, ...] um_image_upgrade: adom: <value of string> create_task: <value of string> device: - name: <value of string> vdom: <value of string> flags: <value in [f_boot_alt_partition, f_skip_retrieve, f_skip_multi_steps, ...]> image: build: <value of string> id: <value of string> model: <value of string> release: <value of string> schedule_time: <value of string>
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 um_image_upgrade: description: The top level parameters set. required: false suboptions: adom: description: no description type: str create_task: description: no description type: str device: description: no description elements: dict suboptions: name: description: no description type: str vdom: description: no description type: str type: list flags: choices: - f_boot_alt_partition - f_skip_retrieve - f_skip_multi_steps - f_skip_fortiguard_img - f_preview description: no description type: str image: description: no description required: false suboptions: build: description: no description type: str id: description: no description type: str model: description: no description type: str release: description: no description type: str type: dict schedule_time: description: no description type: str type: dict 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
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