Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
You might already have this collection installed if you are using the ansible
package. It is not included in ansible-core
. To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortios
.
To use it in a playbook, specify: fortinet.fortios.fortios_wanopt_content_delivery_network_rule
.
New in version 2.10: of fortinet.fortios
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | ||||
---|---|---|---|---|---|---|
access_token string | Token-based authentication. Generated from GUI of Fortigate. | |||||
enable_log boolean |
| Enable/Disable logging for task. | ||||
state string / required |
| Indicates whether to create or remove the object. | ||||
vdom string | Default: "root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. | ||||
wanopt_content_delivery_network_rule dictionary | Configure WAN optimization content delivery network rules. | |||||
category string |
| Content delivery network rule category. | ||||
comment string | Comment about this CDN-rule. | |||||
host_domain_name_suffix list / elements=string | Suffix portion of the fully qualified domain name (eg. fortinet.com in "www.fortinet.com"). | |||||
name string / required | Suffix portion of the fully qualified domain name. | |||||
name string / required | Name of table. | |||||
request_cache_control string |
| Enable/disable HTTP request cache control. | ||||
response_cache_control string |
| Enable/disable HTTP response cache control. | ||||
response_expires string |
| Enable/disable HTTP response cache expires. | ||||
rules list / elements=string | WAN optimization content delivery network rule entries. | |||||
content_id dictionary | Content ID settings. | |||||
end_direction string |
| Search direction from end-str match. | ||||
end_skip integer | Number of characters in URL to skip after end-str has been matched. | |||||
end_str string | String from which to end search. | |||||
range_str string | Name of content ID within the start string and end string. | |||||
start_direction string |
| Search direction from start-str match. | ||||
start_skip integer | Number of characters in URL to skip after start-str has been matched. | |||||
start_str string | String from which to start search. | |||||
target string |
| Option in HTTP header or URL parameter to match. | ||||
match_entries list / elements=string | List of entries to match. | |||||
id integer / required | Rule ID. | |||||
pattern list / elements=string | Pattern string for matching target (Referrer or URL pattern, eg. "a", "a*c", "*a*", "a*c*e", and "*"). | |||||
string string / required | Pattern strings. | |||||
target string |
| Option in HTTP header or URL parameter to match. | ||||
match_mode string |
| Match criteria for collecting content ID. | ||||
name string / required | WAN optimization content delivery network rule name. | |||||
skip_entries list / elements=string | List of entries to skip. | |||||
id integer / required | Rule ID. | |||||
pattern list / elements=string | Pattern string for matching target (Referrer or URL pattern, eg. "a", "a*c", "*a*", "a*c*e", and "*"). | |||||
string string / required | Pattern strings. | |||||
target string |
| Option in HTTP header or URL parameter to match. | ||||
skip_rule_mode string |
| Skip mode when evaluating skip-rules. | ||||
status string |
| Enable/disable WAN optimization content delivery network rules. | ||||
text_response_vcache string |
| Enable/disable caching of text responses. | ||||
updateserver string |
| Enable/disable update server. |
Note
- hosts: fortigates collections: - fortinet.fortios connection: httpapi vars: vdom: "root" ansible_httpapi_use_ssl: yes ansible_httpapi_validate_certs: no ansible_httpapi_port: 443 tasks: - name: Configure WAN optimization content delivery network rules. fortios_wanopt_content_delivery_network_rule: vdom: "{{ vdom }}" state: "present" access_token: "<your_own_value>" wanopt_content_delivery_network_rule: category: "vcache" comment: "Comment about this CDN-rule." host_domain_name_suffix: - name: "default_name_6" name: "default_name_7" request_cache_control: "enable" response_cache_control: "enable" response_expires: "enable" rules: - content_id: end_direction: "forward" end_skip: "14" end_str: "<your_own_value>" range_str: "<your_own_value>" start_direction: "forward" start_skip: "18" start_str: "<your_own_value>" target: "path" match_entries: - id: "22" pattern: - string: "<your_own_value>" target: "path" match_mode: "all" name: "default_name_27" skip_entries: - id: "29" pattern: - string: "<your_own_value>" target: "path" skip_rule_mode: "all" status: "enable" text_response_vcache: "enable" updateserver: "enable"
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
build string | always | Build number of the fortigate image Sample: 1547 |
http_method string | always | Last method used to provision the content into FortiGate Sample: PUT |
http_status string | always | Last result given by FortiGate on last operation applied Sample: 200 |
mkey string | success | Master key (id) used in the last call to FortiGate Sample: id |
name string | always | Name of the table used to fulfill the request Sample: urlfilter |
path string | always | Path of the table used to fulfill the request Sample: webfilter |
revision string | always | Internal revision number Sample: 17.0.2.10658 |
serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352 |
status string | always | Indication of the operation's result Sample: success |
vdom string | always | Virtual domain used Sample: root |
version string | always | Version of the FortiGate Sample: v5.6.3 |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_wanopt_content_delivery_network_rule_module.html