fortinet.fortimanager.fmgr_vpnsslweb_portal_bookmarkgroup_bookmarks (2.4.0) — module

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

Scanned by Steampunk Spotter

• 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: Bookmark table.
      fortinet.fortimanager.fmgr_vpnsslweb_portal_bookmarkgroup_bookmarks:
        # 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>
        portal: <your own value>
        bookmark_group: <your own value>
        state: present # <value in [present, absent]>
        vpnsslweb_portal_bookmarkgroup_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, ...]>

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

portal:
    description: The parameter (portal) 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

bookmark-group:
    description: Deprecated, please use "bookmark_group"
    type: str

bookmark_group:
    description: The parameter (bookmark-group) in requested url.
    type: str

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    type: str

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

vpnsslweb_portal_bookmarkgroup_bookmarks:
    description: The top level parameters set.
    required: false
    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.
        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 be provided to ...
        type: str
      logon-password:
        description: (list) Deprecated, please rename it to logon_password.
        type: raw
      logon-user:
        description: Deprecated, please rename it to logon_user. Logon user.
        type: str
      name:
        description: Bookmark name.
        required: true
        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 remote server.
        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: 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: dict

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