drmofu.fortimanager.fmgr_vpnsslweb_portal_bookmarkgroup (2.2.2) — module

Portal bookmark group.

| "added in version" 2.0.0 of drmofu.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 drmofu.fortimanager:==2.2.2


Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

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.
 - hosts: fortimanager-inventory
   collections:
     - fortinet.fortimanager
   connection: httpapi
   vars:
      ansible_httpapi_use_ssl: True
      ansible_httpapi_validate_certs: False
      ansible_httpapi_port: 443
   tasks:
    - name: Portal bookmark group.
      fmgr_vpnsslweb_portal_bookmarkgroup:
         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>
         state: <value in [present, absent]>
         vpnsslweb_portal_bookmarkgroup:
            bookmarks:
              -
                  additional-params: <value of string>
                  apptype: <value in [web, telnet, ssh, ...]>
                  description: <value of string>
                  folder: <value of string>
                  form-data:
                    -
                        name: <value of string>
                        value: <value of string>
                  host: <value of string>
                  listening-port: <value of integer>
                  load-balancing-info: <value of string>
                  logon-password: <value of string>
                  logon-user: <value of string>
                  name: <value of string>
                  port: <value of integer>
                  preconnection-blob: <value of string>
                  preconnection-id: <value of integer>
                  remote-port: <value of 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: <value of string>
                  sso-username: <value of string>
                  url: <value of string>
                  domain: <value of string>
                  color-depth: <value in [8, 16, 32]>
                  height: <value of integer>
                  keyboard-layout: <value in [ar, da, de, ...]>
                  restricted-admin: <value in [disable, enable]>
                  send-preconnection-id: <value in [disable, enable]>
                  width: <value of integer>
                  vnc-keyboard-layout: <value in [da, de, de-ch, ...]>
            name: <value of string>

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
    required: false
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    required: false
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    required: false
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    required: false
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    required: false
    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.
    required: false
    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.
    required: false
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    required: false
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    required: false
    type: int

vpnsslweb_portal_bookmarkgroup:
    description: the top level parameters set
    required: false
    suboptions:
      bookmarks:
        description: description
        elements: dict
        suboptions:
          additional-params:
            description: 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: 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: description
            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
            description: Keyboard layout.
            type: str
          listening-port:
            description: Listening port
            type: int
          load-balancing-info:
            description: The load balancing information or cookie which should be provided
              to the connection broker.
            type: str
          logon-password:
            description: description
            type: str
          logon-user:
            description: Logon user.
            type: str
          name:
            description: Bookmark name.
            type: str
          port:
            description: Remote port.
            type: int
          preconnection-blob:
            description: An arbitrary string which identifies the RDP source.
            type: str
          preconnection-id:
            description: The numeric ID of the RDP source
            type: int
          remote-port:
            description: Remote port
            type: int
          restricted-admin:
            choices:
            - disable
            - enable
            description: 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: 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: Server side keyboard layout.
            type: str
          show-status-window:
            choices:
            - disable
            - enable
            description: 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: Single sign-on credentials.
            type: str
          sso-credential-sent-once:
            choices:
            - disable
            - enable
            description: Single sign-on credentials are only sent once to remote server.
            type: str
          sso-password:
            description: description
            type: str
          sso-username:
            description: 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: Keyboard layout.
            type: str
          width:
            description: Screen width
            type: int
        type: list
      name:
        description: Bookmark group name.
        type: str
    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