- source
fmgr_fmupdate_fwmsetting_upgradetimeout.py
- orphan
2.2.0
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0:
var-name
,var name
,var.name
- New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
- 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.
The below requirements are needed on the host that executes this module.
- ansible>=2.15.0
Supported Version Ranges: v7.0.5 -> v7.0.12
, v7.2.2 -> latest
- 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
- fmupdate_fwmsetting_upgradetimeout - Configure the timeout value of image upgrade process. type: dict
- check_status_timeout (Alias name: check-status-timeout) Timeout for checking status after tunnnel is up. type: int default: 600
more...
Supported Version Ranges:
v7.0.5 -> v7.0.12
,v7.2.2 -> latest
- ctrl_check_status_timeout (Alias name: ctrl-check-status-timeout) Timeout for checking fap/fsw/fext status after request upgrade. type: int default: 1200
more...
Supported Version Ranges:
v7.0.5 -> v7.0.12
,v7.2.2 -> latest
- ctrl_put_image_by_fds_timeout (Alias name: ctrl-put-image-by-fds-timeout) Timeout for waiting device get fap/fsw/fext image from fortiguard. type: int default: 900
more...
Supported Version Ranges:
v7.0.5 -> v7.0.12
,v7.2.2 -> latest
- ha_sync_timeout (Alias name: ha-sync-timeout) Timeout for waiting ha sync. type: int default: 1800
more...
Supported Version Ranges:
v7.0.5 -> v7.0.12
,v7.2.2 -> latest
- license_check_timeout (Alias name: license-check-timeout) Timeout for waiting fortigate check license. type: int default: 600
more...
Supported Version Ranges:
v7.0.5 -> v7.0.12
,v7.2.2 -> latest
- prepare_image_timeout (Alias name: prepare-image-timeout) Timeout for preparing image. type: int default: 600
more...
Supported Version Ranges:
v7.0.5 -> v7.0.12
,v7.2.2 -> latest
- put_image_by_fds_timeout (Alias name: put-image-by-fds-timeout) Timeout for waiting device get image from fortiguard. type: int default: 1800
more...
Supported Version Ranges:
v7.0.5 -> v7.0.12
,v7.2.2 -> latest
- put_image_timeout (Alias name: put-image-timeout) Timeout for waiting send image over tunnel. type: int default: 1800
more...
Supported Version Ranges:
v7.0.5 -> v7.0.12
,v7.2.2 -> latest
- reboot_of_fsck_timeout (Alias name: reboot-of-fsck-timeout) Timeout for waiting fortigate reboot. type: int default: 1800
more...
Supported Version Ranges:
v7.0.5 -> v7.0.12
,v7.2.2 -> latest
- reboot_of_upgrade_timeout (Alias name: reboot-of-upgrade-timeout) Timeout for waiting fortigate reboot after image upgrade. type: int default: 1200
more...
Supported Version Ranges:
v7.0.5 -> v7.0.12
,v7.2.2 -> latest
- retrieve_timeout (Alias name: retrieve-timeout) Timeout for waiting retrieve. type: int default: 1800
more...
Supported Version Ranges:
v7.0.5 -> v7.0.12
,v7.2.2 -> latest
- rpc_timeout (Alias name: rpc-timeout) Timeout for waiting fortigate rpc response. type: int default: 180
more...
Supported Version Ranges:
v7.0.5 -> v7.0.12
,v7.2.2 -> latest
- total_timeout (Alias name: total-timeout) Timeout for the whole fortigate upgrade(1-86400s, default=3600) type: int default: 3600
more...
Supported Version Ranges:
v7.0.5 -> v7.0.12
,v7.2.2 -> latest
- health_check_timeout (Alias name: health-check-timeout) Timeout for waiting retrieve. type: int default: 600
more...
Supported Version Ranges:
v7.4.2 -> latest
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
- 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: Configure the timeout value of image upgrade process.
fortinet.fortimanager.fmgr_fmupdate_fwmsetting_upgradetimeout:
# 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, ...]
fmupdate_fwmsetting_upgradetimeout:
check_status_timeout: <integer>
ctrl_check_status_timeout: <integer>
ctrl_put_image_by_fds_timeout: <integer>
ha_sync_timeout: <integer>
license_check_timeout: <integer>
prepare_image_timeout: <integer>
put_image_by_fds_timeout: <integer>
put_image_timeout: <integer>
reboot_of_fsck_timeout: <integer>
reboot_of_upgrade_timeout: <integer>
retrieve_timeout: <integer>
rpc_timeout: <integer>
total_timeout: <integer>
health_check_timeout: <integer>
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 sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
- This module is not guaranteed to have a backwards compatible interface.
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)