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

Note

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

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 fortinet.fortimanager 2.0.0

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

access_token

string

The token to access FortiManager without using username and password.

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:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

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

aliases: add-route

string

Add route.

Choices:

  • "disable"

  • "enable"

assign_ip

aliases: assign-ip

string

Assign ip.

Choices:

  • "disable"

  • "enable"

assign_ip_from

aliases: assign-ip-from

string

Assign ip from.

Choices:

  • "range"

  • "usrgrp"

  • "dhcp"

  • "name"

authpasswd

any

(list) Authpasswd.

authusr

string

Authusr.

authusrgrp

string

Authusrgrp.

auto_configuration

aliases: auto-configuration

string

Auto configuration.

Choices:

  • "disable"

  • "enable"

auto_discovery_receiver

aliases: auto-discovery-receiver

string

Auto discovery receiver.

Choices:

  • "disable"

  • "enable"

auto_discovery_sender

aliases: auto-discovery-sender

string

Auto discovery sender.

Choices:

  • "disable"

  • "enable"

automatic_routing

string

Automatic routing.

Choices:

  • "disable"

  • "enable"

banner

string

Banner.

default_gateway

aliases: default-gateway

string

Default gateway.

dhcp_ra_giaddr

aliases: dhcp-ra-giaddr

string

Dhcp ra giaddr.

dhcp_server

aliases: dhcp-server

string

Dhcp server.

Choices:

  • "disable"

  • "enable"

dns_mode

aliases: dns-mode

string

Dns mode.

Choices:

  • "auto"

  • "manual"

dns_service

aliases: dns-service

string

Dns service.

Choices:

  • "default"

  • "specify"

  • "local"

domain

string

Domain.

encapsulation

string

Encapsulation.

Choices:

  • "tunnel-mode"

  • "transport-mode"

exchange_interface_ip

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

any

(list or str) Hub iface.

hub_public_ip

aliases: hub-public-ip

string

Hub public ip.

id

integer / required

Id.

iface

any

(list or str) Iface.

ip_range

aliases: ip-range

list / elements=dictionary

Ip range.

end_ip

aliases: end-ip

string

End ip.

id

integer

Id.

start_ip

aliases: start-ip

string

Start ip.

ipsec_lease_hold

aliases: ipsec-lease-hold

integer

Ipsec lease hold.

ipv4_dns_server1

aliases: ipv4-dns-server1

string

Ipv4 dns server1.

ipv4_dns_server2

aliases: ipv4-dns-server2

string

Ipv4 dns server2.

ipv4_dns_server3

aliases: ipv4-dns-server3

string

Ipv4 dns server3.

ipv4_end_ip

aliases: ipv4-end-ip

string

Ipv4 end ip.

ipv4_exclude_range

aliases: ipv4-exclude-range

list / elements=dictionary

Ipv4 exclude range.

end_ip

aliases: end-ip

string

End ip.

id

integer

Id.

start_ip

aliases: start-ip

string

Start ip.

ipv4_name

aliases: ipv4-name

string

Ipv4 name.

ipv4_netmask

aliases: ipv4-netmask

string

Ipv4 netmask.

ipv4_split_exclude

aliases: ipv4-split-exclude

string

Ipv4 split exclude.

ipv4_split_include

aliases: ipv4-split-include

string

Ipv4 split include.

ipv4_start_ip

aliases: ipv4-start-ip

string

Ipv4 start ip.

ipv4_wins_server1

aliases: ipv4-wins-server1

string

Ipv4 wins server1.

ipv4_wins_server2

aliases: ipv4-wins-server2

string

Ipv4 wins server2.

l2tp

string

L2tp.

Choices:

  • "disable"

  • "enable"

local_gw

aliases: local-gw

string

Local gw.

localid

string

Localid.

mode_cfg

aliases: mode-cfg

string

Mode cfg.

Choices:

  • "disable"

  • "enable"

mode_cfg_ip_version

aliases: mode-cfg-ip-version

string

Mode cfg ip version.

Choices:

  • "4"

  • "6"

net_device

aliases: net-device

string

Net device.

Choices:

  • "disable"

  • "enable"

network_id

aliases: network-id

integer

Network id.

network_overlay

aliases: network-overlay

string

Network overlay.

Choices:

  • "enable"

  • "disable"

peer

any

(list or str) Peer.

peergrp

string

Peergrp.

