:source: fmgd_voip_profile_sip.py
:orphan:
.. _fmgd_voip_profile_sip:
fmgd_voip_profile_sip -- SIP.
+++++++++++++++++++++++++++++
.. versionadded:: 1.1.0
.. contents::
:local:
:depth: 1
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
----------------------------------
.. raw:: html
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
Parameters
----------
.. raw:: html
- 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
- 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
- vdom - The parameter in requested url type: str required: true
- profile - The parameter in requested url type: str required: true
- voip_profile_sip - SIP. type: dict
- ack_rate (Alias name: ack-rate) Ack request rate limit (per second, per policy). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ack_rate_track (Alias name: ack-rate-track) Track the packet protocol field. type: str choices: [none, src-ip, dest-ip]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- block_ack (Alias name: block-ack) Enable/disable block ack requests. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- block_bye (Alias name: block-bye) Enable/disable block bye requests. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- block_cancel (Alias name: block-cancel) Enable/disable block cancel requests. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- block_geo_red_options (Alias name: block-geo-red-options) Enable/disable block options requests, but options requests still notify for redundancy. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- block_info (Alias name: block-info) Enable/disable block info requests. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- block_invite (Alias name: block-invite) Enable/disable block invite requests. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- block_long_lines (Alias name: block-long-lines) Enable/disable block requests with headers exceeding max-line-length. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- block_message (Alias name: block-message) Enable/disable block message requests. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- block_notify (Alias name: block-notify) Enable/disable block notify requests. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- block_options (Alias name: block-options) Enable/disable block options requests and no options as notifying message for redundancy either. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- block_prack (Alias name: block-prack) Enable/disable block prack requests. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- block_publish (Alias name: block-publish) Enable/disable block publish requests. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- block_refer (Alias name: block-refer) Enable/disable block refer requests. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- block_register (Alias name: block-register) Enable/disable block register requests. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- block_subscribe (Alias name: block-subscribe) Enable/disable block subscribe requests. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- block_unknown (Alias name: block-unknown) Block unrecognized sip requests (enabled by default). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- block_update (Alias name: block-update) Enable/disable block update requests. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- bye_rate (Alias name: bye-rate) Bye request rate limit (per second, per policy). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- bye_rate_track (Alias name: bye-rate-track) Track the packet protocol field. type: str choices: [none, src-ip, dest-ip]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- call_id_regex (Alias name: call-id-regex) Validate pcre regular expression for call-id header value. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- call_keepalive (Alias name: call-keepalive) Continue tracking calls with no rtp for this many minutes. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- cancel_rate (Alias name: cancel-rate) Cancel request rate limit (per second, per policy). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- cancel_rate_track (Alias name: cancel-rate-track) Track the packet protocol field. type: str choices: [none, src-ip, dest-ip]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- contact_fixup (Alias name: contact-fixup) Fixup contact anyway even if contacts ip:port doesnt match sessions ip:port. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- content_type_regex (Alias name: content-type-regex) Validate pcre regular expression for content-type header value. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- hnt_restrict_source_ip (Alias name: hnt-restrict-source-ip) Enable/disable restrict rtp source ip to be the same as sip source ip when hnt is enabled. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- hosted_nat_traversal (Alias name: hosted-nat-traversal) Hosted nat traversal (hnt). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- info_rate (Alias name: info-rate) Info request rate limit (per second, per policy). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- info_rate_track (Alias name: info-rate-track) Track the packet protocol field. type: str choices: [none, src-ip, dest-ip]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- invite_rate (Alias name: invite-rate) Invite request rate limit (per second, per policy). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- invite_rate_track (Alias name: invite-rate-track) Track the packet protocol field. type: str choices: [none, src-ip, dest-ip]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ips_rtp (Alias name: ips-rtp) Enable/disable allow ips on rtp. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- log_call_summary (Alias name: log-call-summary) Enable/disable logging of sip call summary. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- log_violations (Alias name: log-violations) Enable/disable logging of sip violations. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_allow (Alias name: malformed-header-allow) Action for malformed allow header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_call_id (Alias name: malformed-header-call-id) Action for malformed call-id header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_contact (Alias name: malformed-header-contact) Action for malformed contact header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_content_length (Alias name: malformed-header-content-length) Action for malformed content-length header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_content_type (Alias name: malformed-header-content-type) Action for malformed content-type header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_cseq (Alias name: malformed-header-cseq) Action for malformed cseq header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_expires (Alias name: malformed-header-expires) Action for malformed expires header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_from (Alias name: malformed-header-from) Action for malformed from header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_max_forwards (Alias name: malformed-header-max-forwards) Action for malformed max-forwards header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_no_proxy_require (Alias name: malformed-header-no-proxy-require) Action for malformed sip messages without proxy-require header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_no_require (Alias name: malformed-header-no-require) Action for malformed sip messages without require header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_p_asserted_identity (Alias name: malformed-header-p-asserted-identity) Action for malformed p-asserted-identity header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_rack (Alias name: malformed-header-rack) Action for malformed rack header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_record_route (Alias name: malformed-header-record-route) Action for malformed record-route header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_route (Alias name: malformed-header-route) Action for malformed route header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_rseq (Alias name: malformed-header-rseq) Action for malformed rseq header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_sdp_a (Alias name: malformed-header-sdp-a) Action for malformed sdp a line. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_sdp_b (Alias name: malformed-header-sdp-b) Action for malformed sdp b line. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_sdp_c (Alias name: malformed-header-sdp-c) Action for malformed sdp c line. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_sdp_i (Alias name: malformed-header-sdp-i) Action for malformed sdp i line. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_sdp_k (Alias name: malformed-header-sdp-k) Action for malformed sdp k line. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_sdp_m (Alias name: malformed-header-sdp-m) Action for malformed sdp m line. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_sdp_o (Alias name: malformed-header-sdp-o) Action for malformed sdp o line. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_sdp_r (Alias name: malformed-header-sdp-r) Action for malformed sdp r line. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_sdp_s (Alias name: malformed-header-sdp-s) Action for malformed sdp s line. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_sdp_t (Alias name: malformed-header-sdp-t) Action for malformed sdp t line. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_sdp_v (Alias name: malformed-header-sdp-v) Action for malformed sdp v line. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_sdp_z (Alias name: malformed-header-sdp-z) Action for malformed sdp z line. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_to (Alias name: malformed-header-to) Action for malformed to header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_header_via (Alias name: malformed-header-via) Action for malformed via header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- malformed_request_line (Alias name: malformed-request-line) Action for malformed request line. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- max_body_length (Alias name: max-body-length) Maximum sip message body length (0 meaning no limit). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- max_dialogs (Alias name: max-dialogs) Maximum number of concurrent calls/dialogs (per policy). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- max_idle_dialogs (Alias name: max-idle-dialogs) Maximum number established but idle dialogs to retain (per policy). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- max_line_length (Alias name: max-line-length) Maximum sip header line length (78-4096). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- message_rate (Alias name: message-rate) Message request rate limit (per second, per policy). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- message_rate_track (Alias name: message-rate-track) Track the packet protocol field. type: str choices: [none, src-ip, dest-ip]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- nat_port_range (Alias name: nat-port-range) Rtp nat port range. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- nat_trace (Alias name: nat-trace) Enable/disable preservation of original ip in sdp i line. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- no_sdp_fixup (Alias name: no-sdp-fixup) Enable/disable no sdp fix-up. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- notify_rate (Alias name: notify-rate) Notify request rate limit (per second, per policy). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- notify_rate_track (Alias name: notify-rate-track) Track the packet protocol field. type: str choices: [none, src-ip, dest-ip]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- open_contact_pinhole (Alias name: open-contact-pinhole) Enable/disable open pinhole for non-register contact port. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- open_record_route_pinhole (Alias name: open-record-route-pinhole) Enable/disable open pinhole for record-route port. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- open_register_pinhole (Alias name: open-register-pinhole) Enable/disable open pinhole for register contact port. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- open_via_pinhole (Alias name: open-via-pinhole) Enable/disable open pinhole for via port. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- options_rate (Alias name: options-rate) Options request rate limit (per second, per policy). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- options_rate_track (Alias name: options-rate-track) Track the packet protocol field. type: str choices: [none, src-ip, dest-ip]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- prack_rate (Alias name: prack-rate) Prack request rate limit (per second, per policy). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- prack_rate_track (Alias name: prack-rate-track) Track the packet protocol field. type: str choices: [none, src-ip, dest-ip]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- preserve_override (Alias name: preserve-override) Override i line to preserve original ips (default: append). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- provisional_invite_expiry_time (Alias name: provisional-invite-expiry-time) Expiry time (10-3600, in seconds) for provisional invite. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- publish_rate (Alias name: publish-rate) Publish request rate limit (per second, per policy). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- publish_rate_track (Alias name: publish-rate-track) Track the packet protocol field. type: str choices: [none, src-ip, dest-ip]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- refer_rate (Alias name: refer-rate) Refer request rate limit (per second, per policy). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- refer_rate_track (Alias name: refer-rate-track) Track the packet protocol field. type: str choices: [none, src-ip, dest-ip]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- register_contact_trace (Alias name: register-contact-trace) Enable/disable trace original ip/port within the contact header of register requests. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- register_rate (Alias name: register-rate) Register request rate limit (per second, per policy). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- register_rate_track (Alias name: register-rate-track) Track the packet protocol field. type: str choices: [none, src-ip, dest-ip]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rfc2543_branch (Alias name: rfc2543-branch) Enable/disable support via branch compliant with rfc 2543. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- rtp Enable/disable create pinholes for rtp traffic to traverse firewall. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ssl_algorithm (Alias name: ssl-algorithm) Relative strength of encryption algorithms accepted in negotiation. type: str choices: [high, medium, low]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ssl_auth_client (Alias name: ssl-auth-client) Require a client certificate and authenticate it with the peer/peergrp. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ssl_auth_server (Alias name: ssl-auth-server) Authenticate the servers certificate with the peer/peergrp. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ssl_client_certificate (Alias name: ssl-client-certificate) Name of certificate to offer to server if requested. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ssl_client_renegotiation (Alias name: ssl-client-renegotiation) Allow/block client renegotiation by server. type: str choices: [allow, deny, secure]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ssl_max_version (Alias name: ssl-max-version) Highest ssl/tls version to negotiate. type: str choices: [ssl-3.0, tls-1.0, tls-1.1, tls-1.2, tls-1.3]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ssl_min_version (Alias name: ssl-min-version) Lowest ssl/tls version to negotiate. type: str choices: [ssl-3.0, tls-1.0, tls-1.1, tls-1.2, tls-1.3]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ssl_mode (Alias name: ssl-mode) Ssl/tls mode for encryption & decryption of traffic. type: str choices: [off, full]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ssl_pfs (Alias name: ssl-pfs) Ssl perfect forward secrecy. type: str choices: [require, deny, allow]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ssl_send_empty_frags (Alias name: ssl-send-empty-frags) Send empty fragments to avoid attack on cbc iv (ssl 3. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ssl_server_certificate (Alias name: ssl-server-certificate) Name of certificate return to the client in every ssl connection. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- status Enable/disable sip. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- strict_register (Alias name: strict-register) Enable/disable only allow the registrar to connect. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- subscribe_rate (Alias name: subscribe-rate) Subscribe request rate limit (per second, per policy). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- subscribe_rate_track (Alias name: subscribe-rate-track) Track the packet protocol field. type: str choices: [none, src-ip, dest-ip]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- unknown_header (Alias name: unknown-header) Action for unknown sip header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- update_rate (Alias name: update-rate) Update request rate limit (per second, per policy). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- update_rate_track (Alias name: update-rate-track) Track the packet protocol field. type: str choices: [none, src-ip, dest-ip]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
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
--------
.. code-block:: yaml+jinja
- 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: SIP.
fortinet.fmgdevice.fmgd_voip_profile_sip:
# bypass_validation: false
# workspace_locking_adom:
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device:
vdom:
profile:
voip_profile_sip:
# ack_rate:
# ack_rate_track:
# block_ack:
# block_bye:
# block_cancel:
# block_geo_red_options:
# block_info:
# block_invite:
# block_long_lines:
# block_message:
# block_notify:
# block_options:
# block_prack:
# block_publish:
# block_refer:
# block_register:
# block_subscribe:
# block_unknown:
# block_update:
# bye_rate:
# bye_rate_track:
# call_id_regex:
# call_keepalive:
# cancel_rate:
# cancel_rate_track:
# contact_fixup:
# content_type_regex:
# hnt_restrict_source_ip:
# hosted_nat_traversal:
# info_rate:
# info_rate_track:
# invite_rate:
# invite_rate_track:
# ips_rtp:
# log_call_summary:
# log_violations:
# malformed_header_allow:
# malformed_header_call_id:
# malformed_header_contact:
# malformed_header_content_length:
# malformed_header_content_type:
# malformed_header_cseq:
# malformed_header_expires:
# malformed_header_from:
# malformed_header_max_forwards:
# malformed_header_no_proxy_require:
# malformed_header_no_require:
# malformed_header_p_asserted_identity:
# malformed_header_rack:
# malformed_header_record_route:
# malformed_header_route:
# malformed_header_rseq:
# malformed_header_sdp_a:
# malformed_header_sdp_b:
# malformed_header_sdp_c:
# malformed_header_sdp_i:
# malformed_header_sdp_k:
# malformed_header_sdp_m:
# malformed_header_sdp_o:
# malformed_header_sdp_r:
# malformed_header_sdp_s:
# malformed_header_sdp_t:
# malformed_header_sdp_v:
# malformed_header_sdp_z:
# malformed_header_to:
# malformed_header_via:
# malformed_request_line:
# max_body_length:
# max_dialogs:
# max_idle_dialogs:
# max_line_length:
# message_rate:
# message_rate_track:
# nat_port_range:
# nat_trace:
# no_sdp_fixup:
# notify_rate:
# notify_rate_track:
# open_contact_pinhole:
# open_record_route_pinhole:
# open_register_pinhole:
# open_via_pinhole:
# options_rate:
# options_rate_track:
# prack_rate:
# prack_rate_track:
# preserve_override:
# provisional_invite_expiry_time:
# publish_rate:
# publish_rate_track:
# refer_rate:
# refer_rate_track:
# register_contact_trace:
# register_rate:
# register_rate_track:
# rfc2543_branch:
# rtp:
# ssl_algorithm:
# ssl_auth_client:
# ssl_auth_server:
# ssl_client_certificate:
# ssl_client_renegotiation:
# ssl_max_version:
# ssl_min_version:
# ssl_mode:
# ssl_pfs:
# ssl_send_empty_frags:
# ssl_server_certificate:
# status:
# strict_register:
# subscribe_rate:
# subscribe_rate_track:
# unknown_header:
# update_rate:
# update_rate_track:
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:
.. raw:: html
- 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)