fortinet.fortimanager.fmgr_vpnmgr_vpntable – no description
fortinet.fortimanager.fmgr_vpnmgr_vpntable – no description
Note
This plugin is part of the fortinet.fortimanager collection (version 2.0.1).
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
- 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 |
|
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters | |
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 |
|
the directive to create, update or delete an object | |
vpnmgr_vpntable dictionary |
the top level parameters set | ||
authmethod string |
|
no description | |
auto-zone-policy string |
|
no description | |
certificate string |
no description | ||
description string |
no description | ||
dpd string |
|
no description | |
dpd-retrycount integer |
no description | ||
dpd-retryinterval integer |
no description | ||
fcc-enforcement string |
|
no description | |
hub2spoke-zone string |
no description | ||
ike-version string |
|
no description | |
ike1dhgroup list / elements=string |
|
no description | |
ike1dpd string |
|
no description | |
ike1keylifesec integer |
no description | ||
ike1localid string |
no description | ||
ike1mode string |
|
no description | |
ike1natkeepalive integer |
no description | ||
ike1nattraversal string |
|
no description | |
ike1proposal string |
|
no description | |
ike2autonego string |
|
no description | |
ike2dhgroup list / elements=string |
|
no description | |
ike2keepalive string |
|
no description | |
ike2keylifekbs integer |
no description | ||
ike2keylifesec integer |
no description | ||
ike2keylifetype string |
|
no description | |
ike2proposal string |
|
no description | |
inter-vdom string |
|
no description | |
intf-mode string |
|
no description | |
localid-type string |
|
no description | |
name string |
no description | ||
negotiate-timeout integer |
Default: 30 |
no description | |
npu-offload string |
|
no description | |
pfs string |
|
no description | |
psk-auto-generate string |
|
no description | |
psksecret string |
no description | ||
replay string |
|
no description | |
rsa-certificate string |
no description | ||
spoke2hub-zone string |
no description | ||
topology string |
|
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>
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/2.11/collections/fortinet/fortimanager/fmgr_vpnmgr_vpntable_module.html