W3cubDocs

/Ansible

fortinet.fortimanager.fmgr_vpnmgr_vpntable – no description

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_vpnmgr_vpntable.

New in version 2.10: of fortinet.fortimanager

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

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.

Parameters

Parameter		Choices/Defaults	Comments
adom string / required			the parameter (adom) in requested url
bypass_validation boolean		Choices: no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log boolean		Choices: no ← yes	Enable/Disable logging for task
proposed_method string		Choices: update set add	The overridden method for the underlying Json RPC request
rc_failed list / elements=string			the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string			the rc codes list with which the conditions to succeed will be overriden
state string / required		Choices: present absent	the directive to create, update or delete an object
vpnmgr_vpntable dictionary			the top level parameters set
	authmethod string	Choices: psk rsa-signature signature	no description
	auto-zone-policy string	Choices: disable enable ←	no description
	certificate string		no description
	description string		no description
	dpd string	Choices: disable enable on-idle on-demand	no description
	dpd-retrycount integer		no description
	dpd-retryinterval integer		no description
	fcc-enforcement string	Choices: disable enable	no description
	hub2spoke-zone string		no description
	ike-version string	Choices: 1 2	no description
	ike1dhgroup list / elements=string	Choices: 1 2 5 14 15 16 17 18 19 20 21 27 28 29 30 31 32	no description
	ike1dpd string	Choices: disable enable	no description
	ike1keylifesec integer		no description
	ike1localid string		no description
	ike1mode string	Choices: main aggressive	no description
	ike1natkeepalive integer		no description
	ike1nattraversal string	Choices: disable enable forced	no description
	ike1proposal string	Choices: des-md5 des-sha1 3des-md5 3des-sha1 aes128-md5 aes128-sha1 aes192-md5 aes192-sha1 aes256-md5 aes256-sha1 des-sha256 3des-sha256 aes128-sha256 aes192-sha256 aes256-sha256 des-sha384 des-sha512 3des-sha384 3des-sha512 aes128-sha384 aes128-sha512 aes192-sha384 aes192-sha512 aes256-sha384 aes256-sha512 aria128-md5 aria128-sha1 aria128-sha256 aria128-sha384 aria128-sha512 aria192-md5 aria192-sha1 aria192-sha256 aria192-sha384 aria192-sha512 aria256-md5 aria256-sha1 aria256-sha256 aria256-sha384 aria256-sha512 seed-md5 seed-sha1 seed-sha256 seed-sha384 seed-sha512 aes128gcm-prfsha1 aes128gcm-prfsha256 aes128gcm-prfsha384 aes128gcm-prfsha512 aes256gcm-prfsha1 aes256gcm-prfsha256 aes256gcm-prfsha384 aes256gcm-prfsha512 chacha20poly1305-prfsha1 chacha20poly1305-prfsha256 chacha20poly1305-prfsha384 chacha20poly1305-prfsha512	no description
	ike2autonego string	Choices: disable enable	no description
	ike2dhgroup list / elements=string	Choices: 1 2 5 14 15 16 17 18 19 20 21 27 28 29 30 31 32	no description
	ike2keepalive string	Choices: disable enable	no description
	ike2keylifekbs integer		no description
	ike2keylifesec integer		no description
	ike2keylifetype string	Choices: seconds kbs both	no description
	ike2proposal string	Choices: null-md5 null-sha1 des-null 3des-null des-md5 des-sha1 3des-md5 3des-sha1 aes128-md5 aes128-sha1 aes192-md5 aes192-sha1 aes256-md5 aes256-sha1 aes128-null aes192-null aes256-null null-sha256 des-sha256 3des-sha256 aes128-sha256 aes192-sha256 aes256-sha256 des-sha384 des-sha512 3des-sha384 3des-sha512 aes128-sha384 aes128-sha512 aes192-sha384 aes192-sha512 aes256-sha384 aes256-sha512 null-sha384 null-sha512 aria128-null aria128-md5 aria128-sha1 aria128-sha256 aria128-sha384 aria128-sha512 aria192-null aria192-md5 aria192-sha1 aria192-sha256 aria192-sha384 aria192-sha512 aria256-null aria256-md5 aria256-sha1 aria256-sha256 aria256-sha384 aria256-sha512 seed-null seed-md5 seed-sha1 seed-sha256 seed-sha384 seed-sha512 aes128gcm aes256gcm chacha20poly1305	no description
	inter-vdom string	Choices: disable enable	no description
	intf-mode string	Choices: off on	no description
	localid-type string	Choices: auto fqdn user-fqdn keyid address asn1dn	no description
	name string		no description
	negotiate-timeout integer	Default: 30	no description
	network-id integer		no description
	network-overlay string	Choices: disable enable	no description
	npu-offload string	Choices: disable enable ←	no description
	pfs string	Choices: disable enable	no description
	psk-auto-generate string	Choices: disable enable	no description
	psksecret string		no description
	replay string	Choices: disable enable	no description
	rsa-certificate string		no description
	spoke2hub-zone string		no description
	topology string	Choices: meshed star dialup	no description
	vpn-zone string		no description