peerid

string

Peerid.

peertype

string

Peertype.

Choices:

  • "any"

  • "one"

  • "dialup"

  • "peer"

  • "peergrp"

protected_subnet

list / elements=dictionary

Protected subnet.

addr

any

(list or str) Addr.

seq

integer

Seq.

protocol

integer

Protocol.

public_ip

aliases: public-ip

string

Public ip.

role

string

Role.

Choices:

  • "hub"

  • "spoke"

route_overlap

aliases: route-overlap

string

Route overlap.

Choices:

  • "use-old"

  • "use-new"

  • "allow"

scope_member

aliases: scope member

list / elements=dictionary

Scope member.

name

string

Name.

vdom

string

Vdom.

spoke_zone

aliases: spoke-zone

any

(list or str) Spoke zone.

summary_addr

list / elements=dictionary

Summary addr.

addr

string

Addr.

priority

integer

Priority.

seq

integer

Seq.

tunnel_search

aliases: tunnel-search

string

Tunnel search.

Choices:

  • "selectors"

  • "nexthop"

unity_support

aliases: unity-support

string

Unity support.

Choices:

  • "disable"

  • "enable"

usrgrp

string

Usrgrp.

vpn_interface_priority

aliases: vpn-interface-priority

integer

Vpn interface priority.

vpn_zone

aliases: vpn-zone

any

(list or str) Vpn zone.

vpntable

any

(list or str) 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

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • 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

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: VPN node for VPN Manager.
      fortinet.fortimanager.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: present # <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: <list or string>
          authusr: <string>
          authusrgrp: <string>
          auto_configuration: <value in [disable, enable]>
          automatic_routing: <value in [disable, enable]>
          banner: <string>
          default_gateway: <string>
          dhcp_server: <value in [disable, enable]>
          dns_mode: <value in [auto, manual]>
          dns_service: <value in [default, specify, local]>
          domain: <string>
          extgw: <string>
          extgw_hubip: <string>
          extgw_p2_per_net: <value in [disable, enable]>
          extgwip: <string>
          hub_iface: <list or string>
          id: <integer>
          iface: <list or string>
          ip_range:
            -
              end_ip: <string>
              id: <integer>
              start_ip: <string>
          ipsec_lease_hold: <integer>
          ipv4_dns_server1: <string>
          ipv4_dns_server2: <string>
          ipv4_dns_server3: <string>
          ipv4_end_ip: <string>
          ipv4_exclude_range:
            -
              end_ip: <string>
              id: <integer>
              start_ip: <string>
          ipv4_netmask: <string>
          ipv4_split_include: <string>
          ipv4_start_ip: <string>
          ipv4_wins_server1: <string>
          ipv4_wins_server2: <string>
          local_gw: <string>
          localid: <string>
          mode_cfg: <value in [disable, enable]>
          mode_cfg_ip_version: <value in [4, 6]>
          net_device: <value in [disable, enable]>
          peer: <list or string>
          peergrp: <string>
          peerid: <string>
          peertype: <value in [any, one, dialup, ...]>
          protected_subnet:
            -
              addr: <list or string>
              seq: <integer>
          public_ip: <string>
          role: <value in [hub, spoke]>
          route_overlap: <value in [use-old, use-new, allow]>
          spoke_zone: <list or string>
          summary_addr:
            -
              addr: <string>
              priority: <integer>
              seq: <integer>
          tunnel_search: <value in [selectors, nexthop]>
          unity_support: <value in [disable, enable]>
          usrgrp: <string>
          vpn_interface_priority: <integer>
          vpn_zone: <list or string>
          vpntable: <list or string>
          xauthtype: <value in [disable, client, pap, ...]>
          exchange_interface_ip: <value in [disable, enable]>
          hub_public_ip: <string>
          ipv4_split_exclude: <string>
          scope_member:
            -
              name: <string>
              vdom: <string>
          dhcp_ra_giaddr: <string>
          encapsulation: <value in [tunnel-mode, transport-mode]>
          ipv4_name: <string>
          l2tp: <value in [disable, enable]>
          auto_discovery_receiver: <value in [disable, enable]>
          auto_discovery_sender: <value in [disable, enable]>
          network_id: <integer>
          network_overlay: <value in [enable, disable]>
          protocol: <integer>

Return Values

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

Key

Description

meta

dictionary

The result of the request.

Returned: always

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_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)