fmgd_system_fabricvpn – Setup for self orchestrated fabric auto discovery VPN.
Added in version 1.0.0.
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 v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible-core>=2.16.0
FortiManager Version Compatibility
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
Parameters
- access_token -The token to access FortiManager without using username and password. type: str required: false
- 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
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- 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
- 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
- device - The parameter in requested url type: str required: true
- system_fabricvpn - Setup for self orchestrated fabric auto discovery VPN. type: dict
- advertised_subnets (Alias name: advertised-subnets) Advertised subnets. type: list
more...
- access Access policy direction. type: str choices: [inbound, bidirectional] more...
- bgp_network (Alias name: bgp-network) Underlying bgp network. type: list more...
- firewall_address (Alias name: firewall-address) Underlying firewall address. type: list more...
- id Id. type: int more...
- policies Underlying policies. type: list more...
- prefix Network prefix. type: list more...
- bgp_as (Alias name: bgp-as) Bgp router as number, valid from 1 to 4294967295. type: int more...
- branch_name (Alias name: branch-name) Branch name. type: str more...
- health_checks (Alias name: health-checks) Underlying health checks. type: list more...
- loopback_address_block (Alias name: loopback-address-block) Ipv4 address and subnet mask for hubs loopback address, syntax: x. type: list more...
- loopback_advertised_subnet (Alias name: loopback-advertised-subnet) Loopback advertised subnet reference. type: list more...
- loopback_interface (Alias name: loopback-interface) Loopback interface. type: list more...
- overlays Overlays. type: list
more...
- bgp_neighbor (Alias name: bgp-neighbor) Underlying bgp neighbor entry. type: list more...
- bgp_neighbor_group (Alias name: bgp-neighbor-group) Underlying bgp neighbor group entry. type: list more...
- bgp_neighbor_range (Alias name: bgp-neighbor-range) Underlying bgp neighbor range entry. type: list more...
- bgp_network (Alias name: bgp-network) Underlying bgp network. type: list more...
- interface Underlying interface name. type: list more...
- ipsec_phase1 (Alias name: ipsec-phase1) Ipsec interface. type: list more...
- name Overlay name. type: str more...
- overlay_policy (Alias name: overlay-policy) The overlay policy to allow advpn thru traffic. type: list more...
- overlay_tunnel_block (Alias name: overlay-tunnel-block) Ipv4 address and subnet mask for the overlay tunnel , syntax: x. type: list more...
- remote_gw (Alias name: remote-gw) Ip address of the hub gateway (set by hub). type: str more...
- route_policy (Alias name: route-policy) Underlying router policy. type: list more...
- sdwan_member (Alias name: sdwan-member) Reference to sd-wan member entry. type: list more...
- ipsec_network_id (Alias name: ipsec-network-id) Vpn gateway network id. type: int more...
- policy_rule (Alias name: policy-rule) Policy creation rule. type: str choices: [health-check, manual, auto] more...
- populated Populated the setting in tables. type: int more...
- psksecret Pre-shared secret for advpn. type: list more...
- sdwan_zone (Alias name: sdwan-zone) Reference to created sd-wan zone. type: list more...
- status Enable/disable fabric vpn. type: str choices: [disable, enable] more...
- sync_mode (Alias name: sync-mode) Setting synchronised by fabric or manual. type: str choices: [disable, enable] more...
- vpn_role (Alias name: vpn-role) Fabric vpn role. type: str choices: [hub, spoke] more...
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
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Setup for self orchestrated fabric auto discovery VPN.
fortinet.fmgdevice.fmgd_system_fabricvpn:
# bypass_validation: false
# workspace_locking_adom: <global or your adom name>
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device: <your own value>
system_fabricvpn:
# advertised_subnets:
# - access: <value in [inbound, bidirectional]>
# bgp_network: <list or string>
# firewall_address: <list or string>
# id: <integer>
# policies: <list or string>
# prefix: <list or string>
# bgp_as: <integer>
# branch_name: <string>
# health_checks: <list or string>
# loopback_address_block: <list or string>
# loopback_advertised_subnet: <list or string>
# loopback_interface: <list or string>
# overlays:
# - bgp_neighbor: <list or string>
# bgp_neighbor_group: <list or string>
# bgp_neighbor_range: <list or string>
# bgp_network: <list or string>
# interface: <list or string>
# ipsec_phase1: <list or string>
# name: <string>
# overlay_policy: <list or string>
# overlay_tunnel_block: <list or string>
# remote_gw: <string>
# route_policy: <list or string>
# sdwan_member: <list or string>
# ipsec_network_id: <integer>
# policy_rule: <value in [health-check, manual, auto]>
# populated: <integer>
# psksecret: <list or string>
# sdwan_zone: <list or string>
# status: <value in [disable, enable]>
# sync_mode: <value in [disable, enable]>
# vpn_role: <value in [hub, spoke]>
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:
- meta - The result of the request.returned: always type: dict
- 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_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.