fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_interface module – Fsp vlan dynamic mapping interface
Note
This module is part of the fortinet.fortimanager collection (version 2.8.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_fsp_vlan_dynamicmapping_interface.
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:
|
|
The parameter (dynamic_mapping) in requested url. |
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The top level parameters set. |
|
Dhcp relay agent option. Choices:
|
|
Dhcp relay interface select method. Choices:
|
|
(list) Dhcp relay ip. |
|
Dhcp relay service. Choices:
|
|
Dhcp relay type. Choices:
|
|
Ip. |
|
Ipv6. |
|
Autoconf. Choices:
|
|
Cli conn6 status. |
|
Dhcp6 client options. Choices:
|
|
Dhcp6 information request. Choices:
|
|
Dhcp6 prefix delegation. Choices:
|
|
Dhcp6 prefix hint. |
|
Dhcp6 prefix hint plt. |
|
Dhcp6 prefix hint vlt. |
|
Dhcp6 relay ip. |
|
Dhcp6 relay service. Choices:
|
|
Enable/disable use of address on this interface as the source address of the relay message. Choices:
|
|
Dhcp6 relay type. Choices:
|
|
Enable/disable sending of ICMPv6 redirects. Choices:
|
|
Interface identifier. |
|
Ip6 address. |
|
Ip6 allowaccess. Choices:
|
|
Ip6 default life. |
|
IAID of obtained delegated-prefix from the upstream interface. |
|
Ip6 delegated prefix list. |
|
Autonomous flag. Choices:
|
|
IAID of obtained delegated-prefix from the upstream interface. |
|
Onlink flag. Choices:
|
|
Prefix id. |
|
(list) Rdnss. |
|
Rdnss service. Choices:
|
|
Subnet. |
|
Upstream interface. |
|
Ip6 dns server override. Choices:
|
|
Ip6 extra addr. |
|
Prefix. |
|
Ip6 hop limit. |
|
Ip6 link mtu. |
|
Ip6 manage flag. Choices:
|
|
Ip6 max interval. |
|
Ip6 min interval. |
|
Ip6 mode. Choices:
|
|
Ip6 other flag. Choices:
|
|
Ip6 prefix list. |
|
Autonomous flag. Choices:
|
|
(list) Dnssl. |
|
Onlink flag. Choices:
|
|
Preferred life time. |
|
Prefix. |
|
(list) Rdnss. |
|
Valid life time. |
|
Assigning a prefix from DHCP or RA. Choices:
|
|
Ip6 reachable time. |
|
Ip6 retrans time. |
|
Ip6 send adv. Choices:
|
|
Ip6 subnet. |
|
Ip6 upstream interface. |
|
Nd cert. |
|
Nd cga modifier. |
|
Nd mode. Choices:
|
|
Nd security level. |
|
Nd timestamp delta. |
|
Nd timestamp fuzz. |
|
Enable/disable sending link MTU in RA packet. Choices:
|
|
Unique autoconf addr. Choices:
|
|
Vrip6 link local. |
|
Vrrp6. |
|
Accept mode. Choices:
|
|
Adv interval. |
|
Preempt. Choices:
|
|
Priority. |
|
Start time. |
|
Status. Choices:
|
|
Vrdst6. |
|
Vrgrp. |
|
Vrid. |
|
Vrip6. |
|
Vrrp virtual mac6. Choices:
|
|
Secondary IP. Choices:
|
|
Secondaryip. |
|
Allowaccess. Choices:
|
|
Detectprotocol. Choices:
|
|
Detectserver. |
|
Gwdetect. Choices:
|
|
Ha priority. |
|
Id. |
|
Ip. |
|
Ping serv status. |
|
DHCP relay IP address. |
|
Seq. |
|
Vlanid. |
|
Vrrp. |
|
Enable/disable accept mode. Choices:
|
|
Advertisement interval |
|
Enable/disable ignoring of default route when checking destination. Choices:
|
|
Enable/disable preempt mode. Choices:
|
|
Priority of the virtual router |
|
Proxy arp. |
|
ID. |
|
Set IP addresses of proxy ARP. |
|
Startup time |
|
Enable/disable this VRRP configuration. Choices:
|
|
VRRP version. Choices:
|
|
(list) Monitor the route to this destination. |
|
Priority of the virtual router when the virtual router destination becomes unreachable |
|
VRRP group ID |
|
Virtual router identifier |
|
IP address of the virtual router. |
|
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 parameter (vlan) in requested url. |
|
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.
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: Fsp vlan dynamic mapping interface
fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_interface:
# 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>
vlan: <your own value>
dynamic_mapping: <your own value>
fsp_vlan_dynamicmapping_interface:
ip: <string>
vlanid: <integer>
dhcp_relay_agent_option: <value in [disable, enable]>
dhcp_relay_ip: <list or string>
dhcp_relay_service: <value in [disable, enable]>
dhcp_relay_type: <value in [regular, ipsec]>
ipv6:
autoconf: <value in [disable, enable]>
dhcp6_client_options:
- "rapid"
- "iapd"
- "iana"
- "dns"
- "dnsname"
dhcp6_information_request: <value in [disable, enable]>
dhcp6_prefix_delegation: <value in [disable, enable]>
dhcp6_prefix_hint: <string>
dhcp6_prefix_hint_plt: <integer>
dhcp6_prefix_hint_vlt: <integer>
dhcp6_relay_ip: <string>
dhcp6_relay_service: <value in [disable, enable]>
dhcp6_relay_type: <value in [regular]>
ip6_address: <string>
ip6_allowaccess:
- "https"
- "ping"
- "ssh"
- "snmp"
- "http"
- "telnet"
- "fgfm"
- "capwap"
- "fabric"
ip6_default_life: <integer>
ip6_delegated_prefix_list:
-
autonomous_flag: <value in [disable, enable]>
onlink_flag: <value in [disable, enable]>
prefix_id: <integer>
rdnss: <list or string>
rdnss_service: <value in [delegated, default, specify]>
subnet: <string>
upstream_interface: <string>
delegated_prefix_iaid: <integer>
ip6_dns_server_override: <value in [disable, enable]>
ip6_extra_addr:
-
prefix: <string>
ip6_hop_limit: <integer>
ip6_link_mtu: <integer>
ip6_manage_flag: <value in [disable, enable]>
ip6_max_interval: <integer>
ip6_min_interval: <integer>
ip6_mode: <value in [static, dhcp, pppoe, ...]>
ip6_other_flag: <value in [disable, enable]>
ip6_prefix_list:
-
autonomous_flag: <value in [disable, enable]>
dnssl: <list or string>
onlink_flag: <value in [disable, enable]>
preferred_life_time: <integer>
prefix: <string>
rdnss: <list or string>
valid_life_time: <integer>
ip6_reachable_time: <integer>
ip6_retrans_time: <integer>
ip6_send_adv: <value in [disable, enable]>
ip6_subnet: <string>
ip6_upstream_interface: <string>
nd_cert: <string>
nd_cga_modifier: <string>
nd_mode: <value in [basic, SEND-compatible]>
nd_security_level: <integer>
nd_timestamp_delta: <integer>
nd_timestamp_fuzz: <integer>
vrip6_link_local: <string>
vrrp_virtual_mac6: <value in [disable, enable]>
vrrp6:
-
accept_mode: <value in [disable, enable]>
adv_interval: <integer>
preempt: <value in [disable, enable]>
priority: <integer>
start_time: <integer>
status: <value in [disable, enable]>
vrdst6: <string>
vrgrp: <integer>
vrid: <integer>
vrip6: <string>
interface_identifier: <string>
unique_autoconf_addr: <value in [disable, enable]>
icmp6_send_redirect: <value in [disable, enable]>
cli_conn6_status: <integer>
ip6_prefix_mode: <value in [dhcp6, ra]>
ra_send_mtu: <value in [disable, enable]>
ip6_delegated_prefix_iaid: <integer>
dhcp6_relay_source_interface: <value in [disable, enable]>
secondary_IP: <value in [disable, enable]>
secondaryip:
-
allowaccess:
- "https"
- "ping"
- "ssh"
- "snmp"
- "http"
- "telnet"
- "fgfm"
- "auto-ipsec"
- "radius-acct"
- "probe-response"
- "capwap"
- "dnp"
- "ftm"
- "fabric"
- "speed-test"
detectprotocol:
- "ping"
- "tcp-echo"
- "udp-echo"
detectserver: <string>
gwdetect: <value in [disable, enable]>
ha_priority: <integer>
id: <integer>
ip: <string>
ping_serv_status: <integer>
seq: <integer>
secip_relay_ip: <string>
dhcp_relay_interface_select_method: <value in [auto, sdwan, specify]>
vrrp:
-
accept_mode: <value in [disable, enable]>
adv_interval: <integer>
ignore_default_route: <value in [disable, enable]>
preempt: <value in [disable, enable]>
priority: <integer>
proxy_arp:
-
id: <integer>
ip: <string>
start_time: <integer>
status: <value in [disable, enable]>
version: <value in [2, 3]>
vrdst: <list or string>
vrdst_priority: <integer>
vrgrp: <integer>
vrid: <integer>
vrip: <string>
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 |