fmgd_wanopt_contentdeliverynetworkrule – Configure WAN optimization content delivery network rules.

Added in version 1.0.0.

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values need to be adjusted to data sources before usage.

  • Tested with FortiManager v7.x.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • device - The parameter in requested url type: str required: true
  • wanopt_contentdeliverynetworkrule - Configure WAN optimization content delivery network rules. type: dict
    • 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 (Alias name: host-domain-name-suffix) Suffix portion of the fully qualified domain name. type: list more...
    • name Name of table. type: str more...
    • request_cache_control (Alias name: request-cache-control) Enable/disable http request cache control. type: str choices: [disable, enable] more...
    • response_cache_control (Alias name: response-cache-control) Enable/disable http response cache control. type: str choices: [disable, enable] more...
    • response_expires (Alias name: response-expires) Enable/disable http response cache expires. type: str choices: [disable, enable] more...
    • rules Rules. type: list more...
      • content_id (Alias name: content-id) Content id. type: dict more...
        • end_direction (Alias name: end-direction) Search direction from end-str match. type: str choices: [forward, backward] more...
        • end_skip (Alias name: end-skip) Number of characters in url to skip after end-str has been matched. type: int more...
        • end_str (Alias name: end-str) String from which to end search. type: str more...
        • range_str (Alias name: range-str) Name of content id within the start string and end string. type: str more...
        • start_direction (Alias name: start-direction) Search direction from start-str match. type: str choices: [forward, backward] more...
        • start_skip (Alias name: start-skip) Number of characters in url to skip after start-str has been matched. type: int more...
        • start_str (Alias name: 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 (Alias name: match-entries) Match entries. type: list more...
        • id Rule id. type: int more...
        • pattern Pattern string for matching target (referrer or url pattern). type: list 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 (Alias name: match-mode) Match criteria for collecting content id. type: str choices: [any, all] more...
      • name Wan optimization content delivery network rule name. type: str more...
      • skip_entries (Alias name: skip-entries) Skip entries. type: list more...
        • id Rule id. type: int more...
        • pattern Pattern string for matching target (referrer or url pattern). type: list 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 (Alias name: skip-rule-mode) Skip mode when evaluating skip-rules. type: str choices: [any, all] more...
    • status Enable/disable wan optimization content delivery network rules. type: str choices: [disable, enable] more...
    • text_response_vcache (Alias name: text-response-vcache) Enable/disable caching of text responses. type: str choices: [disable, enable] more...
    • updateserver Enable/disable update server. type: str choices: [disable, enable] more...

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state: present directive.

  • To delete an object, use state: absent directive

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure WAN optimization content delivery network rules.
      fortinet.fmgdevice.fmgd_wanopt_contentdeliverynetworkrule:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        state: present # <value in [present, absent]>
        wanopt_contentdeliverynetworkrule:
          name: "your value" # Required variable, string
          # category: <value in [vcache, youtube]>
          # comment: <string>
          # host_domain_name_suffix: <list or string>
          # request_cache_control: <value in [disable, enable]>
          # response_cache_control: <value in [disable, enable]>
          # response_expires: <value in [disable, enable]>
          # rules:
          #   - content_id:
          #       end_direction: <value in [forward, backward]>
          #       end_skip: <integer>
          #       end_str: <string>
          #       range_str: <string>
          #       start_direction: <value in [forward, backward]>
          #       start_skip: <integer>
          #       start_str: <string>
          #       target: <value in [path, parameter, referrer, ...]>
          #     match_entries:
          #       - id: <integer>
          #         pattern: <list or string>
          #         target: <value in [path, parameter, referrer, ...]>
          #     match_mode: <value in [any, all]>
          #     name: <string>
          #     skip_entries:
          #       - id: <integer>
          #         pattern: <list or string>
          #         target: <value in [path, parameter, referrer, ...]>
          #     skip_rule_mode: <value in [any, all]>
          # status: <value in [disable, enable]>
          # text_response_vcache: <value in [disable, enable]>
          # updateserver: <value in [disable, 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:

  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)