fmgr_vpnsslweb_portal_bookmarkgroup – Portal bookmark group.¶
New in version 2.10.
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 v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- adom - The parameter in requested url type: str required: true
- portal - The parameter in requested url type: str required: true
- vpnsslweb_portal_bookmarkgroup - Portal bookmark group. type: dict
- bookmarks - No description for the parameter type: array
- additional-params - Additional parameters. type: str
- apptype - Application type. type: str choices: [web, telnet, ssh, ftp, smb, vnc, rdp, citrix, rdpnative, portforward, sftp]
- description - Description. type: str
- folder - Network shared file folder parameter. type: str
- form-data - No description for the parameter type: array
- name - Name. type: str
- value - Value. type: str
- host - Host name/IP parameter. type: str
- listening-port - Listening port (0 - 65535). type: int
- load-balancing-info - The load balancing information or cookie which should be provided to the connection broker. type: str
- logon-password - No description for the parameter type: str
- logon-user - Logon user. type: str
- name - Bookmark name. type: str
- port - Remote port. type: int
- preconnection-blob - An arbitrary string which identifies the RDP source. type: str
- preconnection-id - The numeric ID of the RDP source (0-2147483648). type: int
- remote-port - Remote port (0 - 65535). type: int
- security - Security mode for RDP connection. type: str choices: [rdp, nla, tls, any]
- server-layout - Server side keyboard layout. type: str 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]
- show-status-window - Enable/disable showing of status window. type: str choices: [disable, enable]
- sso - Single Sign-On. type: str choices: [disable, static, auto]
- sso-credential - Single sign-on credentials. type: str choices: [sslvpn-login, alternative]
- sso-credential-sent-once - Single sign-on credentials are only sent once to remote server. type: str choices: [disable, enable]
- sso-password - No description for the parameter type: str
- sso-username - SSO user name. type: str
- url - URL parameter. type: str
- name - Bookmark group name. type: str
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¶
- 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>
name: <value of string>
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:
- 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_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict