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

Note

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

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