fortinet.fortios.fortios_wanopt_content_delivery_network_rule module – Configure WAN optimization content delivery network rules in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_wanopt_content_delivery_network_rule.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wanopt feature and content_delivery_network_rule category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
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. Default: |
|
Configure WAN optimization content delivery network rules. |
|
Content delivery network rule category. Choices:
|
|
Comment about this CDN-rule. |
|
Suffix portion of the fully qualified domain name. For example, fortinet.com in “www.fortinet.com”. |
|
Suffix portion of the fully qualified domain name. |
|
Name of table. |
|
Enable/disable HTTP request cache control. Choices:
|
|
Enable/disable HTTP response cache control. Choices:
|
|
Enable/disable HTTP response cache expires. Choices:
|
|
WAN optimization content delivery network rule entries. |
|
Content ID settings. |
|
Search direction from end-str match. Choices:
|
|
Number of characters in URL to skip after end-str has been matched. |
|
String from which to end search. |
|
Name of content ID within the start string and end string. |
|
Search direction from start-str match. Choices:
|
|
Number of characters in URL to skip after start-str has been matched. |
|
String from which to start search. |
|
Option in HTTP header or URL parameter to match. Choices:
|
|
List of entries to match. |
|
Rule ID. see <a href=’#notes’>Notes</a>. |
|
Pattern string for matching target (Referrer or URL pattern). For example, a, a*c, *a*, a*c*e, and *. |
|
Pattern strings. |
|
Option in HTTP header or URL parameter to match. Choices:
|
|
Match criteria for collecting content ID. Choices:
|
|
WAN optimization content delivery network rule name. |
|
List of entries to skip. |
|
Rule ID. see <a href=’#notes’>Notes</a>. |
|
Pattern string for matching target (Referrer or URL pattern). For example, a, a*c, *a*, a*c*e, and *. |
|
Pattern strings. |
|
Option in HTTP header or URL parameter to match. Choices:
|
|
Skip mode when evaluating skip-rules. Choices:
|
|
Enable/disable WAN optimization content delivery network rules. Choices:
|
|
Enable/disable caching of text responses. Choices:
|
|
Enable/disable update server. Choices:
|
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure WAN optimization content delivery network rules.
fortinet.fortios.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: "0"
end_str: "<your_own_value>"
range_str: "<your_own_value>"
start_direction: "forward"
start_skip: "0"
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"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |