fortinet.fortimanager.fmgr_telemetrycontroller_profile module – Configure FortiTelemetry profiles.

Note

This module is part of the fortinet.fortimanager collection (version 2.10.0).

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.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_telemetrycontroller_profile.

New in fortinet.fortimanager 2.10.0

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter	Comments
access_token string	The token to access FortiManager without using username and password.
adom string / required	The parameter (adom) in requested url.
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: `false` ← (default) `true`
enable_log boolean	Enable/Disable logging for task. Choices: `false` ← (default) `true`
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
proposed_method string	The overridden method for the underlying Json RPC request. Choices: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
state string / required	The directive to create, update or delete an object. Choices: `"present"` `"absent"`
telemetrycontroller_profile dictionary	The top level parameters set.
application list / elements=dictionary	Application.
app_name aliases: app-name list / elements=string	Application name.
app_throughput aliases: app-throughput integer	Application throughput in megabytes
atdt_threshold aliases: atdt-threshold integer	Threshold of application total downloading time in milliseconds
dns_time_threshold aliases: dns-time-threshold integer	Threshold of DNS resolution time in milliseconds
experience_score_threshold aliases: experience-score-threshold integer	Threshold of experience score
failure_rate_threshold aliases: failure-rate-threshold integer	Threshold of failure rate
id integer	ID.
interval integer	Time in milliseconds to check the application
jitter_threshold aliases: jitter-threshold integer	Threshold of jitter in milliseconds
latency_threshold aliases: latency-threshold integer	Threshold of latency in milliseconds
monitor string	Enable/disable monitoring of the application. Choices: `"disable"` `"enable"`
packet_loss_threshold aliases: packet-loss-threshold integer	Threshold of packet loss
sla dictionary	Sla.
app_throughput_threshold aliases: app-throughput-threshold integer	Threshold of application throughput in megabytes
atdt_threshold aliases: atdt-threshold integer	Threshold of application total downloading time in milliseconds
dns_time_threshold aliases: dns-time-threshold integer	Threshold of 95th percentile of DNS resolution time in milliseconds
experience_score_threshold aliases: experience-score-threshold integer	Threshold of experience score
failure_rate_threshold aliases: failure-rate-threshold integer	Threshold of failure rate
jitter_threshold aliases: jitter-threshold integer	Threshold of jitter in milliseconds
latency_threshold aliases: latency-threshold integer	Threshold of latency in milliseconds
packet_loss_threshold aliases: packet-loss-threshold integer	Threshold of packet loss
sla_factor aliases: sla-factor list / elements=string	Criteria on which metric to SLA threshold list. Choices: `"latency"` `"jitter"` `"packet-loss"` `"experience-score"` `"failure-rate"` `"ttfb"` `"atdt"` `"tcp-rtt"` `"dns-time"` `"tls-time"` `"app-throughput"`
tcp_rtt_threshold aliases: tcp-rtt-threshold integer	Threshold of TCP round-trip time in milliseconds
tls_time_threshold aliases: tls-time-threshold integer	Threshold of 95th percentile of TLS handshake time in milliseconds
ttfb_threshold aliases: ttfb-threshold integer	Threshold of time to first byte in milliseconds
tcp_rtt_threshold aliases: tcp-rtt-threshold integer	Threshold of TCP round-trip time in milliseconds
tls_time_threshold aliases: tls-time-threshold integer	Threshold of TLS handshake time in milliseconds
ttfb_threshold aliases: ttfb-threshold integer	Threshold of time to first byte in milliseconds
comment string	Comment.
name string / required	Name of the profile.
workspace_locking_adom string	The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
workspace_locking_timeout integer	The maximum time in seconds to wait for other user to release the workspace lock. Default: `300`

Notes

Note

Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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 FortiTelemetry profiles.
      fortinet.fortimanager.fmgr_telemetrycontroller_profile:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        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 here, the following are the fields unique to this module:

Key	Description
meta dictionary	The result of the request. Returned: always
request_url string	The full url requested. Returned: always Sample: `"/sys/login/user"`
response_code integer	The status of api request. Returned: always Sample: `0`
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: `"OK."`
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: `0`
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_telemetrycontroller_profile_module.html