:source: fmgr_vpnmgr_vpntable.py
:orphan:
.. _fmgr_vpnmgr_vpntable:
fmgr_vpnmgr_vpntable -- Vpnmgr vpntable.
++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.0.0
.. warning::
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0: ``var-name``, ``var name``, ``var.name``
- New argument name starting in 3.0.0: ``var_name``
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name.
You will receive deprecation warnings if you keep using the previous argument name.
You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
.. contents::
:local:
:depth: 1
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 v7.x.
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible-core>=2.16.0
FortiManager Version Compatibility
----------------------------------
.. raw:: html
Supported Version Ranges: v6.0.0 -> latest
Parameters
----------
.. raw:: html
- access_token -The token to access FortiManager without using username and password. type: str required: false
- 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
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- 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
- 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
- revision_note - The change note that can be specified when an object is created or updated. type: string required: false
- adom - The parameter in requested url type: str required: true
- vpnmgr_vpntable - Vpnmgr vpntable type: dict
- authmethod Authmethod. type: str choices: [psk, rsa-signature, signature]
more...
Supported Version Ranges: v6.0.0 -> latest
- auto_zone_policy (Alias name: auto-zone-policy) Auto zone policy. type: str choices: [disable, enable] default: enable
more...
Supported Version Ranges: v6.0.0 -> latest
- certificate Certificate. type: list or str
more...
Supported Version Ranges: v6.0.0 -> latest
- description Description. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- dpd Dpd. type: str choices: [disable, enable, on-idle, on-demand]
more...
Supported Version Ranges: v6.0.0 -> latest
- dpd_retrycount (Alias name: dpd-retrycount) Dpd retrycount. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- dpd_retryinterval (Alias name: dpd-retryinterval) Dpd retryinterval. type: list
more...
Supported Version Ranges: v6.0.0 -> latest
- fcc_enforcement (Alias name: fcc-enforcement) Fcc enforcement. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- hub2spoke_zone (Alias name: hub2spoke-zone) Hub2spoke zone. type: list or str
more...
Supported Version Ranges: v6.0.0 -> latest
- ike_version (Alias name: ike-version) Ike version. type: str choices: [1, 2]
more...
Supported Version Ranges: v6.0.0 -> latest
- ike1dhgroup Ike1dhgroup. type: list choices: [1, 2, 5, 14, 15, 16, 17, 18, 19, 20, 21, 27, 28, 29, 30, 31, 32]
more...
Supported Version Ranges: v6.0.0 -> latest
- ike1dpd Ike1dpd. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- ike1keylifesec Ike1keylifesec. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- ike1localid Ike1localid. type: str
more...
Supported Version Ranges: v6.0.0 -> v7.4.6, v7.6.0 -> v7.6.3
- ike1mode Ike1mode. type: str choices: [main, aggressive]
more...
Supported Version Ranges: v6.0.0 -> latest
- ike1natkeepalive Ike1natkeepalive. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- ike1nattraversal Ike1nattraversal. type: str choices: [disable, enable, forced]
more...
Supported Version Ranges: v6.0.0 -> latest
- ike1proposal Ike1proposal. type: str 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]
more...
Supported Version Ranges: v6.0.0 -> latest
- ike2autonego Ike2autonego. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- ike2dhgroup Ike2dhgroup. type: list choices: [1, 2, 5, 14, 15, 16, 17, 18, 19, 20, 21, 27, 28, 29, 30, 31, 32]
more...
Supported Version Ranges: v6.0.0 -> latest
- ike2keepalive Ike2keepalive. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- ike2keylifekbs Ike2keylifekbs. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- ike2keylifesec Ike2keylifesec. type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- ike2keylifetype Ike2keylifetype. type: str choices: [seconds, kbs, both]
more...
Supported Version Ranges: v6.0.0 -> latest
- ike2proposal Ike2proposal. type: str 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]
more...
Supported Version Ranges: v6.0.0 -> latest
- inter_vdom (Alias name: inter-vdom) Inter vdom. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- intf_mode (Alias name: intf-mode) Intf mode. type: str choices: [off, on]
more...
Supported Version Ranges: v6.0.0 -> latest
- localid_type (Alias name: localid-type) Localid type. type: str choices: [auto, fqdn, user-fqdn, keyid, address, asn1dn]
more...
Supported Version Ranges: v6.0.0 -> latest
- name Name. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- negotiate_timeout (Alias name: negotiate-timeout) Negotiate timeout. type: int default: 30
more...
Supported Version Ranges: v6.0.0 -> latest
- npu_offload (Alias name: npu-offload) Npu offload. type: str choices: [disable, enable] default: enable
more...
Supported Version Ranges: v6.0.0 -> latest
- pfs Pfs. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- psk_auto_generate (Alias name: psk-auto-generate) Psk auto generate. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- psksecret Psksecret. type: list
more...
Supported Version Ranges: v6.0.0 -> latest
- replay Replay. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- rsa_certificate (Alias name: rsa-certificate) Rsa certificate. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- spoke2hub_zone (Alias name: spoke2hub-zone) Spoke2hub zone. type: list or str
more...
Supported Version Ranges: v6.0.0 -> latest
- topology Topology. type: str choices: [meshed, star, dialup]
more...
Supported Version Ranges: v6.0.0 -> latest
- vpn_zone (Alias name: vpn-zone) Vpn zone. type: list or str
more...
Supported Version Ranges: v6.0.0 -> latest
- network_id (Alias name: network-id) Network id. type: int
more...
Supported Version Ranges: v6.2.5 -> latest
- network_overlay (Alias name: network-overlay) Network overlay. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.5 -> latest
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
--------
.. code-block:: yaml+jinja
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Vpnmgr vpntable
fortinet.fortimanager.fmgr_vpnmgr_vpntable:
# workspace_locking_adom:
adom:
state: present #
vpnmgr_vpntable:
name: "your value" # Required variable, string
# authmethod:
# auto_zone_policy:
# certificate:
# description:
# dpd:
# dpd_retrycount:
# dpd_retryinterval:
# fcc_enforcement:
# hub2spoke_zone:
# ike_version:
# ike1dhgroup: ["1", "2", "5", "14", "15", "16", "17", "18", "19", "20", "21", "27",
# "28", "29", "30", "31", "32"]
# ike1dpd:
# ike1keylifesec:
# ike1localid:
# ike1mode:
# ike1natkeepalive:
# ike1nattraversal:
# ike1proposal:
# ike2autonego:
# ike2dhgroup: ["1", "2", "5", "14", "15", "16", "17", "18", "19", "20", "21", "27",
# "28", "29", "30", "31", "32"]
# ike2keepalive:
# ike2keylifekbs:
# ike2keylifesec:
# ike2keylifetype:
# ike2proposal:
# inter_vdom:
# intf_mode:
# localid_type:
# negotiate_timeout:
# npu_offload:
# pfs:
# psk_auto_generate:
# psksecret:
# replay:
# rsa_certificate:
# spoke2hub_zone:
# topology:
# vpn_zone:
# network_id:
# network_overlay:
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:
.. raw:: html
- meta - The result of the request.returned: always type: dict
- 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_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)