:source: fmgd_vpnsslweb_portal.py :orphan: .. _fmgd_vpnsslweb_portal: fmgd_vpnsslweb_portal -- Portal. ++++++++++++++++++++++++++++++++ .. 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 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: Portal. fortinet.fmgdevice.fmgd_vpnsslweb_portal: # bypass_validation: false # workspace_locking_adom: # workspace_locking_timeout: 300 # rc_succeeded: [0, -2, -3, ...] # rc_failed: [-2, -3, ...] device: vdom: state: present # vpnsslweb_portal: name: "your value" # Required variable, string # allow_user_access: # - "web" # - "ftp" # - "telnet" # - "smb" # - "vnc" # - "rdp" # - "ssh" # - "ping" # - "sftp" # - "portforward" # - "citrix" # auto_connect: # bookmark_group: # - bookmarks: # - additional_params: # apptype: # color_depth: # description: # domain: # folder: # form_data: # - name: # value: # height: # host: # keyboard_layout: # load_balancing_info: # logon_password: # logon_user: # name: # port: # preconnection_blob: # preconnection_id: # restricted_admin: # security: # send_preconnection_id: # sso: # sso_credential: # sso_credential_sent_once: # sso_password: # sso_username: # url: # vnc_keyboard_layout: # width: # server_layout: # remote_port: # show_status_window: # listening_port: # name: # client_src_range: # clipboard: # custom_lang: # customize_forticlient_download_url: # default_window_height: # default_window_width: # dhcp_ip_overlap: # dhcp_ra_giaddr: # dhcp6_ra_linkaddr: # display_bookmark: # display_connection_tools: # display_history: # display_status: # dns_server1: # dns_server2: # dns_suffix: # exclusive_routing: # forticlient_download: # forticlient_download_method: # heading: # hide_sso_credential: # host_check: # host_check_interval: # host_check_policy: # ip_mode: # ip_pools: # ipv6_dns_server1: # ipv6_dns_server2: # ipv6_exclusive_routing: # ipv6_pools: # ipv6_service_restriction: # ipv6_split_tunneling: # ipv6_split_tunneling_routing_address: # ipv6_split_tunneling_routing_negate: # ipv6_tunnel_mode: # ipv6_wins_server1: # ipv6_wins_server2: # keep_alive: # limit_user_logins: # mac_addr_action: # mac_addr_check: # mac_addr_check_rule: # - mac_addr_list: # mac_addr_mask: # name: # macos_forticlient_download_url: # os_check: # os_check_list: # action: # latest_patch_level: # name: # tolerance: # minor_version: # prefer_ipv6_dns: # redir_url: # rewrite_ip_uri_ui: # save_password: # service_restriction: # skip_check_for_browser: # skip_check_for_unsupported_os: # smb_max_version: # smb_min_version: # smb_ntlmv1_auth: # split_dns: # - dns_server1: # dns_server2: # domains: # id: # ipv6_dns_server1: # ipv6_dns_server2: # split_tunneling: # split_tunneling_routing_address: # split_tunneling_routing_negate: # theme: # tunnel_mode: # use_sdwan: # user_bookmark: # user_group_bookmark: # web_mode: # windows_forticlient_download_url: # wins_server1: # wins_server2: # landing_page: # form_data: # - name: # value: # sso: # sso_credential: # sso_password: # sso_username: # url: # landing_page_mode: # focus_bookmark: # default_protocol: # transform_backward_slashes: # skip_check_for_unsupported_browser: # dhcp_reservation: 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)