fortinet.fortimanager.fmgr_vpnmgr_node module – VPN node for VPN Manager.

Note

This module is part of the fortinet.fortimanager collection (version 2.1.5).

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_node.

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

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

Choices:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

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

Choices:

  • present

  • absent

vpnmgr_node

dictionary

the top level parameters set

add-route

string

Add-Route.

Choices:

  • disable

  • enable

assign-ip

string

Assign-Ip.

Choices:

  • disable

  • enable

assign-ip-from

string

Assign-Ip-From.

Choices:

  • range

  • usrgrp

  • dhcp

  • name

authpasswd

string

Authpasswd.

authusr

string

Authusr.

authusrgrp

string

Authusrgrp.

auto-configuration

string

Auto-Configuration.

Choices:

  • disable

  • enable

automatic_routing

string

Automatic_Routing.

Choices:

  • disable

  • enable

banner

string

Banner.

default-gateway

string

Default-Gateway.

dhcp-server

string

Dhcp-Server.

Choices:

  • disable

  • enable

dns-mode

string

Dns-Mode.

Choices:

  • auto

  • manual

dns-service

string

Dns-Service.

Choices:

  • default

  • specify

  • local

domain

string

Domain.

exchange-interface-ip

string

Exchange-Interface-Ip.

Choices:

  • disable

  • enable

extgw

string

Extgw.

extgw_hubip

string

Extgw_Hubip.

extgw_p2_per_net

string

Extgw_P2_Per_Net.

Choices:

  • disable

  • enable

extgwip

string

Extgwip.

hub-public-ip

string

Hub-Public-Ip.

hub_iface

string

Hub_Iface.

id

integer

Id.

iface

string

Iface.

ip-range

list / elements=string

Ip-Range.

end-ip

string

End-Ip.

id

integer

Id.

start-ip

string

Start-Ip.

ipsec-lease-hold

integer

Ipsec-Lease-Hold.

ipv4-dns-server1

string

Ipv4-Dns-Server1.

ipv4-dns-server2

string

Ipv4-Dns-Server2.

ipv4-dns-server3

string

Ipv4-Dns-Server3.

ipv4-end-ip

string

Ipv4-End-Ip.

ipv4-exclude-range

list / elements=string

Ipv4-Exclude-Range.

end-ip

string

End-Ip.

id

integer

Id.

start-ip

string

Start-Ip.

ipv4-netmask

string

Ipv4-Netmask.

ipv4-split-exclude

string

Ipv4-Split-Exclude.

ipv4-split-include

string

Ipv4-Split-Include.

ipv4-start-ip

string

Ipv4-Start-Ip.

ipv4-wins-server1

string

Ipv4-Wins-Server1.

ipv4-wins-server2

string

Ipv4-Wins-Server2.

local-gw

string

Local-Gw.

localid

string

Localid.

mode-cfg

string

Mode-Cfg.

Choices:

  • disable

  • enable

mode-cfg-ip-version

string

Mode-Cfg-Ip-Version.

Choices:

  • 4

  • 6

net-device

string

Net-Device.

Choices:

  • disable

  • enable

peer

string

Peer.

peergrp

string

Peergrp.

peerid

string

Peerid.

peertype

string

Peertype.

Choices:

  • any

  • one

  • dialup

  • peer

  • peergrp

protected_subnet

list / elements=string

Protected_Subnet.

addr

string

Addr.

seq

integer

Seq.

public-ip

string

Public-Ip.

role

string

Role.

Choices:

  • hub

  • spoke

route-overlap

string

Route-Overlap.

Choices:

  • use-old

  • use-new

  • allow

scope member

list / elements=string

The scope member array of vpnmgr node

name

string

name of scope member

vdom

string

vdom of scope member

spoke-zone

string

Spoke-Zone.

summary_addr

list / elements=string

Summary_Addr.

addr

string

Addr.

priority

integer

Priority.

seq

integer

Seq.

string

Tunnel-Search.

Choices:

  • selectors

  • nexthop

unity-support

string

Unity-Support.

Choices:

  • disable

  • enable

usrgrp

string

Usrgrp.

vpn-interface-priority

integer

Vpn-Interface-Priority.

vpn-zone

string

Vpn-Zone.

vpntable

string

Vpntable.

xauthtype

string

Xauthtype.

Choices:

  • disable

  • client

  • pap

  • chap

  • auto

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

the maximum time in seconds to wait for other user to release the workspace lock

Default: 300

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: VPN node for VPN Manager.
     fmgr_vpnmgr_node:
        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_node:
           add-route: <value in [disable, enable]>
           assign-ip: <value in [disable, enable]>
           assign-ip-from: <value in [range, usrgrp, dhcp, ...]>
           authpasswd: <value of string>
           authusr: <value of string>
           authusrgrp: <value of string>
           auto-configuration: <value in [disable, enable]>
           automatic_routing: <value in [disable, enable]>
           banner: <value of string>
           default-gateway: <value of string>
           dhcp-server: <value in [disable, enable]>
           dns-mode: <value in [auto, manual]>
           dns-service: <value in [default, specify, local]>
           domain: <value of string>
           extgw: <value of string>
           extgw_hubip: <value of string>
           extgw_p2_per_net: <value in [disable, enable]>
           extgwip: <value of string>
           hub_iface: <value of string>
           id: <value of integer>
           iface: <value of string>
           ip-range:
             -
                 end-ip: <value of string>
                 id: <value of integer>
                 start-ip: <value of string>
           ipsec-lease-hold: <value of integer>
           ipv4-dns-server1: <value of string>
           ipv4-dns-server2: <value of string>
           ipv4-dns-server3: <value of string>
           ipv4-end-ip: <value of string>
           ipv4-exclude-range:
             -
                 end-ip: <value of string>
                 id: <value of integer>
                 start-ip: <value of string>
           ipv4-netmask: <value of string>
           ipv4-split-include: <value of string>
           ipv4-start-ip: <value of string>
           ipv4-wins-server1: <value of string>
           ipv4-wins-server2: <value of string>
           local-gw: <value of string>
           localid: <value of string>
           mode-cfg: <value in [disable, enable]>
           mode-cfg-ip-version: <value in [4, 6]>
           net-device: <value in [disable, enable]>
           peer: <value of string>
           peergrp: <value of string>
           peerid: <value of string>
           peertype: <value in [any, one, dialup, ...]>
           protected_subnet:
             -
                 addr: <value of string>
                 seq: <value of integer>
           public-ip: <value of string>
           role: <value in [hub, spoke]>
           route-overlap: <value in [use-old, use-new, allow]>
           spoke-zone: <value of string>
           summary_addr:
             -
                 addr: <value of string>
                 priority: <value of integer>
                 seq: <value of integer>
           tunnel-search: <value in [selectors, nexthop]>
           unity-support: <value in [disable, enable]>
           usrgrp: <value of string>
           vpn-interface-priority: <value of integer>
           vpn-zone: <value of string>
           vpntable: <value of string>
           xauthtype: <value in [disable, client, pap, ...]>
           exchange-interface-ip: <value in [disable, enable]>
           hub-public-ip: <value of string>
           ipv4-split-exclude: <value of string>
           scope member:
             -
                 name: <value of string>
                 vdom: <value of string>

Return Values

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

Key

Description

request_url

string

The full url requested

Returned: always

Sample: “/sys/login/user”

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)