fortinet.fortimanager.fmgr_devprof_system_global – Configure global attributes.
fortinet.fortimanager.fmgr_devprof_system_global – Configure global attributes.
Note
This plugin is part of the fortinet.fortimanager collection (version 2.0.1).
To install it use: ansible-galaxy collection install fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_devprof_system_global
.
New in version 2.10: of fortinet.fortimanager
Synopsis
- This module is able to configure a FortiManager device.
- Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
adom string / required |
the parameter (adom) in requested url | ||
bypass_validation boolean |
|
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters | |
devprof string / required |
the parameter (devprof) in requested url | ||
devprof_system_global dictionary |
the top level parameters set | ||
admin-https-redirect string |
|
Enable/disable redirection of HTTP administration access to HTTPS. | |
admin-port integer |
Administrative access port for HTTP. (1 - 65535, default = 80). | ||
admin-scp string |
|
Enable/disable using SCP to download the system configuration. You can use SCP as an alternative method for backing up the con... | |
admin-sport integer |
Administrative access port for HTTPS. (1 - 65535, default = 443). | ||
admin-ssh-port integer |
Administrative access port for SSH. (1 - 65535, default = 22). | ||
admin-ssh-v1 string |
|
Enable/disable SSH v1 compatibility. | |
admin-telnet-port integer |
Administrative access port for TELNET. (1 - 65535, default = 23). | ||
admintimeout integer |
Number of minutes before an idle administrator session times out (5 - 480 minutes (8 hours), default = 5). A shorter idle time... | ||
gui-ipv6 string |
|
Enable/disable IPv6 settings on the GUI. | |
gui-lines-per-page integer |
Number of lines to display per page for web administration. | ||
gui-theme string |
|
Color scheme for the administration GUI. | |
language string |
|
GUI display language. | |
switch-controller string |
|
Enable/disable switch controller feature. Switch controller allows you to manage FortiSwitch from the FortiGate itself. | |
rc_failed list / elements=string |
the rc codes list with which the conditions to fail will be overriden | ||
rc_succeeded list / elements=string |
the rc codes list with which the conditions to succeed will be overriden | ||
state string / required |
|
the directive to create, update or delete an object | |
workspace_locking_adom string |
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root | ||
workspace_locking_timeout integer |
Default: 300 |
the maximum time in seconds to wait for other user to release the workspace lock |
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 here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
request_url string |
always |
The full url requested
Sample: /sys/login/user |
response_code integer |
always |
The status of api request
|
response_message string |
always |
The descriptive message of the api response
Sample: OK. |
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_devprof_system_global_module.html