faz_cli_system_admin_setting – Admin setting.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiAnalyzer device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiAnalyzer Version Compatibility¶
6.2.1 |
6.2.2 |
6.2.3 |
6.2.5 |
6.2.6 |
6.4.1 |
6.4.2 |
6.4.3 |
6.4.4 |
6.4.5 |
7.0.0 |
7.2.0 |
|
| cli_system_admin_setting | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- bypass_validation - Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool required: false default: False
- 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
- cli_system_admin_setting - Admin setting. type: dict
- access-banner - Enable/disable access banner. type: str choices: [disable, enable] default: disable more...
- admin-https-redirect - Enable/disable redirection of HTTP admin traffic to HTTPS. type: str choices: [disable, enable] default: enable more...
- admin-login-max - Maximum number admin users logged in at one time (1 - 256). type: int default: 256 more...
- admin_server_cert - HTTPS & Web Service server certificate. type: str default: server.crt more...
- banner-message - Banner message. type: str more...
- gui-theme - Color scheme to use for the administration GUI. type: str choices: [blue, green, red, melongene, spring, summer, autumn, winter, space, calla-lily, binary-tunnel, diving, dreamy, technology, landscape, twilight, canyon, northern-light, astronomy, fish, penguin, panda, polar-bear, parrot, cave, mountain, zebra, contrast-dark, circuit-board, mars, blue-sea] default: blue more...
- http_port - HTTP port. type: int default: 80 more...
- https_port - HTTPS port. type: int default: 443 more...
- idle_timeout - Idle timeout (1 - 480 min). type: int default: 15 more...
- objects-force-deletion - Enable/disable used objects force deletion. type: str choices: [disable, enable] default: enable more...
- shell-access - Enable/disable shell access. type: str choices: [disable, enable] default: disable more...
- shell-password - No description for the parameter type: str more...
- show-add-multiple - Show add multiple button. type: str choices: [disable, enable] default: disable more...
- show-checkbox-in-table - Show checkboxs in tables on GUI. type: str choices: [disable, enable] default: disable more...
- show-device-import-export - Enable/disable import/export of ADOM, device, and group lists. type: str choices: [disable, enable] default: disable more...
- show-fct-manager - Enable/disable FCT manager. type: str choices: [disable, enable] default: disable more...
- show-hostname - Enable/disable hostname display in the GUI login page. type: str choices: [disable, enable] default: disable more...
- show-log-forwarding - Show log forwarding tab in regular mode. type: str choices: [disable, enable] default: enable more...
- unreg_dev_opt - Action to take when unregistered device connects to FortiAnalyzer. type: str choices: [add_no_service, ignore, add_allow_service] default: add_allow_service more...
- webadmin_language - Web admin language. type: str choices: [auto_detect, english, simplified_chinese, traditional_chinese, japanese, korean, spanish, french] default: auto_detect more...
- idle_timeout_api - Idle timeout for API sessions (1 - 28800 sec). type: int default: 900 more...
- idle_timeout_gui - Idle timeout for GUI sessions (60 - 28800 sec). type: int default: 900 more...
- auth-addr - IP which is used by FGT to authorize FAZ. type: str more...
- auth-port - Port which is used by FGT to authorize FAZ. type: int default: 443 more...
- idle_timeout_sso - Idle timeout for SSO sessions (60 - 28800 sec). type: int default: 900 more...
- preferred-fgfm-intf - Preferred interface for FGFM connection. type: str more...
Notes¶
Note
- 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¶
- collections:
- fortinet.fortianalyzer
connection: httpapi
hosts: fortianalyzer-inventory
tasks:
- faz_cli_system_admin_setting:
cli_system_admin_setting:
access-banner: disable
admin-https-redirect: disable
objects-force-deletion: disable
shell-access: disable
show-add-multiple: disable
show-checkbox-in-table: disable
show-device-import-export: disable
show-fct-manager: disable
show-hostname: disable
show-log-forwarding: disable
name: Admin setting.
vars:
ansible_httpapi_port: 443
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
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:
- 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_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict