Try SpotterConfigure WAN optimization content delivery network rules in Fortinet's FortiOS and FortiGate.
| "added in version" 2.9 of ansible.builtin"
Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)
preview | supported by community
pipInstall with pip install ansible==2.9.27
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.5
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
ssl_verify: "False"
tasks:
- name: Configure WAN optimization content delivery network rules.
fortios_wanopt_content_delivery_network_rule:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
state: "present"
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"
host:
description:
- FortiOS or FortiGate IP address.
required: false
type: str
vdom:
default: root
description:
- 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
https:
default: true
description:
- Indicates if the requests towards FortiGate must use HTTPS protocol.
type: bool
state:
choices:
- present
- absent
description:
- Indicates whether to create or remove the object.
required: true
type: str
password:
default: ''
description:
- FortiOS or FortiGate password.
type: str
username:
description:
- FortiOS or FortiGate username.
required: false
type: str
ssl_verify:
default: true
description:
- Ensures FortiGate certificate must be verified by a proper CA.
type: bool
wanopt_content_delivery_network_rule:
default: null
description:
- Configure WAN optimization content delivery network rules.
suboptions:
category:
choices:
- vcache
- youtube
description:
- Content delivery network rule category.
type: str
comment:
description:
- Comment about this CDN-rule.
type: str
host_domain_name_suffix:
description:
- Suffix portion of the fully qualified domain name (eg. fortinet.com in "www.fortinet.com").
suboptions:
name:
description:
- Suffix portion of the fully qualified domain name.
required: true
type: str
type: list
name:
description:
- Name of table.
required: true
type: str
request_cache_control:
choices:
- enable
- disable
description:
- Enable/disable HTTP request cache control.
type: str
response_cache_control:
choices:
- enable
- disable
description:
- Enable/disable HTTP response cache control.
type: str
response_expires:
choices:
- enable
- disable
description:
- Enable/disable HTTP response cache expires.
type: str
rules:
description:
- WAN optimization content delivery network rule entries.
suboptions:
content_id:
description:
- Content ID settings.
suboptions:
end_direction:
choices:
- forward
- backward
description:
- Search direction from end-str match.
type: str
end_skip:
description:
- Number of characters in URL to skip after end-str has been matched.
type: int
end_str:
description:
- String from which to end search.
type: str
range_str:
description:
- Name of content ID within the start string and end string.
type: str
start_direction:
choices:
- forward
- backward
description:
- Search direction from start-str match.
type: str
start_skip:
description:
- Number of characters in URL to skip after start-str has been matched.
type: int
start_str:
description:
- String from which to start search.
type: str
target:
choices:
- path
- parameter
- referrer
- youtube-map
- youtube-id
- youku-id
- hls-manifest
- dash-manifest
- hls-fragment
- dash-fragment
description:
- Option in HTTP header or URL parameter to match.
type: str
type: dict
match_entries:
description:
- List of entries to match.
suboptions:
id:
description:
- Rule ID.
required: true
type: int
pattern:
description:
- Pattern string for matching target (Referrer or URL pattern, eg. "a",
"a*c", "*a*", "a*c*e", and "*").
suboptions:
string:
description:
- Pattern strings.
required: true
type: str
type: list
target:
choices:
- path
- parameter
- referrer
- youtube-map
- youtube-id
- youku-id
description:
- Option in HTTP header or URL parameter to match.
type: str
type: list
match_mode:
choices:
- all
- any
description:
- Match criteria for collecting content ID.
type: str
name:
description:
- WAN optimization content delivery network rule name.
required: true
type: str
skip_entries:
description:
- List of entries to skip.
suboptions:
id:
description:
- Rule ID.
required: true
type: int
pattern:
description:
- Pattern string for matching target (Referrer or URL pattern, eg. "a",
"a*c", "*a*", "a*c*e", and "*").
suboptions:
string:
description:
- Pattern strings.
required: true
type: str
type: list
target:
choices:
- path
- parameter
- referrer
- youtube-map
- youtube-id
- youku-id
description:
- Option in HTTP header or URL parameter to match.
type: str
type: list
skip_rule_mode:
choices:
- all
- any
description:
- Skip mode when evaluating skip-rules.
type: str
type: list
status:
choices:
- enable
- disable
description:
- Enable/disable WAN optimization content delivery network rules.
type: str
text_response_vcache:
choices:
- enable
- disable
description:
- Enable/disable caching of text responses.
type: str
updateserver:
choices:
- enable
- disable
description:
- Enable/disable update server.
type: str
type: dict
build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: PUT type: str http_status: description: Last result given by FortiGate on last operation applied returned: always sample: '200' type: str mkey: description: Master key (id) used in the last call to FortiGate returned: success sample: id type: str name: description: Name of the table used to fulfill the request returned: always sample: urlfilter type: str path: description: Path of the table used to fulfill the request returned: always sample: webfilter type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str