faz_cli_system_admin_setting – Admin setting.
New in version 1.0.0.
Warning
Starting in version 2.0.0, all variables will be named in the underscore naming convention.
Possible variable names before 2.0.0:
variable-name
,variable name
,variable.name
Corresponding variable names since 2.0.0:
variable_name
FortiAnalyzer Ansible v1.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.
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.15.0
FortiAnalyzer Version Compatibility
6.2.0 |
6.2.1 |
6.2.2 |
6.2.3 |
6.2.4 |
6.2.5 |
6.2.6 |
6.2.7 |
6.2.8 |
6.2.9 |
6.2.10 |
6.2.11 |
6.2.12 |
||
None | True | True | True | None | True | True | True | True | True | True | True | True | ||
6.4.0 |
6.4.1 |
6.4.2 |
6.4.3 |
6.4.4 |
6.4.5 |
6.4.6 |
6.4.7 |
6.4.8 |
6.4.9 |
6.4.10 |
6.4.11 |
6.4.12 |
6.4.13 |
6.4.14 |
None | True | True | True | True | True | True | True | True | True | True | True | True | True | True |
7.0.0 |
7.0.1 |
7.0.2 |
7.0.3 |
7.0.4 |
7.0.5 |
7.0.6 |
7.0.7 |
7.0.8 |
7.0.9 |
7.0.10 |
7.0.11 |
|||
True | True | True | True | True | True | True | True | True | True | True | True | |||
7.2.0 |
7.2.1 |
7.2.2 |
7.2.3 |
7.2.4 |
||||||||||
True | True | True | True | True | ||||||||||
7.4.0 |
7.4.1 |
7.4.2 |
||||||||||||
True | True | True |
Parameters
- access_token -The token to access FortiAnalyzer without using ansible_username and ansible_password. type: str required: false
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- forticloud_access_token - Access token of forticloud analyzer API users. type: str required: false
- log_path - 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.logtype: str required: false default: "/tmp/fortianalyzer.ansible.log"
- 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, mariner, jade, neutrino, dark-matter, forest, cat, graphite] 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...
- preferred_fgfm_intf - Preferred interface for FGFM connection. type: str more...
- idle_timeout_sso - Idle timeout for SSO sessions (60 - 28800 sec). type: int default: 900 more...
- fsw_ignore_platform_check - Enable/disable FortiSwitch Manager switch platform support check. type: str choices: [disable, enable] default: disable more...
- firmware_upgrade_check - Enable/disable firmware upgrade check. type: str choices: [disable, enable] default: enable more...
- fgt_gui_proxy - Enable/disable FortiGate GUI proxy. type: str choices: [disable, enable] default: enable more...
- fgt_gui_proxy_port - FortiGate GUI proxy port. type: int default: 8082 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
- name: Example playbook
connection: httpapi
hosts: fortianalyzers
tasks:
- name: Admin setting.
fortinet.fortianalyzer.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
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:
- 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 fortianalyzer version. returned: if params are not supported in the current version type: list
Status
This module is not guaranteed to have a backwards compatible interface.