fmgr_vpnmgr_vpntable

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.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
vpnmgr_vpntable yes yes yes yes yes yes yes yes yes

Parameters

  • 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
  • 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
  • vpnmgr_vpntable - no description type: dict
    • authmethod - Authmethod. type: str choices: [psk, rsa-signature, signature] more...
    • auto-zone-policy - Auto-Zone-Policy. type: str choices: [disable, enable] default: enable more...
    • certificate - Certificate. type: str more...
    • description - Description. type: str more...
    • dpd - Dpd. type: str choices: [disable, enable, on-idle, on-demand] more...
    • dpd-retrycount - Dpd-Retrycount. type: int more...
    • dpd-retryinterval - Dpd-Retryinterval. type: int more...
    • fcc-enforcement - Fcc-Enforcement. type: str choices: [disable, enable] more...
    • hub2spoke-zone - Hub2Spoke-Zone. type: str more...
    • ike-version - Ike-Version. type: str choices: [1, 2] more...
    • ike1dhgroup - Ike1Dhgroup. type: array choices: [1, 2, 5, 14, 15, 16, 17, 18, 19, 20, 21, 27, 28, 29, 30, 31, 32] more...
    • ike1dpd - Ike1Dpd. type: str choices: [disable, enable] more...
    • ike1keylifesec - Ike1Keylifesec. type: int more...
    • ike1localid - Ike1Localid. type: str more...
    • ike1mode - Ike1Mode. type: str choices: [main, aggressive] more...
    • ike1natkeepalive - Ike1Natkeepalive. type: int more...
    • ike1nattraversal - Ike1Nattraversal. type: str choices: [disable, enable, forced] more...
    • 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...
    • ike2autonego - Ike2Autonego. type: str choices: [disable, enable] more...
    • ike2dhgroup - Ike2Dhgroup. type: array choices: [1, 2, 5, 14, 15, 16, 17, 18, 19, 20, 21, 27, 28, 29, 30, 31, 32] more...
    • ike2keepalive - Ike2Keepalive. type: str choices: [disable, enable] more...
    • ike2keylifekbs - Ike2Keylifekbs. type: int more...
    • ike2keylifesec - Ike2Keylifesec. type: int more...
    • ike2keylifetype - Ike2Keylifetype. type: str choices: [seconds, kbs, both] more...
    • 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...
    • inter-vdom - Inter-Vdom. type: str choices: [disable, enable] more...
    • intf-mode - Intf-Mode. type: str choices: [off, on] more...
    • localid-type - Localid-Type. type: str choices: [auto, fqdn, user-fqdn, keyid, address, asn1dn] more...
    • name - Name. type: str more...
    • negotiate-timeout - Negotiate-Timeout. type: int default: 30 more...
    • npu-offload - Npu-Offload. type: str choices: [disable, enable] default: enable more...
    • pfs - Pfs. type: str choices: [disable, enable] more...
    • psk-auto-generate - Psk-Auto-Generate. type: str choices: [disable, enable] more...
    • psksecret - Psksecret. type: str more...
    • replay - Replay. type: str choices: [disable, enable] more...
    • rsa-certificate - Rsa-Certificate. type: str more...
    • spoke2hub-zone - Spoke2Hub-Zone. type: str more...
    • topology - Topology. type: str choices: [meshed, star, dialup] more...
    • vpn-zone - Vpn-Zone. type: str more...
    • network-id - Network-Id. type: int more...
    • network-overlay - Network-Overlay. type: str choices: [disable, enable] more...

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: 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

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

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

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.