fadcos_system_setting – system setting configuration in Fortinet’s FortiADC

New in version 1.0.0.

Synopsis

  • Configure FortiADC system setting

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.8

FortiADC Version Compatibility


v7.0.0 v7.0.1 v7.0.2 v7.1.0 v7.1.4 v7.2.2 v7.4.0
fortiadc_system_setting yes yes yes yes yes yes yes

Parameters

  • idle_timeout - the idle time-out for system administration 1-480type: str required: false default: 30
  • config_sync - config sync enabletype: str required: false default: disable
  • intermediate_ca_group - appliance's default ssl certificate chaintype: str required: false
  • hostname - appliance's host nametype: str required: false
  • http_port - the port number of the http servicetype: str required: false
  • https_port - the port number of the https servicetype: str required: false
  • https_server_cert - appliance's local default certificatetype: str required: false
  • ip_primary - Primary DNStype: str required: false
  • ip_second - Secondary DNStype: str required: false
  • ssh_port - SSH porttype: str required: false
  • sys_global_language - Global GUI display language (english/chinese-simplified/japanese/spanish/chinese-traditional/portuguese)type: str required: false
  • telnet_port - telnet porttype: str required: false
  • vdom - enable/disable vdomtype: str required: false

Examples

- name:
  hosts: all
  connection: httpapi
  gather_facts: false
  tasks:
        - name: Manage system setting
          fadcos_system_setting:
           idle_timeout: 78
           config_sync: disable

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:

  • 200 - OK: Request returns successful.
  • 400 - Bad Request: Request cannot be processed by the API.
  • 401 - Not Authorized: Request without successful login session.
  • 403 - Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
  • 404 - Resource Not Found: Unable to find the specified resource.
  • 405 - Method Not Allowed: Specified HTTP method is not allowed for this resource.
  • 413 - Request Entity Too Large: Request cannot be processed due to large entity.
  • 424 - Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, or invalid attribute value.
  • 429 - Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
  • 500 - Internal Server Error: Internal error when processing the request.

For errorcode please check FortiADC API errorcode at : https://fndn.fortinet.net/index.php?/fortiapi/981-fortiadc/

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Jie Li
  • Aravindh Sri

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.