fmgr_devprof_system_global – Configure global attributes.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device by allowing the user to [get, set, update] the following FortiManager json-rpc urls.
- /pm/config/adom/{adom}/devprof/{devprof}/system/global
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.0.0
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.10.0
Parameters¶
- loose_validation - Do parameter validation in a loose way type: bool required: false default: false
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom dom
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- url_params - parameters in url path type: dict required: true
- adom - the domain prefix type: str choices: none, global, custom dom
- devprof - the object name type: str
- parameters for method: [get] - Configure global attributes.
- option - Set fetch option for the request. type: str choices: [object member, chksum, datasrc]
- parameters for method: [set, update] - Configure global attributes.
- data - No description for the parameter type: dict
- admin-https-redirect - Enable/disable redirection of HTTP administration access to HTTPS. type: str choices: [disable, enable]
- admin-port - Administrative access port for HTTP. type: int
- admin-scp - Enable/disable using SCP to download the system configuration. type: str choices: [disable, enable]
- admin-sport - Administrative access port for HTTPS. type: int
- admin-ssh-port - Administrative access port for SSH. type: int
- admin-ssh-v1 - Enable/disable SSH v1 compatibility. type: str choices: [disable, enable]
- admin-telnet-port - Administrative access port for TELNET. type: int
- admintimeout - Number of minutes before an idle administrator session times out (5 - 480 minutes (8 hours), default = 5). type: int
- gui-ipv6 - Enable/disable IPv6 settings on the GUI. type: str choices: [disable, enable]
- gui-lines-per-page - Number of lines to display per page for web administration. type: int
- gui-theme - Color scheme for the administration GUI. type: str choices: [blue, green, melongene, red, mariner]
- language - GUI display language. type: str choices: [english, simch, japanese, korean, spanish, trach, french, portuguese]
- switch-controller - Enable/disable switch controller feature. type: str choices: [disable, enable]
Notes¶
Note
- The module may supports multiple method, every method has different parameters definition
- One method may also have more than one parameter definition collection, each collection is dedicated to one API endpoint
- The module may include domain dependent urls, the domain can be specified in url_params as adom
- To run in workspace mode, the paremeter workspace_locking_adom must be included in the task
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: REQUESTING /PM/CONFIG/DEVPROF/{DEVPROF}/SYSTEM/GLOBAL
fmgr_devprof_system_global:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [get]>
url_params:
adom: <value in [none, global, custom dom]>
devprof: <value of string>
params:
-
option: <value in [object member, chksum, datasrc]>
- name: REQUESTING /PM/CONFIG/DEVPROF/{DEVPROF}/SYSTEM/GLOBAL
fmgr_devprof_system_global:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [set, update]>
url_params:
adom: <value in [none, global, custom dom]>
devprof: <value of string>
params:
-
data:
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:
- return values for method: [get]
- data
- No description for the parameter type: dict
- admin-https-redirect - Enable/disable redirection of HTTP administration access to HTTPS. type: str
- admin-port - Administrative access port for HTTP. type: int
- admin-scp - Enable/disable using SCP to download the system configuration. type: str
- admin-sport - Administrative access port for HTTPS. type: int
- admin-ssh-port - Administrative access port for SSH. type: int
- admin-ssh-v1 - Enable/disable SSH v1 compatibility. type: str
- admin-telnet-port - Administrative access port for TELNET. type: int
- admintimeout - Number of minutes before an idle administrator session times out (5 - 480 minutes (8 hours), default = 5). type: int
- gui-ipv6 - Enable/disable IPv6 settings on the GUI. type: str
- gui-lines-per-page - Number of lines to display per page for web administration. type: int
- gui-theme - Color scheme for the administration GUI. type: str
- language - GUI display language. type: str
- switch-controller - Enable/disable switch controller feature. type: str
- status
- No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
- url - No description for the parameter type: str example: /pm/config/adom/{adom}/devprof/{devprof}/system/global
- return values for method: [set, update]
- status
- No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
- url - No description for the parameter type: str example: /pm/config/adom/{adom}/devprof/{devprof}/system/global