fortinet.fortimanager.fmgr_vpnmgr_node module – VPN node for VPN Manager.
Note
This module is part of the fortinet.fortimanager collection (version 2.5.0).
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 |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The top level parameters set. |
|
Deprecated, please rename it to add_route. Add-Route. Choices:
|
|
Deprecated, please rename it to assign_ip. Assign-Ip. Choices:
|
|
Deprecated, please rename it to assign_ip_from. Assign-Ip-From. Choices:
|
|
(list) Authpasswd. |
|
Authusr. |
|
Authusrgrp. |
|
Deprecated, please rename it to auto_configuration. Auto-Configuration. Choices:
|
|
Deprecated, please rename it to auto_discovery_receiver. Choices:
|
|
Deprecated, please rename it to auto_discovery_sender. Choices:
|
|
Automatic_Routing. Choices:
|
|
Banner. |
|
Deprecated, please rename it to default_gateway. Default-Gateway. |
|
Deprecated, please rename it to dhcp_ra_giaddr. |
|
Deprecated, please rename it to dhcp_server. Dhcp-Server. Choices:
|
|
Deprecated, please rename it to dns_mode. Dns-Mode. Choices:
|
|
Deprecated, please rename it to dns_service. Dns-Service. Choices:
|
|
Domain. |
|
No description. Choices:
|
|
Deprecated, please rename it to exchange_interface_ip. Exchange-Interface-Ip. Choices:
|
|
Extgw. |
|
Extgw_Hubip. |
|
Extgw_P2_Per_Net. Choices:
|
|
Extgwip. |
|
Deprecated, please rename it to hub_public_ip. Hub-Public-Ip. |
|
(list or str) Hub_Iface. |
|
Id. |
|
(list or str) Iface. |
|
Deprecated, please rename it to ip_range. Ip-Range. |
|
Deprecated, please rename it to end_ip. End-Ip. |
|
Id. |
|
Deprecated, please rename it to start_ip. Start-Ip. |
|
Deprecated, please rename it to ipsec_lease_hold. Ipsec-Lease-Hold. |
|
Deprecated, please rename it to ipv4_dns_server1. Ipv4-Dns-Server1. |
|
Deprecated, please rename it to ipv4_dns_server2. Ipv4-Dns-Server2. |
|
Deprecated, please rename it to ipv4_dns_server3. Ipv4-Dns-Server3. |
|
Deprecated, please rename it to ipv4_end_ip. Ipv4-End-Ip. |
|
Deprecated, please rename it to ipv4_exclude_range. Ipv4-Exclude-Range. |
|
Deprecated, please rename it to end_ip. End-Ip. |
|
Id. |
|
Deprecated, please rename it to start_ip. Start-Ip. |
|
Deprecated, please rename it to ipv4_name. |
|
Deprecated, please rename it to ipv4_netmask. Ipv4-Netmask. |
|
Deprecated, please rename it to ipv4_split_exclude. Ipv4-Split-Exclude. |
|
Deprecated, please rename it to ipv4_split_include. Ipv4-Split-Include. |
|
Deprecated, please rename it to ipv4_start_ip. Ipv4-Start-Ip. |
|
Deprecated, please rename it to ipv4_wins_server1. Ipv4-Wins-Server1. |
|
Deprecated, please rename it to ipv4_wins_server2. Ipv4-Wins-Server2. |
|
No description. Choices:
|
|
Deprecated, please rename it to local_gw. Local-Gw. |
|
Localid. |
|
Deprecated, please rename it to mode_cfg. Mode-Cfg. Choices:
|
|
Deprecated, please rename it to mode_cfg_ip_version. Mode-Cfg-Ip-Version. Choices:
|
|
Deprecated, please rename it to net_device. Net-Device. Choices:
|
|
Deprecated, please rename it to network_id. |
|
Deprecated, please rename it to network_overlay. Choices:
|
|
(list or str) Peer. |
|
Peergrp. |
|
Peerid. |
|
Peertype. Choices:
|
|
Protected_Subnet. |
|
(list or str) Addr. |
|
Seq. |
|
No description. |
|
Deprecated, please rename it to public_ip. Public-Ip. |
|
Role. Choices:
|
|
Deprecated, please rename it to route_overlap. Route-Overlap. Choices:
|
|
Deprecated, please rename it to scope_member. |
|
No description. |
|
No description. |
|
(list or str) Deprecated, please rename it to spoke_zone. Spoke-Zone. |
|
Summary_Addr. |
|
Addr. |
|
Priority. |
|
Seq. |
|
Deprecated, please rename it to tunnel_search. Tunnel-Search. Choices:
|
|
Deprecated, please rename it to unity_support. Unity-Support. Choices:
|
|
Usrgrp. |
|
Deprecated, please rename it to vpn_interface_priority. Vpn-Interface-Priority. |
|
(list or str) Deprecated, please rename it to vpn_zone. Vpn-Zone. |
|
(list or str) Vpntable. |
|
Xauthtype. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
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 |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |