fmgr_telemetrycontroller_profile – Configure FortiTelemetry profiles.

Added in version 2.10.0.

Warning

Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).

  • Argument name before 3.0.0: var-name, var name, var.name

  • New argument name starting in 3.0.0: var_name

FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

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.6.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
  • revision_note - The change note that can be specified when an object is created or updated. type: string required: false
  • adom - The parameter in requested url type: str required: true
  • telemetrycontroller_profile - Configure FortiTelemetry profiles. type: dict
    • application Application. type: list more...
      • app_name (Alias name: app-name) Application name. type: list more...
      • app_throughput (Alias name: app-throughput) Application throughput in megabytes (0 - 10,000, default = 2 mb). type: int more...
      • atdt_threshold (Alias name: atdt-threshold) Threshold of application total downloading time in milliseconds (0 - 10,000,000, default = 20,000 ms). type: int more...
      • dns_time_threshold (Alias name: dns-time-threshold) Threshold of dns resolution time in milliseconds (0 - 10,000,000, default = 20 ms). type: int more...
      • experience_score_threshold (Alias name: experience-score-threshold) Threshold of experience score (0 - 10, default = 8). type: int more...
      • failure_rate_threshold (Alias name: failure-rate-threshold) Threshold of failure rate (0 - 100, default = 5 percentage). type: int more...
      • id Id. type: int more...
      • interval Time in milliseconds to check the application (1000 - 86,400 * 1000, default = 300 * 1000 ms). type: int more...
      • jitter_threshold (Alias name: jitter-threshold) Threshold of jitter in milliseconds (0 - 10,000,000, default = 20 ms). type: int more...
      • latency_threshold (Alias name: latency-threshold) Threshold of latency in milliseconds (0 - 10,000,000, default = 20 ms). type: int more...
      • monitor Enable/disable monitoring of the application. type: str choices: [disable, enable] more...
      • packet_loss_threshold (Alias name: packet-loss-threshold) Threshold of packet loss (0 - 100, default = 5 percentage). type: int more...
      • sla Sla. type: dict more...
        • app_throughput_threshold (Alias name: app-throughput-threshold) Threshold of application throughput in megabytes (0 - 10,000, default = 2 mb). type: int more...
        • atdt_threshold (Alias name: atdt-threshold) Threshold of application total downloading time in milliseconds (0 - 10,000,000, default = 3,000 ms). type: int more...
        • dns_time_threshold (Alias name: dns-time-threshold) Threshold of 95th percentile of dns resolution time in milliseconds (0 - 10,000,000, default = 100 ms). type: int more...
        • experience_score_threshold (Alias name: experience-score-threshold) Threshold of experience score (0 - 10, default = 6). type: int more...
        • failure_rate_threshold (Alias name: failure-rate-threshold) Threshold of failure rate (0 - 100, default = 5 percentage). type: int more...
        • jitter_threshold (Alias name: jitter-threshold) Threshold of jitter in milliseconds (0 - 10,000,000, default = 50 ms). type: int more...
        • latency_threshold (Alias name: latency-threshold) Threshold of latency in milliseconds (0 - 10,000,000, default = 100 ms). type: int more...
        • packet_loss_threshold (Alias name: packet-loss-threshold) Threshold of packet loss (0 - 100, default = 5 percentage). type: int more...
        • sla_factor (Alias name: sla-factor) Criteria on which metric to sla threshold list. type: list choices: [latency, jitter, packet-loss, experience-score, failure-rate, ttfb, atdt, tcp-rtt, dns-time, tls-time, app-throughput] more...
        • tcp_rtt_threshold (Alias name: tcp-rtt-threshold) Threshold of tcp round-trip time in milliseconds (0 - 10,000,000, default = 100 ms). type: int more...
        • tls_time_threshold (Alias name: tls-time-threshold) Threshold of 95th percentile of tls handshake time in milliseconds (0 - 10,000,000, default = 200 ms). type: int more...
        • ttfb_threshold (Alias name: ttfb-threshold) Threshold of time to first byte in milliseconds (0 - 10,000,000, default = 200 ms). type: int more...
      • tcp_rtt_threshold (Alias name: tcp-rtt-threshold) Threshold of tcp round-trip time in milliseconds (0 - 10,000,000, default = 20 ms). type: int more...
      • tls_time_threshold (Alias name: tls-time-threshold) Threshold of tls handshake time in milliseconds (0 - 10,000,000, default = 20 ms). type: int more...
      • ttfb_threshold (Alias name: ttfb-threshold) Threshold of time to first byte in milliseconds (0 - 10,000,000, default = 20 ms). type: int more...
    • comment Comment. type: str more...
    • name Name of the profile. type: str 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
  tasks:
    - name: Configure FortiTelemetry profiles.
      fortinet.fortimanager.fmgr_telemetrycontroller_profile:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        telemetrycontroller_profile:
          name: "your value" # Required variable, string
          # application:
          #   - app_name: <list or string>
          #     app_throughput: <integer>
          #     atdt_threshold: <integer>
          #     dns_time_threshold: <integer>
          #     experience_score_threshold: <integer>
          #     failure_rate_threshold: <integer>
          #     id: <integer>
          #     interval: <integer>
          #     jitter_threshold: <integer>
          #     latency_threshold: <integer>
          #     monitor: <value in [disable, enable]>
          #     packet_loss_threshold: <integer>
          #     sla:
          #       app_throughput_threshold: <integer>
          #       atdt_threshold: <integer>
          #       dns_time_threshold: <integer>
          #       experience_score_threshold: <integer>
          #       failure_rate_threshold: <integer>
          #       jitter_threshold: <integer>
          #       latency_threshold: <integer>
          #       packet_loss_threshold: <integer>
          #       sla_factor: ["latency", "jitter", "packet-loss", "experience-score",
          #                    "failure-rate", "ttfb", "atdt", "tcp-rtt", "dns-time", "tls-time",
          #                    "app-throughput"]
          #       tcp_rtt_threshold: <integer>
          #       tls_time_threshold: <integer>
          #       ttfb_threshold: <integer>
          #     tcp_rtt_threshold: <integer>
          #     tls_time_threshold: <integer>
          #     ttfb_threshold: <integer>
          # comment: <string>

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)