fortios_wanopt_content_delivery_network_rule – Configure WAN optimization content delivery network rules in Fortinet’s FortiOS and FortiGate.
New in version 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
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- 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
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- wanopt_content_delivery_network_rule - Configure WAN optimization content delivery network rules. type: dict more...
- category - Content delivery network rule category. type: str choices: vcache, youtube more...
- comment - Comment about this CDN-rule. type: str more...
- host_domain_name_suffix - Suffix portion of the fully qualified domain name. For example, fortinet.com in "www.fortinet.com". type: list member_path: host_domain_name_suffix:name more...
- name - Suffix portion of the fully qualified domain name. type: str required: true more...
- name - Name of table. type: str required: true more...
- request_cache_control - Enable/disable HTTP request cache control. type: str choices: enable, disable more...
- response_cache_control - Enable/disable HTTP response cache control. type: str choices: enable, disable more...
- response_expires - Enable/disable HTTP response cache expires. type: str choices: enable, disable more...
- rules - WAN optimization content delivery network rule entries. type: list member_path: rules:name more...
- content_id - Content ID settings. type: dict more...
- end_direction - Search direction from end-str match. type: str choices: forward, backward more...
- end_skip - Number of characters in URL to skip after end-str has been matched. type: int more...
- end_str - String from which to end search. type: str more...
- range_str - Name of content ID within the start string and end string. type: str more...
- start_direction - Search direction from start-str match. type: str choices: forward, backward more...
- start_skip - Number of characters in URL to skip after start-str has been matched. type: int more...
- start_str - String from which to start search. type: str more...
- target - Option in HTTP header or URL parameter to match. type: str choices: path, parameter, referrer, youtube-map, youtube-id, youku-id, hls-manifest, dash-manifest, hls-fragment, dash-fragment more...
- match_entries - List of entries to match. type: list member_path: rules:name/match_entries:id more...
- id - Rule ID. see Notes. type: int required: true more...
- pattern - Pattern string for matching target (Referrer or URL pattern). For example, a, a*c, *a*, a*c*e, and *. type: list member_path: rules:name/match_entries:id/pattern:string more...
- string - Pattern strings. type: str required: true more...
- target - Option in HTTP header or URL parameter to match. type: str choices: path, parameter, referrer, youtube-map, youtube-id, youku-id more...
- match_mode - Match criteria for collecting content ID. type: str choices: all, any more...
- name - WAN optimization content delivery network rule name. type: str required: true more...
- skip_entries - List of entries to skip. type: list member_path: rules:name/skip_entries:id more...
- id - Rule ID. see Notes. type: int required: true more...
- pattern - Pattern string for matching target (Referrer or URL pattern). For example, a, a*c, *a*, a*c*e, and *. type: list member_path: rules:name/skip_entries:id/pattern:string more...
- string - Pattern strings. type: str required: true more...
- target - Option in HTTP header or URL parameter to match. type: str choices: path, parameter, referrer, youtube-map, youtube-id, youku-id more...
- skip_rule_mode - Skip mode when evaluating skip-rules. type: str choices: all, any more...
- status - Enable/disable WAN optimization content delivery network rules. type: str choices: enable, disable more...
- text_response_vcache - Enable/disable caching of text responses. type: str choices: enable, disable more...
- updateserver - Enable/disable update server. type: str choices: enable, disable more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
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: 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 fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate 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
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
This module is not guaranteed to have a backwards compatible interface.