fortiswitch_system_fortiguard – Configure FortiGuard services in Fortinet’s FortiSwitch
New in version 1.0.0.
Synopsis
This module is able to configure a FortiSwitch device by allowing the user to set and modify system feature and fortiguard category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v7.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.14
FortiSW Version Compatibility
Supported Version Ranges | |
fortiswitch_system_fortiguard | v7.0.0 -> latest |
Parameters
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- system_fortiguard - Configure FortiGuard services. type: dict
- analysis_service - Enable or disable the analysis service. type: str choices: enable, disable
- antispam_cache - Enable/disable the cache. type: str choices: enable, disable
- antispam_cache_mpercent - The maximum percent of memory the cache is allowed to use (1-15%). type: int
- antispam_cache_ttl - The time-to-live for cache entries in seconds (300-86400). type: int
- antispam_expiration - When license will expire. type: int
- antispam_force_off - Forcibly disable the service. type: str choices: enable, disable
- antispam_license - License type. type: int
- antispam_score_threshold - Antispam score threshold [50,100]. type: int
- antispam_timeout - Query time out (1-30 seconds). type: int
- avquery_cache - Enable/disable the cache. type: str choices: enable, disable
- avquery_cache_mpercent - The maximum percent of memory the cache is allowed to use (1-15%). type: int
- avquery_cache_ttl - The time-to-live for cache entries in seconds (300-86400). type: int
- avquery_expiration - When license will expire. type: int
- avquery_force_off - Forcibly disable the service. type: str choices: enable, disable
- avquery_license - License type. type: int
- avquery_timeout - Query time out (1-30 seconds). type: int
- client_override_ip - Client override IP address. type: str
- client_override_status - Enable or disable the client override IP. type: str choices: enable, disable
- hostname - Hostname or IP of the FortiGuard server. type: str
- load_balance_servers - Number of servers to alternate between as first Fortiguard option. type: int
- port - Port used to communicate with the FortiGuard servers. type: str choices: 53, 8888
- service_account_id - Service account id. type: str
- srv_ovrd - Enable or disable the server override list. type: str choices: enable, disable
- srv_ovrd_list - Configure the server override list. type: list
- addr_type - Type of address. type: str choices: ipv4, ipv6
- ip - Override server IP address. type: str
- ip6 - Override server IP6 address. type: str
- webfilter_cache - Enable/disable the cache. type: str choices: enable, disable
- webfilter_cache_ttl - The time-to-live for cache entries in seconds (300-86400). type: int
- webfilter_expiration - When license will expire. type: int
- webfilter_force_off - Forcibly disable the service. type: str choices: enable, disable
- webfilter_license - License type. type: int
- webfilter_timeout - Query time out (1-30 seconds). type: int
Examples
- name: Configure FortiGuard services.
fortinet.fortiswitch.fortiswitch_system_fortiguard:
system_fortiguard:
analysis_service: "enable"
antispam_cache: "enable"
antispam_cache_mpercent: "5"
antispam_cache_ttl: "6"
antispam_expiration: "7"
antispam_force_off: "enable"
antispam_license: "9"
antispam_score_threshold: "10"
antispam_timeout: "11"
avquery_cache: "enable"
avquery_cache_mpercent: "13"
avquery_cache_ttl: "14"
avquery_expiration: "15"
avquery_force_off: "enable"
avquery_license: "17"
avquery_timeout: "18"
client_override_ip: "<your_own_value>"
client_override_status: "enable"
hostname: "myhostname"
load_balance_servers: "22"
port: "53"
service_account_id: "<your_own_value>"
srv_ovrd: "enable"
srv_ovrd_list:
-
addr_type: "ipv4"
ip: "<your_own_value>"
ip6: "<your_own_value>"
webfilter_cache: "enable"
webfilter_cache_ttl: "31"
webfilter_expiration: "32"
webfilter_force_off: "enable"
webfilter_license: "34"
webfilter_timeout: "35"
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:
- build - Build number of the fortiSwitch image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiSwitch returned: always type: str sample: PUT
- http_status - Last result given by FortiSwitch on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiSwitch returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- serial - Serial number of the unit returned: always type: str sample: FS1D243Z13000122
- status - Indication of the operation's result returned: always type: str sample: success
- version - Version of the FortiSwitch returned: always type: str sample: v7.0.0
Status
This module is not guaranteed to have a backwards compatible interface.