fortinet.fortimanager.fmgr_vpnsslweb_portal (2.4.0) — module

Portal.

| "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 collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0


Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

Description

This module is able to configure a FortiManager device.

Examples include all parameters and values which need to be adjusted to data sources before usage.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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: Portal.
      fortinet.fortimanager.fmgr_vpnsslweb_portal:
        # 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]>
        vpnsslweb_portal:
          allow_user_access:
            - web
            - ftp
            - telnet
            - smb
            - vnc
            - rdp
            - ssh
            - ping
            - citrix
            - portforward
            - sftp
          auto_connect: <value in [disable, enable]>
          bookmark_group:
            -
              bookmarks:
                -
                  additional_params: <string>
                  apptype: <value in [web, telnet, ssh, ...]>
                  description: <string>
                  folder: <string>
                  form_data:
                    -
                      name: <string>
                      value: <string>
                  host: <string>
                  listening_port: <integer>
                  load_balancing_info: <string>
                  logon_password: <list or string>
                  logon_user: <string>
                  name: <string>
                  port: <integer>
                  preconnection_blob: <string>
                  preconnection_id: <integer>
                  remote_port: <integer>
                  security: <value in [rdp, nla, tls, ...]>
                  server_layout: <value in [en-us-qwerty, de-de-qwertz, fr-fr-azerty, ...]>
                  show_status_window: <value in [disable, enable]>
                  sso: <value in [disable, static, auto]>
                  sso_credential: <value in [sslvpn-login, alternative]>
                  sso_credential_sent_once: <value in [disable, enable]>
                  sso_password: <list or string>
                  sso_username: <string>
                  url: <string>
                  domain: <string>
                  color_depth: <value in [8, 16, 32]>
                  height: <integer>
                  keyboard_layout: <value in [ar, da, de, ...]>
                  restricted_admin: <value in [disable, enable]>
                  send_preconnection_id: <value in [disable, enable]>
                  width: <integer>
                  vnc_keyboard_layout: <value in [da, de, de-ch, ...]>
              name: <string>
          custom_lang: <string>
          customize_forticlient_download_url: <value in [disable, enable]>
          display_bookmark: <value in [disable, enable]>
          display_connection_tools: <value in [disable, enable]>
          display_history: <value in [disable, enable]>
          display_status: <value in [disable, enable]>
          dns_server1: <string>
          dns_server2: <string>
          dns_suffix: <string>
          exclusive_routing: <value in [disable, enable]>
          forticlient_download: <value in [disable, enable]>
          forticlient_download_method: <value in [direct, ssl-vpn]>
          heading: <string>
          hide_sso_credential: <value in [disable, enable]>
          host_check: <value in [none, av, fw, ...]>
          host_check_interval: <integer>
          host_check_policy: <list or string>
          ip_mode: <value in [range, user-group, dhcp, ...]>
          ip_pools: <list or string>
          ipv6_dns_server1: <string>
          ipv6_dns_server2: <string>
          ipv6_exclusive_routing: <value in [disable, enable]>
          ipv6_pools: <list or string>
          ipv6_service_restriction: <value in [disable, enable]>
          ipv6_split_tunneling: <value in [disable, enable]>
          ipv6_split_tunneling_routing_address: <list or string>
          ipv6_tunnel_mode: <value in [disable, enable]>
          ipv6_wins_server1: <string>
          ipv6_wins_server2: <string>
          keep_alive: <value in [disable, enable]>
          limit_user_logins: <value in [disable, enable]>
          mac_addr_action: <value in [deny, allow]>
          mac_addr_check: <value in [disable, enable]>
          mac_addr_check_rule:
            -
              mac_addr_list: <list or string>
              mac_addr_mask: <integer>
              name: <string>
          macos_forticlient_download_url: <string>
          name: <string>
          os_check: <value in [disable, enable]>
          redir_url: <string>
          save_password: <value in [disable, enable]>
          service_restriction: <value in [disable, enable]>
          skip_check_for_unsupported_browser: <value in [disable, enable]>
          skip_check_for_unsupported_os: <value in [disable, enable]>
          smb_ntlmv1_auth: <value in [disable, enable]>
          smbv1: <value in [disable, enable]>
          split_dns:
            -
              dns_server1: <string>
              dns_server2: <string>
              domains: <string>
              id: <integer>
              ipv6_dns_server1: <string>
              ipv6_dns_server2: <string>
          split_tunneling: <value in [disable, enable]>
          split_tunneling_routing_address: <list or string>
          theme: <value in [gray, blue, orange, ...]>
          tunnel_mode: <value in [disable, enable]>
          user_bookmark: <value in [disable, enable]>
          user_group_bookmark: <value in [disable, enable]>
          web_mode: <value in [disable, enable]>
          windows_forticlient_download_url: <string>
          wins_server1: <string>
          wins_server2: <string>
          skip_check_for_browser: <value in [disable, enable]>
          smb_max_version: <value in [smbv1, smbv2, smbv3]>
          smb_min_version: <value in [smbv1, smbv2, smbv3]>
          virtual_desktop_logout_when_browser_close: <value in [disable, enable]>
          virtual_desktop_clipboard_share: <value in [disable, enable]>
          virtual_desktop_desktop_switch: <value in [disable, enable]>
          virtual_desktop: <value in [disable, enable]>
          virtual_desktop_network_share_access: <value in [disable, enable]>
          virtual_desktop_printing: <value in [disable, enable]>
          virtual_desktop_app_list: <string>
          virtual_desktop_removable_media_access: <value in [disable, enable]>
          transform_backward_slashes: <value in [disable, enable]>
          ipv6_split_tunneling_routing_negate: <value in [disable, enable]>
          split_tunneling_routing_negate: <value in [disable, enable]>
          os_check_list:
            action: <value in [allow, check-up-to-date, deny]>
            latest_patch_level: <string>
            name: <string>
            tolerance: <integer>
          use_sdwan: <value in [disable, enable]>
          prefer_ipv6_dns: <value in [disable, enable]>
          rewrite_ip_uri_ui: <value in [disable, enable]>
          clipboard: <value in [disable, enable]>
          default_window_height: <integer>
          default_window_width: <integer>
          dhcp_ip_overlap: <value in [use-old, use-new]>
          client_src_range: <value in [disable, enable]>
          dhcp_ra_giaddr: <string>
          dhcp6_ra_linkaddr: <string>
          landing_page:
            form_data:
              -
                name: <string>
                value: <string>
            logout_url: <string>
            sso: <value in [disable, static, auto]>
            sso_credential: <value in [sslvpn-login, alternative]>
            sso_password: <list or string>
            sso_username: <string>
            url: <string>
          landing_page_mode: <value in [disable, enable]>
          default_protocol: <value in [web, ftp, telnet, ...]>
          focus_bookmark: <value in [disable, enable]>

Inputs

    
adom:
    description: The parameter (adom) in requested url.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object.
    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

vpnsslweb_portal:
    description: The top level parameters set.
    required: false
    suboptions:
      allow-user-access:
        choices:
        - web
        - ftp
        - telnet
        - smb
        - vnc
        - rdp
        - ssh
        - ping
        - citrix
        - portforward
        - sftp
        description: Deprecated, please rename it to allow_user_access. Allow user access
          to SSL-VPN applications.
        elements: str
        type: list
      auto-connect:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to auto_connect. Enable/disable automatic
          connect by client when system is up.
        type: str
      bookmark-group:
        description: Deprecated, please rename it to bookmark_group. Bookmark-Group.
        elements: dict
        suboptions:
          bookmarks:
            description: Bookmarks.
            elements: dict
            suboptions:
              additional-params:
                description: Deprecated, please rename it to additional_params. Additional
                  parameters.
                type: str
              apptype:
                choices:
                - web
                - telnet
                - ssh
                - ftp
                - smb
                - vnc
                - rdp
                - citrix
                - rdpnative
                - portforward
                - sftp
                description: Application type.
                type: str
              color-depth:
                choices:
                - '8'
                - '16'
                - '32'
                description: Deprecated, please rename it to color_depth. Color depth
                  per pixel.
                type: str
              description:
                description: Description.
                type: str
              domain:
                description: Login domain.
                type: str
              folder:
                description: Network shared file folder parameter.
                type: str
              form-data:
                description: Deprecated, please rename it to form_data. Form-Data.
                elements: dict
                suboptions:
                  name:
                    description: Name.
                    type: str
                  value:
                    description: Value.
                    type: str
                type: list
              height:
                description: Screen height
                type: int
              host:
                description: Host name/IP parameter.
                type: str
              keyboard-layout:
                choices:
                - ar
                - da
                - de
                - de-ch
                - en-gb
                - en-uk
                - en-us
                - es
                - fi
                - fr
                - fr-be
                - fr-ca
                - fr-ch
                - hr
                - hu
                - it
                - ja
                - lt
                - lv
                - mk
                - 'no'
                - pl
                - pt
                - pt-br
                - ru
                - sl
                - sv
                - tk
                - tr
                - fr-ca-m
                - wg
                - ar-101
                - ar-102
                - ar-102-azerty
                - can-mul
                - cz
                - cz-qwerty
                - cz-pr
                - nl
                - de-ibm
                - en-uk-ext
                - en-us-dvorak
                - es-var
                - fi-sami
                - hu-101
                - it-142
                - ko
                - lt-ibm
                - lt-std
                - lav-std
                - lav-leg
                - mk-std
                - no-sami
                - pol-214
                - pol-pr
                - pt-br-abnt2
                - ru-mne
                - ru-t
                - sv-sami
                - tuk
                - tur-f
                - tur-q
                - zh-sym-sg-us
                - zh-sym-us
                - zh-tr-hk
                - zh-tr-mo
                - zh-tr-us
                - fr-apple
                - la-am
                - ja-106
                description: Deprecated, please rename it to keyboard_layout. Keyboard
                  layout.
                type: str
              listening-port:
                description: Deprecated, please rename it to listening_port. Listening
                  port
                type: int
              load-balancing-info:
                description: Deprecated, please rename it to load_balancing_info. The
                  load balancing information or cookie which should...
                type: str
              logon-password:
                description: (list) Deprecated, please rename it to logon_password. Logon
                  password.
                type: raw
              logon-user:
                description: Deprecated, please rename it to logon_user. Logon user.
                type: str
              name:
                description: Bookmark name.
                type: str
              port:
                description: Remote port.
                type: int
              preconnection-blob:
                description: Deprecated, please rename it to preconnection_blob. An arbitrary
                  string which identifies the RDP source.
                type: str
              preconnection-id:
                description: Deprecated, please rename it to preconnection_id. The numeric
                  ID of the RDP source
                type: int
              remote-port:
                description: Deprecated, please rename it to remote_port. Remote port
                type: int
              restricted-admin:
                choices:
                - disable
                - enable
                description: Deprecated, please rename it to restricted_admin. Enable/disable
                  restricted admin mode for RDP.
                type: str
              security:
                choices:
                - rdp
                - nla
                - tls
                - any
                description: Security mode for RDP connection.
                type: str
              send-preconnection-id:
                choices:
                - disable
                - enable
                description: Deprecated, please rename it to send_preconnection_id. Enable/disable
                  sending of preconnection ID.
                type: str
              server-layout:
                choices:
                - en-us-qwerty
                - de-de-qwertz
                - fr-fr-azerty
                - it-it-qwerty
                - sv-se-qwerty
                - failsafe
                - en-gb-qwerty
                - es-es-qwerty
                - fr-ch-qwertz
                - ja-jp-qwerty
                - pt-br-qwerty
                - tr-tr-qwerty
                - fr-ca-qwerty
                description: Deprecated, please rename it to server_layout. Server side
                  keyboard layout.
                type: str
              show-status-window:
                choices:
                - disable
                - enable
                description: Deprecated, please rename it to show_status_window. Enable/disable
                  showing of status window.
                type: str
              sso:
                choices:
                - disable
                - static
                - auto
                description: Single Sign-On.
                type: str
              sso-credential:
                choices:
                - sslvpn-login
                - alternative
                description: Deprecated, please rename it to sso_credential. Single sign-on
                  credentials.
                type: str
              sso-credential-sent-once:
                choices:
                - disable
                - enable
                description: Deprecated, please rename it to sso_credential_sent_once.
                  Single sign-on credentials are only sent once to...
                type: str
              sso-password:
                description: (list) Deprecated, please rename it to sso_password. SSO
                  password.
                type: raw
              sso-username:
                description: Deprecated, please rename it to sso_username. SSO user name.
                type: str
              url:
                description: URL parameter.
                type: str
              vnc-keyboard-layout:
                choices:
                - da
                - de
                - de-ch
                - en-uk
                - es
                - fi
                - fr
                - fr-be
                - it
                - 'no'
                - pt
                - sv
                - nl
                - en-uk-ext
                - it-142
                - pt-br-abnt2
                - default
                - fr-ca-mul
                - gd
                - us-intl
                description: Deprecated, please rename it to vnc_keyboard_layout. Keyboard
                  layout.
                type: str
              width:
                description: Screen width
                type: int
            type: list
          name:
            description: Bookmark group name.
            type: str
        type: list
      client-src-range:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to client_src_range. Allow client to
          add source range for the tunnel traffic.
        type: str
      clipboard:
        choices:
        - disable
        - enable
        description: Enable to support RDP/VPC clipboard functionality.
        type: str
      custom-lang:
        description: Deprecated, please rename it to custom_lang. Change the web portal
          display language.
        type: str
      customize-forticlient-download-url:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to customize_forticlient_download_url.
          Enable support of customized download URL for FortiClient.
        type: str
      default-protocol:
        choices:
        - web
        - ftp
        - telnet
        - smb
        - vnc
        - rdp
        - ssh
        - sftp
        description: Deprecated, please rename it to default_protocol. Application type
          that is set by default.
        type: str
      default-window-height:
        description: Deprecated, please rename it to default_window_height. Screen height
        type: int
      default-window-width:
        description: Deprecated, please rename it to default_window_width. Screen width
        type: int
      dhcp-ip-overlap:
        choices:
        - use-old
        - use-new
        description: Deprecated, please rename it to dhcp_ip_overlap. Configure overlapping
          DHCP IP allocation assignment.
        type: str
      dhcp-ra-giaddr:
        description: Deprecated, please rename it to dhcp_ra_giaddr. Relay agent gateway
          IP address to use in the giaddr field of DHCP requests.
        type: str
      dhcp6-ra-linkaddr:
        description: Deprecated, please rename it to dhcp6_ra_linkaddr. Relay agent IPv6
          link address to use in DHCP6 requests.
        type: str
      display-bookmark:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to display_bookmark. Enable to display
          the web portal bookmark widget.
        type: str
      display-connection-tools:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to display_connection_tools. Enable
          to display the web portal connection tools widget.
        type: str
      display-history:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to display_history. Enable to display
          the web portal user login history widget.
        type: str
      display-status:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to display_status. Enable to display
          the web portal status widget.
        type: str
      dns-server1:
        description: Deprecated, please rename it to dns_server1. IPv4 DNS server 1.
        type: str
      dns-server2:
        description: Deprecated, please rename it to dns_server2. IPv4 DNS server 2.
        type: str
      dns-suffix:
        description: Deprecated, please rename it to dns_suffix. DNS suffix.
        type: str
      exclusive-routing:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to exclusive_routing. Enable/disable
          all traffic go through tunnel only.
        type: str
      focus-bookmark:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to focus_bookmark. Enable to prioritize
          the placement of the bookmark section over the quick-...
        type: str
      forticlient-download:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to forticlient_download. Enable/disable
          download option for FortiClient.
        type: str
      forticlient-download-method:
        choices:
        - direct
        - ssl-vpn
        description: Deprecated, please rename it to forticlient_download_method. FortiClient
          download method.
        type: str
      heading:
        description: Web portal heading message.
        type: str
      hide-sso-credential:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to hide_sso_credential. Enable to prevent
          SSO credential being sent to client.
        type: str
      host-check:
        choices:
        - none
        - av
        - fw
        - av-fw
        - custom
        description: Deprecated, please rename it to host_check. Type of host checking
          performed on endpoints.
        type: str
      host-check-interval:
        description: Deprecated, please rename it to host_check_interval. Periodic host
          check interval.
        type: int
      host-check-policy:
        description: (list or str) Deprecated, please rename it to host_check_policy.
          One or more policies to require the endpoint to have spec...
        type: raw
      ip-mode:
        choices:
        - range
        - user-group
        - dhcp
        - no-ip
        description: Deprecated, please rename it to ip_mode. Method by which users of
          this SSL-VPN tunnel obtain IP addresses.
        type: str
      ip-pools:
        description: (list or str) Deprecated, please rename it to ip_pools. IPv4 firewall
          source address objects reserved for SSL-VPN tunnel m...
        type: raw
      ipv6-dns-server1:
        description: Deprecated, please rename it to ipv6_dns_server1. IPv6 DNS server
          1.
        type: str
      ipv6-dns-server2:
        description: Deprecated, please rename it to ipv6_dns_server2. IPv6 DNS server
          2.
        type: str
      ipv6-exclusive-routing:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to ipv6_exclusive_routing. Enable/disable
          all IPv6 traffic go through tunnel only.
        type: str
      ipv6-pools:
        description: (list or str) Deprecated, please rename it to ipv6_pools. IPv4 firewall
          source address objects reserved for SSL-VPN tunnel...
        type: raw
      ipv6-service-restriction:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to ipv6_service_restriction. Enable/disable
          IPv6 tunnel service restriction.
        type: str
      ipv6-split-tunneling:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to ipv6_split_tunneling. Enable/disable
          IPv6 split tunneling.
        type: str
      ipv6-split-tunneling-routing-address:
        description: (list or str) Deprecated, please rename it to ipv6_split_tunneling_routing_address.
          IPv6 SSL-VPN tunnel mode firewall addr...
        type: raw
      ipv6-split-tunneling-routing-negate:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to ipv6_split_tunneling_routing_negate.
          Enable to negate IPv6 split tunneling routing address.
        type: str
      ipv6-tunnel-mode:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to ipv6_tunnel_mode. Enable/disable
          IPv6 SSL-VPN tunnel mode.
        type: str
      ipv6-wins-server1:
        description: Deprecated, please rename it to ipv6_wins_server1. IPv6 WINS server
          1.
        type: str
      ipv6-wins-server2:
        description: Deprecated, please rename it to ipv6_wins_server2. IPv6 WINS server
          2.
        type: str
      keep-alive:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to keep_alive. Enable/disable automatic
          reconnect for FortiClient connections.
        type: str
      landing-page:
        description: Deprecated, please rename it to landing_page.
        suboptions:
          form-data:
            description: Deprecated, please rename it to form_data.
            elements: dict
            suboptions:
              name:
                description: Name.
                type: str
              value:
                description: Value.
                type: str
            type: list
          logout-url:
            description: Deprecated, please rename it to logout_url. Landing page log
              out URL.
            type: str
          sso:
            choices:
            - disable
            - static
            - auto
            description: Single sign-on.
            type: str
          sso-credential:
            choices:
            - sslvpn-login
            - alternative
            description: Deprecated, please rename it to sso_credential. Single sign-on
              credentials.
            type: str
          sso-password:
            description: (list) Deprecated, please rename it to sso_password.
            type: raw
          sso-username:
            description: Deprecated, please rename it to sso_username. SSO user name.
            type: str
          url:
            description: Landing page URL.
            type: str
        type: dict
      landing-page-mode:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to landing_page_mode. Enable/disable
          SSL-VPN landing page mode.
        type: str
      limit-user-logins:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to limit_user_logins. Enable to limit
          each user to one SSL-VPN session at a time.
        type: str
      mac-addr-action:
        choices:
        - deny
        - allow
        description: Deprecated, please rename it to mac_addr_action. Client MAC address
          action.
        type: str
      mac-addr-check:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to mac_addr_check. Enable/disable MAC
          address host checking.
        type: str
      mac-addr-check-rule:
        description: Deprecated, please rename it to mac_addr_check_rule. Mac-Addr-Check-Rule.
        elements: dict
        suboptions:
          mac-addr-list:
            description: (list) Deprecated, please rename it to mac_addr_list. Client
              MAC address list.
            type: raw
          mac-addr-mask:
            description: Deprecated, please rename it to mac_addr_mask. Client MAC address
              mask.
            type: int
          name:
            description: Client MAC address check rule name.
            type: str
        type: list
      macos-forticlient-download-url:
        description: Deprecated, please rename it to macos_forticlient_download_url. Download
          URL for Mac FortiClient.
        type: str
      name:
        description: Portal name.
        required: true
        type: str
      os-check:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to os_check. Enable to let the FortiGate
          decide action based on client OS.
        type: str
      os-check-list:
        description: Deprecated, please rename it to os_check_list.
        suboptions:
          action:
            choices:
            - allow
            - check-up-to-date
            - deny
            description: OS check options.
            type: str
          latest-patch-level:
            description: Deprecated, please rename it to latest_patch_level. Latest OS
              patch level.
            type: str
          name:
            description: Name.
            type: str
          tolerance:
            description: OS patch level tolerance.
            type: int
        type: dict
      prefer-ipv6-dns:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to prefer_ipv6_dns. Prefer to query
          IPv6 dns first if enabled.
        type: str
      redir-url:
        description: Deprecated, please rename it to redir_url. Client login redirect
          URL.
        type: str
      rewrite-ip-uri-ui:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to rewrite_ip_uri_ui. Rewrite contents
          for URI contains IP and /ui/.
        type: str
      save-password:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to save_password. Enable/disable FortiClient
          saving the users password.
        type: str
      service-restriction:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to service_restriction. Enable/disable
          tunnel service restriction.
        type: str
      skip-check-for-browser:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to skip_check_for_browser. Enable to
          skip host check for browser support.
        type: str
      skip-check-for-unsupported-browser:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to skip_check_for_unsupported_browser.
          Enable to skip host check if browser does not support it.
        type: str
      skip-check-for-unsupported-os:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to skip_check_for_unsupported_os. Enable
          to skip host check if client OS does not support it.
        type: str
      smb-max-version:
        choices:
        - smbv1
        - smbv2
        - smbv3
        description: Deprecated, please rename it to smb_max_version. SMB maximum client
          protocol version.
        type: str
      smb-min-version:
        choices:
        - smbv1
        - smbv2
        - smbv3
        description: Deprecated, please rename it to smb_min_version. SMB minimum client
          protocol version.
        type: str
      smb-ntlmv1-auth:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to smb_ntlmv1_auth. Enable support of
          NTLMv1 for Samba authentication.
        type: str
      smbv1:
        choices:
        - disable
        - enable
        description: Enable/disable support of SMBv1 for Samba.
        type: str
      split-dns:
        description: Deprecated, please rename it to split_dns. Split-Dns.
        elements: dict
        suboptions:
          dns-server1:
            description: Deprecated, please rename it to dns_server1. DNS server 1.
            type: str
          dns-server2:
            description: Deprecated, please rename it to dns_server2. DNS server 2.
            type: str
          domains:
            description: Split DNS domains used for SSL-VPN clients separated by comma
            type: str
          id:
            description: ID.
            type: int
          ipv6-dns-server1:
            description: Deprecated, please rename it to ipv6_dns_server1. IPv6 DNS server
              1.
            type: str
          ipv6-dns-server2:
            description: Deprecated, please rename it to ipv6_dns_server2. IPv6 DNS server
              2.
            type: str
        type: list
      split-tunneling:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to split_tunneling. Enable/disable IPv4
          split tunneling.
        type: str
      split-tunneling-routing-address:
        description: (list or str) Deprecated, please rename it to split_tunneling_routing_address.
          IPv4 SSL-VPN tunnel mode firewall address o...
        type: raw
      split-tunneling-routing-negate:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to split_tunneling_routing_negate. Enable
          to negate split tunneling routing address.
        type: str
      theme:
        choices:
        - gray
        - blue
        - orange
        - crimson
        - steelblue
        - darkgrey
        - green
        - melongene
        - red
        - mariner
        - neutrino
        - jade
        - graphite
        - dark-matter
        - onyx
        - eclipse
        - jet-stream
        - security-fabric
        description: Web portal color scheme.
        type: str
      transform-backward-slashes:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to transform_backward_slashes. Transform
          backward slashes to forward slashes in URLs.
        type: str
      tunnel-mode:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to tunnel_mode. Enable/disable IPv4
          SSL-VPN tunnel mode.
        type: str
      use-sdwan:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to use_sdwan. Use SD-WAN rules to get
          output interface.
        type: str
      user-bookmark:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to user_bookmark. Enable to allow web
          portal users to create their own bookmarks.
        type: str
      user-group-bookmark:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to user_group_bookmark. Enable to allow
          web portal users to create bookmarks for all users in...
        type: str
      virtual-desktop:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to virtual_desktop. Enable/disable SSL
          VPN virtual desktop.
        type: str
      virtual-desktop-app-list:
        description: Deprecated, please rename it to virtual_desktop_app_list. Virtual
          desktop application list.
        type: str
      virtual-desktop-clipboard-share:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to virtual_desktop_clipboard_share.
          Enable/disable sharing of clipboard in virtual desktop.
        type: str
      virtual-desktop-desktop-switch:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to virtual_desktop_desktop_switch. Enable/disable
          switch to virtual desktop.
        type: str
      virtual-desktop-logout-when-browser-close:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to virtual_desktop_logout_when_browser_close.
          Enable/disable logout when browser is close in ...
        type: str
      virtual-desktop-network-share-access:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to virtual_desktop_network_share_access.
          Enable/disable network share access in virtual desktop.
        type: str
      virtual-desktop-printing:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to virtual_desktop_printing. Enable/disable
          printing in virtual desktop.
        type: str
      virtual-desktop-removable-media-access:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to virtual_desktop_removable_media_access.
          Enable/disable access to removable media in virtua...
        type: str
      web-mode:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to web_mode. Enable/disable SSL VPN
          web mode.
        type: str
      windows-forticlient-download-url:
        description: Deprecated, please rename it to windows_forticlient_download_url.
          Download URL for Windows FortiClient.
        type: str
      wins-server1:
        description: Deprecated, please rename it to wins_server1. IPv4 WINS server 1.
        type: str
      wins-server2:
        description: Deprecated, please rename it to wins_server2. IPv4 WINS server 1.
        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

Outputs

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