workspace_locking_adom string			the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout integer		Default: 300	the maximum time in seconds to wait for other user to release the workspace lock

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: no description
     fmgr_vpnmgr_vpntable:
        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: <value in [present, absent]>
        vpnmgr_vpntable:
           authmethod: <value in [psk, rsa-signature, signature]>
           auto-zone-policy: <value in [disable, enable]>
           certificate: <value of string>
           description: <value of string>
           dpd: <value in [disable, enable, on-idle, ...]>
           dpd-retrycount: <value of integer>
           dpd-retryinterval: <value of integer>
           fcc-enforcement: <value in [disable, enable]>
           hub2spoke-zone: <value of string>
           ike-version: <value in [1, 2]>
           ike1dhgroup:
             - 1
             - 2
             - 5
             - 14
             - 15
             - 16
             - 17
             - 18
             - 19
             - 20
             - 21
             - 27
             - 28
             - 29
             - 30
             - 31
             - 32
           ike1dpd: <value in [disable, enable]>
           ike1keylifesec: <value of integer>
           ike1localid: <value of string>
           ike1mode: <value in [main, aggressive]>
           ike1natkeepalive: <value of integer>
           ike1nattraversal: <value in [disable, enable, forced]>
           ike1proposal: <value in [des-md5, des-sha1, 3des-md5, ...]>
           ike2autonego: <value in [disable, enable]>
           ike2dhgroup:
             - 1
             - 2
             - 5
             - 14
             - 15
             - 16
             - 17
             - 18
             - 19
             - 20
             - 21
             - 27
             - 28
             - 29
             - 30
             - 31
             - 32
           ike2keepalive: <value in [disable, enable]>
           ike2keylifekbs: <value of integer>
           ike2keylifesec: <value of integer>
           ike2keylifetype: <value in [seconds, kbs, both]>
           ike2proposal: <value in [null-md5, null-sha1, des-null, ...]>
           inter-vdom: <value in [disable, enable]>
           intf-mode: <value in [off, on]>
           localid-type: <value in [auto, fqdn, user-fqdn, ...]>
           name: <value of string>
           negotiate-timeout: <value of integer>
           npu-offload: <value in [disable, enable]>
           pfs: <value in [disable, enable]>
           psk-auto-generate: <value in [disable, enable]>
           psksecret: <value of string>
           replay: <value in [disable, enable]>
           rsa-certificate: <value of string>
           spoke2hub-zone: <value of string>
           topology: <value in [meshed, star, dialup]>
           vpn-zone: <value of string>
           network-id: <value of integer>
           network-overlay: <value in [disable, enable]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
request_url string	always	The full url requested Sample: /sys/login/user
response_code integer	always	The status of api request
response_message string	always	The descriptive message of the api response Sample: OK.

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_vpnmgr_vpntable_module.html