fmgr_devprof_system_global – Configure global attributes.¶
New in version 1.0.0.
Synopsis¶
- 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.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.0.0 |
|||||||||||
| True | |||||||||||
6.2.0 |
6.2.1 |
6.2.2 |
6.2.3 |
6.2.5 |
6.2.6 |
6.2.7 |
6.2.8 |
6.2.9 |
6.2.10 |
||
| True | True | True | True | True | False | 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 |
| True | True | False | 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 |
||||
| True | True | True | True | True | True | True | True | ||||
7.2.0 |
7.2.1 |
7.2.2 |
|||||||||
| True | True | True | |||||||||
7.4.0 |
|||||||||||
| True |
Parameters¶
- 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
- adom - The parameter in requested url type: str required: true
- devprof - The parameter in requested url type: str required: true
- devprof_system_global - Configure global attributes. type: dict
- admin-https-redirect - Enable/disable redirection of HTTP administration access to HTTPS. type: str choices: [disable, enable] more...
- admin-port - Administrative access port for HTTP. type: int more...
- admin-scp - Enable/disable using SCP to download the system configuration. type: str choices: [disable, enable] more...
- admin-sport - Administrative access port for HTTPS. type: int more...
- admin-ssh-port - Administrative access port for SSH. type: int more...
- admin-ssh-v1 - Enable/disable SSH v1 compatibility. type: str choices: [disable, enable] more...
- admin-telnet-port - Administrative access port for TELNET. type: int more...
- admintimeout - Number of minutes before an idle administrator session times out (5 - 480 minutes (8 hours), default = 5). type: int more...
- gui-ipv6 - Enable/disable IPv6 settings on the GUI. type: str choices: [disable, enable] more...
- gui-lines-per-page - Number of lines to display per page for web administration. type: int more...
- gui-theme - Color scheme for the administration GUI. type: str choices: [blue, green, melongene, red, mariner, neutrino, jade, graphite, dark-matter, onyx, eclipse, retro, fpx, jet-stream, security-fabric] more...
- language - GUI display language. type: str choices: [english, simch, japanese, korean, spanish, trach, french, portuguese] more...
- switch-controller - Enable/disable switch controller feature. type: str choices: [disable, enable] more...
Notes¶
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
Examples¶
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure global attributes.
fmgr_devprof_system_global:
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, ...]
adom: <your own value>
devprof: <your own value>
devprof_system_global:
admin-https-redirect: <value in [disable, enable]>
admin-port: <value of integer>
admin-scp: <value in [disable, enable]>
admin-sport: <value of integer>
admin-ssh-port: <value of integer>
admin-ssh-v1: <value in [disable, enable]>
admin-telnet-port: <value of integer>
admintimeout: <value of integer>
gui-ipv6: <value in [disable, enable]>
gui-lines-per-page: <value of integer>
gui-theme: <value in [blue, green, melongene, ...]>
language: <value in [english, simch, japanese, ...]>
switch-controller: <value in [disable, enable]>
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 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0