:source: fmgr_voip_profile_sip.py :orphan: .. _fmgr_voip_profile_sip: fmgr_voip_profile_sip -- SIP. +++++++++++++++++++++++++++++ .. versionadded:: 2.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. .. 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: v6.0.0 -> latest

Parameters ---------- .. raw:: html 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 tasks: - name: SIP. fortinet.fortimanager.fmgr_voip_profile_sip: # workspace_locking_adom: adom: profile: voip_profile_sip: # ack_rate: # 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: # call_keepalive: # cancel_rate: # contact_fixup: # hnt_restrict_source_ip: # hosted_nat_traversal: # info_rate: # invite_rate: # 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_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: # nat_trace: # no_sdp_fixup: # notify_rate: # open_contact_pinhole: # open_record_route_pinhole: # open_register_pinhole: # open_via_pinhole: # options_rate: # prack_rate: # preserve_override: # provisional_invite_expiry_time: # publish_rate: # refer_rate: # register_contact_trace: # register_rate: # 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: # unknown_header: # update_rate: # nat_port_range: # ack_rate_track: # bye_rate_track: # cancel_rate_track: # info_rate_track: # invite_rate_track: # malformed_header_no_proxy_require: # malformed_header_no_require: # message_rate_track: # notify_rate_track: # options_rate_track: # prack_rate_track: # publish_rate_track: # refer_rate_track: # register_rate_track: # subscribe_rate_track: # update_rate_track: # call_id_regex: # content_type_regex: 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)