fmgr_vpnmgr_node – VPN node for VPN Manager.¶
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.
- Tested with FortiManager v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- 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_node - VPN node for VPN Manager. Must specify vpntable and scope member. type: dict
- add-route - No description for the parameter type: str choices: [disable, enable]
- assign-ip - No description for the parameter type: str choices: [disable, enable]
- assign-ip-from - No description for the parameter type: str choices: [range, usrgrp, dhcp, name]
- authpasswd - No description for the parameter type: str
- authusr - No description for the parameter type: str
- authusrgrp - No description for the parameter type: str
- auto-configuration - No description for the parameter type: str choices: [disable, enable]
- automatic_routing - No description for the parameter type: str choices: [disable, enable]
- banner - No description for the parameter type: str
- default-gateway - No description for the parameter type: str
- dhcp-server - No description for the parameter type: str choices: [disable, enable]
- dns-mode - No description for the parameter type: str choices: [auto, manual]
- dns-service - No description for the parameter type: str choices: [default, specify, local]
- domain - No description for the parameter type: str
- extgw - No description for the parameter type: str
- extgw_hubip - No description for the parameter type: str
- extgw_p2_per_net - No description for the parameter type: str choices: [disable, enable]
- extgwip - No description for the parameter type: str
- hub_iface - No description for the parameter type: str
- id - No description for the parameter type: int
- iface - No description for the parameter type: str
- ip-range - No description for the parameter type: array
- end-ip - No description for the parameter type: str
- id - No description for the parameter type: int
- start-ip - No description for the parameter type: str
- ipsec-lease-hold - No description for the parameter type: int
- ipv4-dns-server1 - No description for the parameter type: str
- ipv4-dns-server2 - No description for the parameter type: str
- ipv4-dns-server3 - No description for the parameter type: str
- ipv4-end-ip - No description for the parameter type: str
- ipv4-exclude-range - No description for the parameter type: array
- end-ip - No description for the parameter type: str
- id - No description for the parameter type: int
- start-ip - No description for the parameter type: str
- ipv4-netmask - No description for the parameter type: str
- ipv4-split-include - No description for the parameter type: str
- ipv4-start-ip - No description for the parameter type: str
- ipv4-wins-server1 - No description for the parameter type: str
- ipv4-wins-server2 - No description for the parameter type: str
- local-gw - No description for the parameter type: str
- localid - No description for the parameter type: str
- mode-cfg - No description for the parameter type: str choices: [disable, enable]
- mode-cfg-ip-version - No description for the parameter type: str choices: [4, 6]
- net-device - No description for the parameter type: str choices: [disable, enable]
- peer - No description for the parameter type: str
- peergrp - No description for the parameter type: str
- peerid - No description for the parameter type: str
- peertype - No description for the parameter type: str choices: [any, one, dialup, peer, peergrp]
- protected_subnet - No description for the parameter type: array
- addr - No description for the parameter type: str
- seq - No description for the parameter type: int
- public-ip - No description for the parameter type: str
- role - No description for the parameter type: str choices: [hub, spoke]
- route-overlap - No description for the parameter type: str choices: [use-old, use-new, allow]
- spoke-zone - No description for the parameter type: str
- summary_addr - No description for the parameter type: array
- addr - No description for the parameter type: str
- priority - No description for the parameter type: int
- seq - No description for the parameter type: int
- tunnel-search - No description for the parameter type: str choices: [selectors, nexthop]
- unity-support - No description for the parameter type: str choices: [disable, enable]
- usrgrp - No description for the parameter type: str
- vpn-interface-priority - No description for the parameter type: int
- vpn-zone - No description for the parameter type: str
- vpntable - No description for the parameter type: str
- xauthtype - No description for the parameter type: str choices: [disable, client, pap, chap, auto]
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. Must specify vpntable and scope member.
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, ...]>
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