fmgr_fsp_vlan_dynamicmapping_interface – Fsp vlan dynamic mapping interface.
Added in version 2.0.0.
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
Argument name before 3.0.0:
var-name
,var name
,var.name
New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
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>=2.15.0
FortiManager Version Compatibility
Supported Version Ranges: v6.0.0 -> v7.2.5
, v7.4.0 -> v7.4.0
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
- adom - The parameter in requested url type: str required: true
- vlan - The parameter in requested url type: str required: true
- dynamic_mapping - The parameter in requested url type: str required: true
- fsp_vlan_dynamicmapping_interface - Fsp vlan dynamic mapping interface type: dict
- ip Ip. type: str more...
- vlanid Vlanid. type: int more...
- dhcp_relay_agent_option (Alias name: dhcp-relay-agent-option) Dhcp relay agent option. type: str choices: [disable, enable] more...
- dhcp_relay_ip (Alias name: dhcp-relay-ip) Dhcp relay ip. type: list more...
- dhcp_relay_service (Alias name: dhcp-relay-service) Dhcp relay service. type: str choices: [disable, enable] more...
- dhcp_relay_type (Alias name: dhcp-relay-type) Dhcp relay type. type: str choices: [regular, ipsec] more...
- ipv6 Ipv6. type: dict
more...
- autoconf Autoconf. type: str choices: [disable, enable] more...
- dhcp6_client_options (Alias name: dhcp6-client-options) Dhcp6 client options. type: list choices: [rapid, iapd, iana, dns, dnsname] more...
- dhcp6_information_request (Alias name: dhcp6-information-request) Dhcp6 information request. type: str choices: [disable, enable] more...
- dhcp6_prefix_delegation (Alias name: dhcp6-prefix-delegation) Dhcp6 prefix delegation. type: str choices: [disable, enable] more...
- dhcp6_prefix_hint (Alias name: dhcp6-prefix-hint) Dhcp6 prefix hint. type: str more...
- dhcp6_prefix_hint_plt (Alias name: dhcp6-prefix-hint-plt) Dhcp6 prefix hint plt. type: int more...
- dhcp6_prefix_hint_vlt (Alias name: dhcp6-prefix-hint-vlt) Dhcp6 prefix hint vlt. type: int more...
- dhcp6_relay_ip (Alias name: dhcp6-relay-ip) Dhcp6 relay ip. type: str more...
- dhcp6_relay_service (Alias name: dhcp6-relay-service) Dhcp6 relay service. type: str choices: [disable, enable] more...
- dhcp6_relay_type (Alias name: dhcp6-relay-type) Dhcp6 relay type. type: str choices: [regular] more...
- ip6_address (Alias name: ip6-address) Ip6 address. type: str more...
- ip6_allowaccess (Alias name: ip6-allowaccess) Ip6 allowaccess. type: list choices: [https, ping, ssh, snmp, http, telnet, fgfm, capwap, fabric] more...
- ip6_default_life (Alias name: ip6-default-life) Ip6 default life. type: int more...
- ip6_delegated_prefix_list (Alias name: ip6-delegated-prefix-list) Ip6 delegated prefix list. type: list
more...
- autonomous_flag (Alias name: autonomous-flag) Autonomous flag. type: str choices: [disable, enable] more...
- onlink_flag (Alias name: onlink-flag) Onlink flag. type: str choices: [disable, enable] more...
- prefix_id (Alias name: prefix-id) Prefix id. type: int more...
- rdnss Rdnss. type: list more...
- rdnss_service (Alias name: rdnss-service) Rdnss service. type: str choices: [delegated, default, specify] more...
- subnet Subnet. type: str more...
- upstream_interface (Alias name: upstream-interface) Upstream interface. type: str more...
- delegated_prefix_iaid (Alias name: delegated-prefix-iaid) Iaid of obtained delegated-prefix from the upstream interface. type: int more...
- ip6_dns_server_override (Alias name: ip6-dns-server-override) Ip6 dns server override. type: str choices: [disable, enable] more...
- ip6_extra_addr (Alias name: ip6-extra-addr) Ip6 extra addr. type: list
more...
- prefix Prefix. type: str more...
- ip6_hop_limit (Alias name: ip6-hop-limit) Ip6 hop limit. type: int more...
- ip6_link_mtu (Alias name: ip6-link-mtu) Ip6 link mtu. type: int more...
- ip6_manage_flag (Alias name: ip6-manage-flag) Ip6 manage flag. type: str choices: [disable, enable] more...
- ip6_max_interval (Alias name: ip6-max-interval) Ip6 max interval. type: int more...
- ip6_min_interval (Alias name: ip6-min-interval) Ip6 min interval. type: int more...
- ip6_mode (Alias name: ip6-mode) Ip6 mode. type: str choices: [static, dhcp, pppoe, delegated] more...
- ip6_other_flag (Alias name: ip6-other-flag) Ip6 other flag. type: str choices: [disable, enable] more...
- ip6_prefix_list (Alias name: ip6-prefix-list) Ip6 prefix list. type: list
more...
- autonomous_flag (Alias name: autonomous-flag) Autonomous flag. type: str choices: [disable, enable] more...
- dnssl Dnssl. type: list more...
- onlink_flag (Alias name: onlink-flag) Onlink flag. type: str choices: [disable, enable] more...
- preferred_life_time (Alias name: preferred-life-time) Preferred life time. type: int more...
- prefix Prefix. type: str more...
- rdnss Rdnss. type: list more...
- valid_life_time (Alias name: valid-life-time) Valid life time. type: int more...
- ip6_reachable_time (Alias name: ip6-reachable-time) Ip6 reachable time. type: int more...
- ip6_retrans_time (Alias name: ip6-retrans-time) Ip6 retrans time. type: int more...
- ip6_send_adv (Alias name: ip6-send-adv) Ip6 send adv. type: str choices: [disable, enable] more...
- ip6_subnet (Alias name: ip6-subnet) Ip6 subnet. type: str more...
- ip6_upstream_interface (Alias name: ip6-upstream-interface) Ip6 upstream interface. type: str more...
- nd_cert (Alias name: nd-cert) Nd cert. type: str more...
- nd_cga_modifier (Alias name: nd-cga-modifier) Nd cga modifier. type: str more...
- nd_mode (Alias name: nd-mode) Nd mode. type: str choices: [basic, SEND-compatible] more...
- nd_security_level (Alias name: nd-security-level) Nd security level. type: int more...
- nd_timestamp_delta (Alias name: nd-timestamp-delta) Nd timestamp delta. type: int more...
- nd_timestamp_fuzz (Alias name: nd-timestamp-fuzz) Nd timestamp fuzz. type: int more...
- vrip6_link_local Vrip6 link local. type: str more...
- vrrp_virtual_mac6 (Alias name: vrrp-virtual-mac6) Vrrp virtual mac6. type: str choices: [disable, enable] more...
- vrrp6 Vrrp6. type: list
more...
- accept_mode (Alias name: accept-mode) Accept mode. type: str choices: [disable, enable] more...
- adv_interval (Alias name: adv-interval) Adv interval. type: int more...
- preempt Preempt. type: str choices: [disable, enable] more...
- priority Priority. type: int more...
- start_time (Alias name: start-time) Start time. type: int more...
- status Status. type: str choices: [disable, enable] more...
- vrdst6 Vrdst6. type: str more...
- vrgrp Vrgrp. type: int more...
- vrid Vrid. type: int more...
- vrip6 Vrip6. type: str more...
- interface_identifier (Alias name: interface-identifier) Interface identifier. type: str more...
- unique_autoconf_addr (Alias name: unique-autoconf-addr) Unique autoconf addr. type: str choices: [disable, enable] more...
- icmp6_send_redirect (Alias name: icmp6-send-redirect) Enable/disable sending of icmpv6 redirects. type: str choices: [disable, enable] more...
- cli_conn6_status (Alias name: cli-conn6-status) Cli conn6 status. type: int more...
- ip6_prefix_mode (Alias name: ip6-prefix-mode) Assigning a prefix from dhcp or ra. type: str choices: [dhcp6, ra] more...
- ra_send_mtu (Alias name: ra-send-mtu) Enable/disable sending link mtu in ra packet. type: str choices: [disable, enable] more...
- ip6_delegated_prefix_iaid (Alias name: ip6-delegated-prefix-iaid) Iaid of obtained delegated-prefix from the upstream interface. type: int more...
- dhcp6_relay_source_interface (Alias name: dhcp6-relay-source-interface) Enable/disable use of address on this interface as the source address of the relay message. type: str choices: [disable, enable] more...
- secondary_IP (Alias name: secondary-IP) Secondary ip. type: str choices: [disable, enable] more...
- secondaryip Secondaryip. type: list
more...
- allowaccess Allowaccess. type: list choices: [https, ping, ssh, snmp, http, telnet, fgfm, auto-ipsec, radius-acct, probe-response, capwap, dnp, ftm, fabric, speed-test] more...
- detectprotocol Detectprotocol. type: list choices: [ping, tcp-echo, udp-echo] more...
- detectserver Detectserver. type: str more...
- gwdetect Gwdetect. type: str choices: [disable, enable] more...
- ha_priority (Alias name: ha-priority) Ha priority. type: int more...
- id Id. type: int more...
- ip Ip. type: str more...
- ping_serv_status (Alias name: ping-serv-status) Ping serv status. type: int more...
- seq Seq. type: int more...
- secip_relay_ip (Alias name: secip-relay-ip) Dhcp relay ip address. type: str more...
- dhcp_relay_interface_select_method (Alias name: dhcp-relay-interface-select-method) Dhcp relay interface select method. type: str choices: [auto, sdwan, specify] more...
- vrrp Vrrp. type: list
more...
- accept_mode (Alias name: accept-mode) Enable/disable accept mode. type: str choices: [disable, enable] more...
- adv_interval (Alias name: adv-interval) Advertisement interval (1 - 255 seconds). type: int more...
- ignore_default_route (Alias name: ignore-default-route) Enable/disable ignoring of default route when checking destination. type: str choices: [disable, enable] more...
- preempt Enable/disable preempt mode. type: str choices: [disable, enable] more...
- priority Priority of the virtual router (1 - 255). type: int more...
- proxy_arp (Alias name: proxy-arp) Proxy arp. type: list more...
- start_time (Alias name: start-time) Startup time (1 - 255 seconds). type: int more...
- status Enable/disable this vrrp configuration. type: str choices: [disable, enable] more...
- version Vrrp version. type: str choices: [2, 3] more...
- vrdst Monitor the route to this destination. type: list more...
- vrdst_priority (Alias name: vrdst-priority) Priority of the virtual router when the virtual router destination becomes unreachable (0 - 254). type: int more...
- vrgrp Vrrp group id (1 - 65535). type: int more...
- vrid Virtual router identifier (1 - 255). type: int more...
- vrip Ip address of the virtual router. type: str 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
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: 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.