- source
fmgr_voip_profile.py
- orphan
1.0.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.
- 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 v6.x and v7.x.
The below requirements are needed on the host that executes this module.
- ansible>=2.15.0
Supported Version Ranges: v6.0.0 -> latest
- 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
- adom - The parameter in requested url type: str required: true
- voip_profile - Configure VoIP profiles. type: dict
- comment Comment. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- name Profile name. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- sccp type: dict
- block_mcast (Alias name: block-mcast) Enable/disable block multicast rtp connections. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- log_call_summary (Alias name: log-call-summary) Enable/disable log summary of sccp calls. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- log_violations (Alias name: log-violations) Enable/disable logging of sccp violations. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- max_calls (Alias name: max-calls) Maximum calls per minute per sccp client (max 65535). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- status Enable/disable sccp. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- verify_header (Alias name: verify-header) Enable/disable verify sccp header content. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- block_mcast (Alias name: block-mcast) Enable/disable block multicast rtp connections. type: str choices: [disable, enable]
more...
- sip type: dict
- ack_rate (Alias name: ack-rate) Ack request rate limit (per second, per policy). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- block_ack (Alias name: block-ack) Enable/disable block ack requests. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- block_bye (Alias name: block-bye) Enable/disable block bye requests. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- block_cancel (Alias name: block-cancel) Enable/disable block cancel requests. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- block_info (Alias name: block-info) Enable/disable block info requests. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- block_invite (Alias name: block-invite) Enable/disable block invite requests. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- block_message (Alias name: block-message) Enable/disable block message requests. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- block_notify (Alias name: block-notify) Enable/disable block notify requests. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- block_prack (Alias name: block-prack) Enable/disable block prack requests. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- block_publish (Alias name: block-publish) Enable/disable block publish requests. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- block_refer (Alias name: block-refer) Enable/disable block refer requests. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- block_register (Alias name: block-register) Enable/disable block register requests. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- block_subscribe (Alias name: block-subscribe) Enable/disable block subscribe requests. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- block_unknown (Alias name: block-unknown) Block unrecognized sip requests (enabled by default). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- block_update (Alias name: block-update) Enable/disable block update requests. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- bye_rate (Alias name: bye-rate) Bye request rate limit (per second, per policy). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- call_keepalive (Alias name: call-keepalive) Continue tracking calls with no rtp for this many minutes. type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- cancel_rate (Alias name: cancel-rate) Cancel request rate limit (per second, per policy). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- hosted_nat_traversal (Alias name: hosted-nat-traversal) Hosted nat traversal (hnt). type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- info_rate (Alias name: info-rate) Info request rate limit (per second, per policy). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- invite_rate (Alias name: invite-rate) Invite request rate limit (per second, per policy). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- ips_rtp (Alias name: ips-rtp) Enable/disable allow ips on rtp. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- log_violations (Alias name: log-violations) Enable/disable logging of sip violations. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- malformed_header_allow (Alias name: malformed-header-allow) Action for malformed allow header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- malformed_header_contact (Alias name: malformed-header-contact) Action for malformed contact header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- malformed_header_cseq (Alias name: malformed-header-cseq) Action for malformed cseq header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- malformed_header_expires (Alias name: malformed-header-expires) Action for malformed expires header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- malformed_header_from (Alias name: malformed-header-from) Action for malformed from header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- malformed_header_rack (Alias name: malformed-header-rack) Action for malformed rack header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- malformed_header_route (Alias name: malformed-header-route) Action for malformed route header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- malformed_header_rseq (Alias name: malformed-header-rseq) Action for malformed rseq header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- malformed_header_to (Alias name: malformed-header-to) Action for malformed to header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- malformed_header_via (Alias name: malformed-header-via) Action for malformed via header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- malformed_request_line (Alias name: malformed-request-line) Action for malformed request line. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- max_body_length (Alias name: max-body-length) Maximum sip message body length (0 meaning no limit). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- max_dialogs (Alias name: max-dialogs) Maximum number of concurrent calls/dialogs (per policy). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- max_line_length (Alias name: max-line-length) Maximum sip header line length (78-4096). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- message_rate (Alias name: message-rate) Message request rate limit (per second, per policy). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- nat_port_range (Alias name: nat-port-range) Rtp nat port range. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- no_sdp_fixup (Alias name: no-sdp-fixup) Enable/disable no sdp fix-up. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- notify_rate (Alias name: notify-rate) Notify request rate limit (per second, per policy). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- options_rate (Alias name: options-rate) Options request rate limit (per second, per policy). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- prack_rate (Alias name: prack-rate) Prack request rate limit (per second, per policy). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- provisional_invite_expiry_time (Alias name: provisional-invite-expiry-time) Expiry time for provisional invite (10 - 3600 sec). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- publish_rate (Alias name: publish-rate) Publish request rate limit (per second, per policy). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- refer_rate (Alias name: refer-rate) Refer request rate limit (per second, per policy). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- register_rate (Alias name: register-rate) Register request rate limit (per second, per policy). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- rtp Enable/disable create pinholes for rtp traffic to traverse firewall. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- ssl_auth_client (Alias name: ssl-auth-client) Require a client certificate and authenticate it with the peer/peergrp. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- ssl_auth_server (Alias name: ssl-auth-server) Authenticate the servers certificate with the peer/peergrp. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- ssl_client_certificate (Alias name: ssl-client-certificate) Name of certificate to offer to server if requested. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- ssl_mode (Alias name: ssl-mode) Ssl/tls mode for encryption & decryption of traffic. type: str choices: [off, full]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- ssl_pfs (Alias name: ssl-pfs) Ssl perfect forward secrecy. type: str choices: [require, deny, allow]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- ssl_server_certificate (Alias name: ssl-server-certificate) Name of certificate return to the client in every ssl connection. type: str
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- status Enable/disable sip. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- strict_register (Alias name: strict-register) Enable/disable only allow the registrar to connect. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- subscribe_rate (Alias name: subscribe-rate) Subscribe request rate limit (per second, per policy). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- unknown_header (Alias name: unknown-header) Action for unknown sip header. type: str choices: [pass, discard, respond]
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> latest
- update_rate (Alias name: update-rate) Update request rate limit (per second, per policy). type: int
more...
Supported Version Ranges:
v6.2.8 -> v6.2.12
,v6.4.5 -> 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.0.0 -> 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.0.0 -> 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.0.0 -> 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.0.0 -> 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.0.0 -> 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.0.0 -> 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.0.0 -> 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.0.0 -> 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.0.0 -> 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.0.0 -> 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.0.0 -> 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.0.0 -> 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.0.0 -> 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.0.0 -> 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.0.0 -> 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.0.0 -> 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.2.3 -> 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.2.3 -> latest
- ack_rate (Alias name: ack-rate) Ack request rate limit (per second, per policy). type: int
more...
- feature_set (Alias name: feature-set) Flow or proxy inspection feature set. type: str choices: [flow, proxy, ips, voipd]
more...
Supported Version Ranges:
v7.0.0 -> latest
- msrp type: dict
- log_violations (Alias name: log-violations) Enable/disable logging of msrp violations. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- max_msg_size (Alias name: max-msg-size) Maximum allowable msrp message size (1-65535). type: int
more...
Supported Version Ranges:
v7.0.2 -> latest
- max_msg_size_action (Alias name: max-msg-size-action) Action for violation of max-msg-size. type: str choices: [pass, block, reset, monitor]
more...
Supported Version Ranges:
v7.0.2 -> latest
- status Enable/disable msrp. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- log_violations (Alias name: log-violations) Enable/disable logging of msrp violations. type: str choices: [disable, enable]
more...
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
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure VoIP profiles.
fortinet.fortimanager.fmgr_voip_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]>
voip_profile:
comment: <string>
name: <string>
sccp:
block_mcast: <value in [disable, enable]>
log_call_summary: <value in [disable, enable]>
log_violations: <value in [disable, enable]>
max_calls: <integer>
status: <value in [disable, enable]>
verify_header: <value in [disable, enable]>
sip:
ack_rate: <integer>
block_ack: <value in [disable, enable]>
block_bye: <value in [disable, enable]>
block_cancel: <value in [disable, enable]>
block_geo_red_options: <value in [disable, enable]>
block_info: <value in [disable, enable]>
block_invite: <value in [disable, enable]>
block_long_lines: <value in [disable, enable]>
block_message: <value in [disable, enable]>
block_notify: <value in [disable, enable]>
block_options: <value in [disable, enable]>
block_prack: <value in [disable, enable]>
block_publish: <value in [disable, enable]>
block_refer: <value in [disable, enable]>
block_register: <value in [disable, enable]>
block_subscribe: <value in [disable, enable]>
block_unknown: <value in [disable, enable]>
block_update: <value in [disable, enable]>
bye_rate: <integer>
call_keepalive: <integer>
cancel_rate: <integer>
contact_fixup: <value in [disable, enable]>
hnt_restrict_source_ip: <value in [disable, enable]>
hosted_nat_traversal: <value in [disable, enable]>
info_rate: <integer>
invite_rate: <integer>
ips_rtp: <value in [disable, enable]>
log_call_summary: <value in [disable, enable]>
log_violations: <value in [disable, enable]>
malformed_header_allow: <value in [pass, discard, respond]>
malformed_header_call_id: <value in [pass, discard, respond]>
malformed_header_contact: <value in [pass, discard, respond]>
malformed_header_content_length: <value in [pass, discard, respond]>
malformed_header_content_type: <value in [pass, discard, respond]>
malformed_header_cseq: <value in [pass, discard, respond]>
malformed_header_expires: <value in [pass, discard, respond]>
malformed_header_from: <value in [pass, discard, respond]>
malformed_header_max_forwards: <value in [pass, discard, respond]>
malformed_header_p_asserted_identity: <value in [pass, discard, respond]>
malformed_header_rack: <value in [pass, discard, respond]>
malformed_header_record_route: <value in [pass, discard, respond]>
malformed_header_route: <value in [pass, discard, respond]>
malformed_header_rseq: <value in [pass, discard, respond]>
malformed_header_sdp_a: <value in [pass, discard, respond]>
malformed_header_sdp_b: <value in [pass, discard, respond]>
malformed_header_sdp_c: <value in [pass, discard, respond]>
malformed_header_sdp_i: <value in [pass, discard, respond]>
malformed_header_sdp_k: <value in [pass, discard, respond]>
malformed_header_sdp_m: <value in [pass, discard, respond]>
malformed_header_sdp_o: <value in [pass, discard, respond]>
malformed_header_sdp_r: <value in [pass, discard, respond]>
malformed_header_sdp_s: <value in [pass, discard, respond]>
malformed_header_sdp_t: <value in [pass, discard, respond]>
malformed_header_sdp_v: <value in [pass, discard, respond]>
malformed_header_sdp_z: <value in [pass, discard, respond]>
malformed_header_to: <value in [pass, discard, respond]>
malformed_header_via: <value in [pass, discard, respond]>
malformed_request_line: <value in [pass, discard, respond]>
max_body_length: <integer>
max_dialogs: <integer>
max_idle_dialogs: <integer>
max_line_length: <integer>
message_rate: <integer>
nat_port_range: <string>
nat_trace: <value in [disable, enable]>
no_sdp_fixup: <value in [disable, enable]>
notify_rate: <integer>
open_contact_pinhole: <value in [disable, enable]>
open_record_route_pinhole: <value in [disable, enable]>
open_register_pinhole: <value in [disable, enable]>
open_via_pinhole: <value in [disable, enable]>
options_rate: <integer>
prack_rate: <integer>
preserve_override: <value in [disable, enable]>
provisional_invite_expiry_time: <integer>
publish_rate: <integer>
refer_rate: <integer>
register_contact_trace: <value in [disable, enable]>
register_rate: <integer>
rfc2543_branch: <value in [disable, enable]>
rtp: <value in [disable, enable]>
ssl_algorithm: <value in [high, medium, low]>
ssl_auth_client: <string>
ssl_auth_server: <string>
ssl_client_certificate: <string>
ssl_client_renegotiation: <value in [allow, deny, secure]>
ssl_max_version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
ssl_min_version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
ssl_mode: <value in [off, full]>
ssl_pfs: <value in [require, deny, allow]>
ssl_send_empty_frags: <value in [disable, enable]>
ssl_server_certificate: <string>
status: <value in [disable, enable]>
strict_register: <value in [disable, enable]>
subscribe_rate: <integer>
unknown_header: <value in [pass, discard, respond]>
update_rate: <integer>
ack_rate_track: <value in [none, src-ip, dest-ip]>
bye_rate_track: <value in [none, src-ip, dest-ip]>
cancel_rate_track: <value in [none, src-ip, dest-ip]>
info_rate_track: <value in [none, src-ip, dest-ip]>
invite_rate_track: <value in [none, src-ip, dest-ip]>
malformed_header_no_proxy_require: <value in [pass, discard, respond]>
malformed_header_no_require: <value in [pass, discard, respond]>
message_rate_track: <value in [none, src-ip, dest-ip]>
notify_rate_track: <value in [none, src-ip, dest-ip]>
options_rate_track: <value in [none, src-ip, dest-ip]>
prack_rate_track: <value in [none, src-ip, dest-ip]>
publish_rate_track: <value in [none, src-ip, dest-ip]>
refer_rate_track: <value in [none, src-ip, dest-ip]>
register_rate_track: <value in [none, src-ip, dest-ip]>
subscribe_rate_track: <value in [none, src-ip, dest-ip]>
update_rate_track: <value in [none, src-ip, dest-ip]>
call_id_regex: <string>
content_type_regex: <string>
feature_set: <value in [flow, proxy, ips, ...]>
msrp:
log_violations: <value in [disable, enable]>
max_msg_size: <integer>
max_msg_size_action: <value in [pass, block, reset, ...]>
status: <value in [disable, enable]>
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
- This module is not guaranteed to have a backwards compatible interface.
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)