fmgr_voip_profile_sip – SIP.¶
New in version 2.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 v6.x and v7.x.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.2.0 |
6.2.1 |
6.2.2 |
6.2.3 |
6.2.4 |
6.2.5 |
6.2.6 |
6.2.7 |
6.2.8 |
6.2.9 |
6.2.10 |
6.2.11 |
6.2.12 |
|
| True | True | True | True | None | True | True | True | True | True | True | True | True | |
6.4.0 |
6.4.1 |
6.4.2 |
6.4.3 |
6.4.4 |
6.4.5 |
6.4.6 |
6.4.7 |
6.4.8 |
6.4.9 |
6.4.10 |
6.4.11 |
6.4.12 |
6.4.13 |
| True | True | True | True | True | True | True | True | True | True | True | True | True | True |
7.0.0 |
7.0.1 |
7.0.2 |
7.0.3 |
7.0.4 |
7.0.5 |
7.0.6 |
7.0.7 |
7.0.8 |
7.0.9 |
7.0.10 |
|||
| True | True | True | True | True | True | True | True | True | True | True | |||
7.2.0 |
7.2.1 |
7.2.2 |
7.2.3 |
7.2.4 |
|||||||||
| True | True | True | True | True | |||||||||
7.4.0 |
7.4.1 |
||||||||||||
| True | True |
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
- 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
- profile - The parameter in requested url type: str required: true
- voip_profile_sip - SIP. type: dict
- ack-rate - ACK request rate limit (per second, per policy). type: int more...
- block-ack - Enable/disable block ACK requests. type: str choices: [disable, enable] more...
- block-bye - Enable/disable block BYE requests. type: str choices: [disable, enable] more...
- block-cancel - Enable/disable block CANCEL requests. type: str choices: [disable, enable] more...
- block-geo-red-options - Enable/disable block OPTIONS requests, but OPTIONS requests still notify for redundancy. type: str choices: [disable, enable] more...
- block-info - Enable/disable block INFO requests. type: str choices: [disable, enable] more...
- block-invite - Enable/disable block INVITE requests. type: str choices: [disable, enable] more...
- block-long-lines - Enable/disable block requests with headers exceeding max-line-length. type: str choices: [disable, enable] more...
- block-message - Enable/disable block MESSAGE requests. type: str choices: [disable, enable] more...
- block-notify - Enable/disable block NOTIFY requests. type: str choices: [disable, enable] more...
- block-options - Enable/disable block OPTIONS requests and no OPTIONS as notifying message for redundancy either. type: str choices: [disable, enable] more...
- block-prack - Enable/disable block prack requests. type: str choices: [disable, enable] more...
- block-publish - Enable/disable block PUBLISH requests. type: str choices: [disable, enable] more...
- block-refer - Enable/disable block REFER requests. type: str choices: [disable, enable] more...
- block-register - Enable/disable block REGISTER requests. type: str choices: [disable, enable] more...
- block-subscribe - Enable/disable block SUBSCRIBE requests. type: str choices: [disable, enable] more...
- block-unknown - Block unrecognized SIP requests (enabled by default). type: str choices: [disable, enable] more...
- block-update - Enable/disable block UPDATE requests. type: str choices: [disable, enable] more...
- bye-rate - BYE request rate limit (per second, per policy). type: int more...
- call-keepalive - Continue tracking calls with no RTP for this many minutes. type: int more...
- cancel-rate - CANCEL request rate limit (per second, per policy). type: int more...
- contact-fixup - Fixup contact anyway even if contacts IP:port doesnt match sessions IP:port. type: str choices: [disable, enable] more...
- 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...
- hosted-nat-traversal - Hosted NAT Traversal (HNT). type: str choices: [disable, enable] more...
- info-rate - INFO request rate limit (per second, per policy). type: int more...
- invite-rate - INVITE request rate limit (per second, per policy). type: int more...
- ips-rtp - Enable/disable allow IPS on RTP. type: str choices: [disable, enable] more...
- log-call-summary - Enable/disable logging of SIP call summary. type: str choices: [disable, enable] more...
- log-violations - Enable/disable logging of SIP violations. type: str choices: [disable, enable] more...
- malformed-header-allow - Action for malformed Allow header. type: str choices: [pass, discard, respond] more...
- malformed-header-call-id - Action for malformed Call-ID header. type: str choices: [pass, discard, respond] more...
- malformed-header-contact - Action for malformed Contact header. type: str choices: [pass, discard, respond] more...
- malformed-header-content-length - Action for malformed Content-Length header. type: str choices: [pass, discard, respond] more...
- malformed-header-content-type - Action for malformed Content-Type header. type: str choices: [pass, discard, respond] more...
- malformed-header-cseq - Action for malformed CSeq header. type: str choices: [pass, discard, respond] more...
- malformed-header-expires - Action for malformed Expires header. type: str choices: [pass, discard, respond] more...
- malformed-header-from - Action for malformed From header. type: str choices: [pass, discard, respond] more...
- malformed-header-max-forwards - Action for malformed Max-Forwards header. type: str choices: [pass, discard, respond] more...
- malformed-header-p-asserted-identity - Action for malformed P-Asserted-Identity header. type: str choices: [pass, discard, respond] more...
- malformed-header-rack - Action for malformed RAck header. type: str choices: [pass, discard, respond] more...
- malformed-header-record-route - Action for malformed Record-Route header. type: str choices: [pass, discard, respond] more...
- malformed-header-route - Action for malformed Route header. type: str choices: [pass, discard, respond] more...
- malformed-header-rseq - Action for malformed RSeq header. type: str choices: [pass, discard, respond] more...
- malformed-header-sdp-a - Action for malformed SDP a line. type: str choices: [pass, discard, respond] more...
- malformed-header-sdp-b - Action for malformed SDP b line. type: str choices: [pass, discard, respond] more...
- malformed-header-sdp-c - Action for malformed SDP c line. type: str choices: [pass, discard, respond] more...
- malformed-header-sdp-i - Action for malformed SDP i line. type: str choices: [pass, discard, respond] more...
- malformed-header-sdp-k - Action for malformed SDP k line. type: str choices: [pass, discard, respond] more...
- malformed-header-sdp-m - Action for malformed SDP m line. type: str choices: [pass, discard, respond] more...
- malformed-header-sdp-o - Action for malformed SDP o line. type: str choices: [pass, discard, respond] more...
- malformed-header-sdp-r - Action for malformed SDP r line. type: str choices: [pass, discard, respond] more...
- malformed-header-sdp-s - Action for malformed SDP s line. type: str choices: [pass, discard, respond] more...
- malformed-header-sdp-t - Action for malformed SDP t line. type: str choices: [pass, discard, respond] more...
- malformed-header-sdp-v - Action for malformed SDP v line. type: str choices: [pass, discard, respond] more...
- malformed-header-sdp-z - Action for malformed SDP z line. type: str choices: [pass, discard, respond] more...
- malformed-header-to - Action for malformed To header. type: str choices: [pass, discard, respond] more...
- malformed-header-via - Action for malformed VIA header. type: str choices: [pass, discard, respond] more...
- malformed-request-line - Action for malformed request line. type: str choices: [pass, discard, respond] more...
- max-body-length - Maximum SIP message body length (0 meaning no limit). type: int more...
- max-dialogs - Maximum number of concurrent calls/dialogs (per policy). type: int more...
- max-idle-dialogs - Maximum number established but idle dialogs to retain (per policy). type: int more...
- max-line-length - Maximum SIP header line length (78-4096). type: int more...
- message-rate - MESSAGE request rate limit (per second, per policy). type: int more...
- nat-trace - Enable/disable preservation of original IP in SDP i line. type: str choices: [disable, enable] more...
- no-sdp-fixup - Enable/disable no SDP fix-up. type: str choices: [disable, enable] more...
- notify-rate - NOTIFY request rate limit (per second, per policy). type: int more...
- open-contact-pinhole - Enable/disable open pinhole for non-REGISTER Contact port. type: str choices: [disable, enable] more...
- open-record-route-pinhole - Enable/disable open pinhole for Record-Route port. type: str choices: [disable, enable] more...
- open-register-pinhole - Enable/disable open pinhole for REGISTER Contact port. type: str choices: [disable, enable] more...
- open-via-pinhole - Enable/disable open pinhole for Via port. type: str choices: [disable, enable] more...
- options-rate - OPTIONS request rate limit (per second, per policy). type: int more...
- prack-rate - PRACK request rate limit (per second, per policy). type: int more...
- preserve-override - Override i line to preserve original IPS (default: append). type: str choices: [disable, enable] more...
- provisional-invite-expiry-time - Expiry time for provisional INVITE (10 - 3600 sec). type: int more...
- publish-rate - PUBLISH request rate limit (per second, per policy). type: int more...
- refer-rate - REFER request rate limit (per second, per policy). type: int more...
- register-contact-trace - Enable/disable trace original IP/port within the contact header of REGISTER requests. type: str choices: [disable, enable] more...
- register-rate - REGISTER request rate limit (per second, per policy). type: int more...
- rfc2543-branch - Enable/disable support via branch compliant with RFC 2543. type: str choices: [disable, enable] more...
- rtp - Enable/disable create pinholes for RTP traffic to traverse firewall. type: str choices: [disable, enable] more...
- ssl-algorithm - Relative strength of encryption algorithms accepted in negotiation. type: str choices: [high, medium, low] more...
- ssl-auth-client - Require a client certificate and authenticate it with the peer/peergrp. type: str more...
- ssl-auth-server - Authenticate the servers certificate with the peer/peergrp. type: str more...
- ssl-client-certificate - Name of Certificate to offer to server if requested. type: str more...
- ssl-client-renegotiation - Allow/block client renegotiation by server. type: str choices: [allow, deny, secure] more...
- 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...
- 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...
- ssl-mode - SSL/TLS mode for encryption & decryption of traffic. type: str choices: [off, full] more...
- ssl-pfs - SSL Perfect Forward Secrecy. type: str choices: [require, deny, allow] more...
- ssl-send-empty-frags - Send empty fragments to avoid attack on CBC IV (SSL 3. type: str choices: [disable, enable] more...
- ssl-server-certificate - Name of Certificate return to the client in every SSL connection. type: str more...
- status - Enable/disable SIP. type: str choices: [disable, enable] more...
- strict-register - Enable/disable only allow the registrar to connect. type: str choices: [disable, enable] more...
- subscribe-rate - SUBSCRIBE request rate limit (per second, per policy). type: int more...
- unknown-header - Action for unknown SIP header. type: str choices: [pass, discard, respond] more...
- update-rate - UPDATE request rate limit (per second, per policy). type: int more...
- nat-port-range - RTP NAT port range. type: str more...
- ack-rate-track - Track the packet protocol field. type: str choices: [none, src-ip, dest-ip] more...
- bye-rate-track - Track the packet protocol field. type: str choices: [none, src-ip, dest-ip] more...
- cancel-rate-track - Track the packet protocol field. type: str choices: [none, src-ip, dest-ip] more...
- info-rate-track - Track the packet protocol field. type: str choices: [none, src-ip, dest-ip] more...
- invite-rate-track - Track the packet protocol field. type: str choices: [none, src-ip, dest-ip] more...
- malformed-header-no-proxy-require - Action for malformed SIP messages without Proxy-Require header. type: str choices: [pass, discard, respond] more...
- malformed-header-no-require - Action for malformed SIP messages without Require header. type: str choices: [pass, discard, respond] more...
- message-rate-track - Track the packet protocol field. type: str choices: [none, src-ip, dest-ip] more...
- notify-rate-track - Track the packet protocol field. type: str choices: [none, src-ip, dest-ip] more...
- options-rate-track - Track the packet protocol field. type: str choices: [none, src-ip, dest-ip] more...
- prack-rate-track - Track the packet protocol field. type: str choices: [none, src-ip, dest-ip] more...
- publish-rate-track - Track the packet protocol field. type: str choices: [none, src-ip, dest-ip] more...
- refer-rate-track - Track the packet protocol field. type: str choices: [none, src-ip, dest-ip] more...
- register-rate-track - Track the packet protocol field. type: str choices: [none, src-ip, dest-ip] more...
- subscribe-rate-track - Track the packet protocol field. type: str choices: [none, src-ip, dest-ip] more...
- update-rate-track - Track the packet protocol field. type: str choices: [none, src-ip, dest-ip] more...
- call-id-regex - Validate PCRE regular expression for Call-Id header value. type: str more...
- content-type-regex - Validate PCRE regular expression for Content-Type header value. 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¶
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: SIP.
fmgr_voip_profile_sip:
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>
profile: <your own value>
voip_profile_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-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>
nat-port-range: <string>
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>
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 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0