Try SpotterSIP.
| "added in version" 2.0.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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: SIP.
fortinet.fortimanager.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>
adom:
description: The parameter (adom) in requested url.
required: true
type: str
profile:
description: The parameter (profile) in requested url.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str
voip_profile_sip:
description: The top level parameters set.
required: false
suboptions:
ack-rate:
description: Deprecated, please rename it to ack_rate. ACK request rate limit
type: int
ack-rate-track:
choices:
- none
- src-ip
- dest-ip
description: Deprecated, please rename it to ack_rate_track. Track the packet
protocol field.
type: str
block-ack:
choices:
- disable
- enable
description: Deprecated, please rename it to block_ack. Enable/disable block ACK
requests.
type: str
block-bye:
choices:
- disable
- enable
description: Deprecated, please rename it to block_bye. Enable/disable block BYE
requests.
type: str
block-cancel:
choices:
- disable
- enable
description: Deprecated, please rename it to block_cancel. Enable/disable block
CANCEL requests.
type: str
block-geo-red-options:
choices:
- disable
- enable
description: Deprecated, please rename it to block_geo_red_options. Enable/disable
block OPTIONS requests, but OPTIONS requests still n...
type: str
block-info:
choices:
- disable
- enable
description: Deprecated, please rename it to block_info. Enable/disable block
INFO requests.
type: str
block-invite:
choices:
- disable
- enable
description: Deprecated, please rename it to block_invite. Enable/disable block
INVITE requests.
type: str
block-long-lines:
choices:
- disable
- enable
description: Deprecated, please rename it to block_long_lines. Enable/disable
block requests with headers exceeding max-line-length.
type: str
block-message:
choices:
- disable
- enable
description: Deprecated, please rename it to block_message. Enable/disable block
MESSAGE requests.
type: str
block-notify:
choices:
- disable
- enable
description: Deprecated, please rename it to block_notify. Enable/disable block
NOTIFY requests.
type: str
block-options:
choices:
- disable
- enable
description: Deprecated, please rename it to block_options. Enable/disable block
OPTIONS requests and no OPTIONS as notifying message f...
type: str
block-prack:
choices:
- disable
- enable
description: Deprecated, please rename it to block_prack. Enable/disable block
prack requests.
type: str
block-publish:
choices:
- disable
- enable
description: Deprecated, please rename it to block_publish. Enable/disable block
PUBLISH requests.
type: str
block-refer:
choices:
- disable
- enable
description: Deprecated, please rename it to block_refer. Enable/disable block
REFER requests.
type: str
block-register:
choices:
- disable
- enable
description: Deprecated, please rename it to block_register. Enable/disable block
REGISTER requests.
type: str
block-subscribe:
choices:
- disable
- enable
description: Deprecated, please rename it to block_subscribe. Enable/disable block
SUBSCRIBE requests.
type: str
block-unknown:
choices:
- disable
- enable
description: Deprecated, please rename it to block_unknown. Block unrecognized
SIP requests
type: str
block-update:
choices:
- disable
- enable
description: Deprecated, please rename it to block_update. Enable/disable block
UPDATE requests.
type: str
bye-rate:
description: Deprecated, please rename it to bye_rate. BYE request rate limit
type: int
bye-rate-track:
choices:
- none
- src-ip
- dest-ip
description: Deprecated, please rename it to bye_rate_track. Track the packet
protocol field.
type: str
call-id-regex:
description: Deprecated, please rename it to call_id_regex. Validate PCRE regular
expression for Call-Id header value.
type: str
call-keepalive:
description: Deprecated, please rename it to call_keepalive. Continue tracking
calls with no RTP for this many minutes.
type: int
cancel-rate:
description: Deprecated, please rename it to cancel_rate. CANCEL request rate
limit
type: int
cancel-rate-track:
choices:
- none
- src-ip
- dest-ip
description: Deprecated, please rename it to cancel_rate_track. Track the packet
protocol field.
type: str
contact-fixup:
choices:
- disable
- enable
description: Deprecated, please rename it to contact_fixup. Fixup contact anyway
even if contacts IP
type: str
content-type-regex:
description: Deprecated, please rename it to content_type_regex. Validate PCRE
regular expression for Content-Type header value.
type: str
hnt-restrict-source-ip:
choices:
- disable
- enable
description: Deprecated, please rename it to hnt_restrict_source_ip. Enable/disable
restrict RTP source IP to be the same as SIP source...
type: str
hosted-nat-traversal:
choices:
- disable
- enable
description: Deprecated, please rename it to hosted_nat_traversal. Hosted NAT
Traversal
type: str
info-rate:
description: Deprecated, please rename it to info_rate. INFO request rate limit
type: int
info-rate-track:
choices:
- none
- src-ip
- dest-ip
description: Deprecated, please rename it to info_rate_track. Track the packet
protocol field.
type: str
invite-rate:
description: Deprecated, please rename it to invite_rate. INVITE request rate
limit
type: int
invite-rate-track:
choices:
- none
- src-ip
- dest-ip
description: Deprecated, please rename it to invite_rate_track. Track the packet
protocol field.
type: str
ips-rtp:
choices:
- disable
- enable
description: Deprecated, please rename it to ips_rtp. Enable/disable allow IPS
on RTP.
type: str
log-call-summary:
choices:
- disable
- enable
description: Deprecated, please rename it to log_call_summary. Enable/disable
logging of SIP call summary.
type: str
log-violations:
choices:
- disable
- enable
description: Deprecated, please rename it to log_violations. Enable/disable logging
of SIP violations.
type: str
malformed-header-allow:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_allow. Action for
malformed Allow header.
type: str
malformed-header-call-id:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_call_id. Action
for malformed Call-ID header.
type: str
malformed-header-contact:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_contact. Action
for malformed Contact header.
type: str
malformed-header-content-length:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_content_length.
Action for malformed Content-Length header.
type: str
malformed-header-content-type:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_content_type. Action
for malformed Content-Type header.
type: str
malformed-header-cseq:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_cseq. Action for
malformed CSeq header.
type: str
malformed-header-expires:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_expires. Action
for malformed Expires header.
type: str
malformed-header-from:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_from. Action for
malformed From header.
type: str
malformed-header-max-forwards:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_max_forwards. Action
for malformed Max-Forwards header.
type: str
malformed-header-no-proxy-require:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_no_proxy_require.
Action for malformed SIP messages without Proxy-Require...
type: str
malformed-header-no-require:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_no_require. Action
for malformed SIP messages without Require header.
type: str
malformed-header-p-asserted-identity:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_p_asserted_identity.
Action for malformed P-Asserted-Identity header.
type: str
malformed-header-rack:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_rack. Action for
malformed RAck header.
type: str
malformed-header-record-route:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_record_route. Action
for malformed Record-Route header.
type: str
malformed-header-route:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_route. Action for
malformed Route header.
type: str
malformed-header-rseq:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_rseq. Action for
malformed RSeq header.
type: str
malformed-header-sdp-a:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_sdp_a. Action for
malformed SDP a line.
type: str
malformed-header-sdp-b:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_sdp_b. Action for
malformed SDP b line.
type: str
malformed-header-sdp-c:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_sdp_c. Action for
malformed SDP c line.
type: str
malformed-header-sdp-i:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_sdp_i. Action for
malformed SDP i line.
type: str
malformed-header-sdp-k:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_sdp_k. Action for
malformed SDP k line.
type: str
malformed-header-sdp-m:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_sdp_m. Action for
malformed SDP m line.
type: str
malformed-header-sdp-o:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_sdp_o. Action for
malformed SDP o line.
type: str
malformed-header-sdp-r:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_sdp_r. Action for
malformed SDP r line.
type: str
malformed-header-sdp-s:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_sdp_s. Action for
malformed SDP s line.
type: str
malformed-header-sdp-t:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_sdp_t. Action for
malformed SDP t line.
type: str
malformed-header-sdp-v:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_sdp_v. Action for
malformed SDP v line.
type: str
malformed-header-sdp-z:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_sdp_z. Action for
malformed SDP z line.
type: str
malformed-header-to:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_to. Action for malformed
To header.
type: str
malformed-header-via:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_header_via. Action for
malformed VIA header.
type: str
malformed-request-line:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to malformed_request_line. Action for
malformed request line.
type: str
max-body-length:
description: Deprecated, please rename it to max_body_length. Maximum SIP message
body length
type: int
max-dialogs:
description: Deprecated, please rename it to max_dialogs. Maximum number of concurrent
calls/dialogs
type: int
max-idle-dialogs:
description: Deprecated, please rename it to max_idle_dialogs. Maximum number
established but idle dialogs to retain
type: int
max-line-length:
description: Deprecated, please rename it to max_line_length. Maximum SIP header
line length
type: int
message-rate:
description: Deprecated, please rename it to message_rate. MESSAGE request rate
limit
type: int
message-rate-track:
choices:
- none
- src-ip
- dest-ip
description: Deprecated, please rename it to message_rate_track. Track the packet
protocol field.
type: str
nat-port-range:
description: Deprecated, please rename it to nat_port_range. RTP NAT port range.
type: str
nat-trace:
choices:
- disable
- enable
description: Deprecated, please rename it to nat_trace. Enable/disable preservation
of original IP in SDP i line.
type: str
no-sdp-fixup:
choices:
- disable
- enable
description: Deprecated, please rename it to no_sdp_fixup. Enable/disable no SDP
fix-up.
type: str
notify-rate:
description: Deprecated, please rename it to notify_rate. NOTIFY request rate
limit
type: int
notify-rate-track:
choices:
- none
- src-ip
- dest-ip
description: Deprecated, please rename it to notify_rate_track. Track the packet
protocol field.
type: str
open-contact-pinhole:
choices:
- disable
- enable
description: Deprecated, please rename it to open_contact_pinhole. Enable/disable
open pinhole for non-REGISTER Contact port.
type: str
open-record-route-pinhole:
choices:
- disable
- enable
description: Deprecated, please rename it to open_record_route_pinhole. Enable/disable
open pinhole for Record-Route port.
type: str
open-register-pinhole:
choices:
- disable
- enable
description: Deprecated, please rename it to open_register_pinhole. Enable/disable
open pinhole for REGISTER Contact port.
type: str
open-via-pinhole:
choices:
- disable
- enable
description: Deprecated, please rename it to open_via_pinhole. Enable/disable
open pinhole for Via port.
type: str
options-rate:
description: Deprecated, please rename it to options_rate. OPTIONS request rate
limit
type: int
options-rate-track:
choices:
- none
- src-ip
- dest-ip
description: Deprecated, please rename it to options_rate_track. Track the packet
protocol field.
type: str
prack-rate:
description: Deprecated, please rename it to prack_rate. PRACK request rate limit
type: int
prack-rate-track:
choices:
- none
- src-ip
- dest-ip
description: Deprecated, please rename it to prack_rate_track. Track the packet
protocol field.
type: str
preserve-override:
choices:
- disable
- enable
description: Deprecated, please rename it to preserve_override. Override i line
to preserve original IPS
type: str
provisional-invite-expiry-time:
description: Deprecated, please rename it to provisional_invite_expiry_time. Expiry
time for provisional INVITE
type: int
publish-rate:
description: Deprecated, please rename it to publish_rate. PUBLISH request rate
limit
type: int
publish-rate-track:
choices:
- none
- src-ip
- dest-ip
description: Deprecated, please rename it to publish_rate_track. Track the packet
protocol field.
type: str
refer-rate:
description: Deprecated, please rename it to refer_rate. REFER request rate limit
type: int
refer-rate-track:
choices:
- none
- src-ip
- dest-ip
description: Deprecated, please rename it to refer_rate_track. Track the packet
protocol field.
type: str
register-contact-trace:
choices:
- disable
- enable
description: Deprecated, please rename it to register_contact_trace. Enable/disable
trace original IP/port within the contact header of...
type: str
register-rate:
description: Deprecated, please rename it to register_rate. REGISTER request rate
limit
type: int
register-rate-track:
choices:
- none
- src-ip
- dest-ip
description: Deprecated, please rename it to register_rate_track. Track the packet
protocol field.
type: str
rfc2543-branch:
choices:
- disable
- enable
description: Deprecated, please rename it to rfc2543_branch. Enable/disable support
via branch compliant with RFC 2543.
type: str
rtp:
choices:
- disable
- enable
description: Enable/disable create pinholes for RTP traffic to traverse firewall.
type: str
ssl-algorithm:
choices:
- high
- medium
- low
description: Deprecated, please rename it to ssl_algorithm. Relative strength
of encryption algorithms accepted in negotiation.
type: str
ssl-auth-client:
description: Deprecated, please rename it to ssl_auth_client. Require a client
certificate and authenticate it with the peer/peergrp.
type: str
ssl-auth-server:
description: Deprecated, please rename it to ssl_auth_server. Authenticate the
servers certificate with the peer/peergrp.
type: str
ssl-client-certificate:
description: Deprecated, please rename it to ssl_client_certificate. Name of Certificate
to offer to server if requested.
type: str
ssl-client-renegotiation:
choices:
- allow
- deny
- secure
description: Deprecated, please rename it to ssl_client_renegotiation. Allow/block
client renegotiation by server.
type: str
ssl-max-version:
choices:
- ssl-3.0
- tls-1.0
- tls-1.1
- tls-1.2
- tls-1.3
description: Deprecated, please rename it to ssl_max_version. Highest SSL/TLS
version to negotiate.
type: str
ssl-min-version:
choices:
- ssl-3.0
- tls-1.0
- tls-1.1
- tls-1.2
- tls-1.3
description: Deprecated, please rename it to ssl_min_version. Lowest SSL/TLS version
to negotiate.
type: str
ssl-mode:
choices:
- 'off'
- full
description: Deprecated, please rename it to ssl_mode. SSL/TLS mode for encryption
& decryption of traffic.
type: str
ssl-pfs:
choices:
- require
- deny
- allow
description: Deprecated, please rename it to ssl_pfs. SSL Perfect Forward Secrecy.
type: str
ssl-send-empty-frags:
choices:
- disable
- enable
description: Deprecated, please rename it to ssl_send_empty_frags. Send empty
fragments to avoid attack on CBC IV
type: str
ssl-server-certificate:
description: Deprecated, please rename it to ssl_server_certificate. Name of Certificate
return to the client in every SSL connection.
type: str
status:
choices:
- disable
- enable
description: Enable/disable SIP.
type: str
strict-register:
choices:
- disable
- enable
description: Deprecated, please rename it to strict_register. Enable/disable only
allow the registrar to connect.
type: str
subscribe-rate:
description: Deprecated, please rename it to subscribe_rate. SUBSCRIBE request
rate limit
type: int
subscribe-rate-track:
choices:
- none
- src-ip
- dest-ip
description: Deprecated, please rename it to subscribe_rate_track. Track the packet
protocol field.
type: str
unknown-header:
choices:
- pass
- discard
- respond
description: Deprecated, please rename it to unknown_header. Action for unknown
SIP header.
type: str
update-rate:
description: Deprecated, please rename it to update_rate. UPDATE request rate
limit
type: int
update-rate-track:
choices:
- none
- src-ip
- dest-ip
description: Deprecated, please rename it to update_rate_track. Track the packet
protocol field.
type: str
type: dict
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list