:source: fmgr_fsp_vlan_dynamicmapping.py
:orphan:
.. _fmgr_fsp_vlan_dynamicmapping:
fmgr_fsp_vlan_dynamicmapping -- Fsp vlan dynamic mapping.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 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.
.. contents::
:local:
:depth: 1
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
----------------------------------
.. raw:: html
Supported Version Ranges: v6.0.0 -> latest
Parameters
----------
.. raw:: html
- 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
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- 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
- revision_note - The change note that can be specified when an object is created or updated. type: string required: false
- adom - The parameter in requested url type: str required: true
- vlan - The parameter in requested url type: str required: true
- fsp_vlan_dynamicmapping - Fsp vlan dynamic mapping type: dict
- _dhcp_status (Alias name: _dhcp-status) Dhcp status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- _scope Scope. type: list
more...
Supported Version Ranges: v6.0.0 -> latest
- name Name. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- vdom Vdom. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- dhcp_server (Alias name: dhcp-server) Dhcp server. type: dict
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- auto_configuration (Alias name: auto-configuration) Enable/disable auto configuration. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- auto_managed_status (Alias name: auto-managed-status) Enable/disable use of this dhcp server once this interface has been assigned an ip address from fortiipam. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.4.5 -> latest
- conflicted_ip_timeout (Alias name: conflicted-ip-timeout) Time in seconds to wait after a conflicted ip address is removed from the dhcp range before it can be reused. type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ddns_auth (Alias name: ddns-auth) Ddns authentication mode. type: str choices: [disable, tsig]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ddns_key (Alias name: ddns-key) Ddns update key (base 64 encoding). type: list or str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ddns_keyname (Alias name: ddns-keyname) Ddns update key name. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ddns_server_ip (Alias name: ddns-server-ip) Ddns server ip. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ddns_ttl (Alias name: ddns-ttl) Ttl. type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ddns_update (Alias name: ddns-update) Enable/disable ddns update for dhcp. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ddns_update_override (Alias name: ddns-update-override) Enable/disable ddns update override for dhcp. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ddns_zone (Alias name: ddns-zone) Zone of your domain name (ex. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- default_gateway (Alias name: default-gateway) Default gateway ip address assigned by the dhcp server. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- dhcp_settings_from_fortiipam (Alias name: dhcp-settings-from-fortiipam) Enable/disable populating of dhcp server settings from fortiipam. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.4.5 -> latest
- dns_server1 (Alias name: dns-server1) Dns server 1. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- dns_server2 (Alias name: dns-server2) Dns server 2. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- dns_server3 (Alias name: dns-server3) Dns server 3. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- dns_server4 (Alias name: dns-server4) Dns server 4. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- dns_service (Alias name: dns-service) Options for assigning dns servers to dhcp clients. type: str choices: [default, specify, local]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- domain Domain name suffix for the ip addresses that the dhcp server assigns to clients. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- enable Enable. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- exclude_range (Alias name: exclude-range) Exclude range. type: list
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- end_ip (Alias name: end-ip) End of ip range. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- id Id. type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- start_ip (Alias name: start-ip) Start of ip range. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- vci_match (Alias name: vci-match) Enable/disable vendor class identifier (vci) matching. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- vci_string (Alias name: vci-string) One or more vci strings in quotes separated by spaces. type: list
more...
Supported Version Ranges: v7.2.1 -> latest
- lease_time (Alias name: lease-time) Lease time in seconds, 0 means default lease time. type: int
more...
Supported Version Ranges: v7.2.2 -> latest
- uci_match (Alias name: uci-match) Enable/disable user class identifier (uci) matching. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.2 -> latest
- uci_string (Alias name: uci-string) One or more uci strings in quotes separated by spaces. type: list
more...
Supported Version Ranges: v7.2.2 -> latest
- filename Name of the boot file on the tftp server. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- forticlient_on_net_status (Alias name: forticlient-on-net-status) Enable/disable forticlient-on-net service for this dhcp server. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- id Id. type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ip_mode (Alias name: ip-mode) Method used to assign client ip. type: str choices: [range, usrgrp]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ip_range (Alias name: ip-range) Ip range. type: list
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- end_ip (Alias name: end-ip) End of ip range. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- id Id. type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- start_ip (Alias name: start-ip) Start of ip range. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- vci_match (Alias name: vci-match) Enable/disable vendor class identifier (vci) matching. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- vci_string (Alias name: vci-string) One or more vci strings in quotes separated by spaces. type: list
more...
Supported Version Ranges: v7.2.1 -> latest
- lease_time (Alias name: lease-time) Lease time in seconds, 0 means default lease time. type: int
more...
Supported Version Ranges: v7.2.2 -> latest
- uci_match (Alias name: uci-match) Enable/disable user class identifier (uci) matching. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.2 -> latest
- uci_string (Alias name: uci-string) One or more uci strings in quotes separated by spaces. type: list
more...
Supported Version Ranges: v7.2.2 -> latest
- ipsec_lease_hold (Alias name: ipsec-lease-hold) Dhcp over ipsec leases expire this many seconds after tunnel down (0 to disable forced-expiry). type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- lease_time (Alias name: lease-time) Lease time in seconds, 0 means unlimited. type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- mac_acl_default_action (Alias name: mac-acl-default-action) Mac access control default action (allow or block assigning ip settings). type: str choices: [assign, block]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- netmask Netmask assigned by the dhcp server. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- next_server (Alias name: next-server) Ip address of a server (for example, a tftp sever) that dhcp clients can download a boot file from. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ntp_server1 (Alias name: ntp-server1) Ntp server 1. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ntp_server2 (Alias name: ntp-server2) Ntp server 2. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ntp_server3 (Alias name: ntp-server3) Ntp server 3. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ntp_service (Alias name: ntp-service) Options for assigning network time protocol (ntp) servers to dhcp clients. type: str choices: [default, specify, local]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- option1 Option1. type: list
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- option2 Option2. type: list
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- option3 Option3. type: list
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- option4 Option4. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- option5 Option5. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- option6 Option6. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- options Options. type: list
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- code Dhcp option code. type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- id Id. type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ip Dhcp option ips. type: list
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- type Dhcp option type. type: str choices: [hex, string, ip, fqdn]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- value Dhcp option value. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- vci_match (Alias name: vci-match) Enable/disable vendor class identifier (vci) matching. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- vci_string (Alias name: vci-string) One or more vci strings in quotes separated by spaces. type: list
more...
Supported Version Ranges: v7.2.1 -> latest
- uci_match (Alias name: uci-match) Enable/disable user class identifier (uci) matching. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.2 -> latest
- uci_string (Alias name: uci-string) One or more uci strings in quotes separated by spaces. type: list
more...
Supported Version Ranges: v7.2.2 -> latest
- reserved_address (Alias name: reserved-address) Reserved address. type: list
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- action Options for the dhcp server to configure the client with the reserved mac address. type: str choices: [assign, block, reserved]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- circuit_id (Alias name: circuit-id) Option 82 circuit-id of the client that will get the reserved ip address. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- circuit_id_type (Alias name: circuit-id-type) Dhcp option type. type: str choices: [hex, string]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- description Description. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- id Id. type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ip Ip address to be reserved for the mac address. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- mac Mac address of the client that will get the reserved ip address. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- remote_id (Alias name: remote-id) Option 82 remote-id of the client that will get the reserved ip address. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- remote_id_type (Alias name: remote-id-type) Dhcp option type. type: str choices: [hex, string]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- type Dhcp reserved-address type. type: str choices: [mac, option82]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- server_type (Alias name: server-type) Dhcp server can be a normal dhcp server or an ipsec dhcp server. type: str choices: [regular, ipsec]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- status Enable/disable this dhcp configuration. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- tftp_server (Alias name: tftp-server) One or more hostnames or ip addresses of the tftp servers in quotes separated by spaces. type: list
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- timezone Select the time zone to be assigned to dhcp clients. type: str choices: [00, 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- timezone_option (Alias name: timezone-option) Options for the dhcp server to set the clients time zone. type: str choices: [disable, default, specify]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- vci_match (Alias name: vci-match) Enable/disable vendor class identifier (vci) matching. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- vci_string (Alias name: vci-string) One or more vci strings in quotes separated by spaces. type: list
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- wifi_ac_service (Alias name: wifi-ac-service) Options for assigning wifi access controllers to dhcp clients type: str choices: [specify, local]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- wifi_ac1 (Alias name: wifi-ac1) Wifi access controller 1 ip address (dhcp option 138, rfc 5417). type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- wifi_ac2 (Alias name: wifi-ac2) Wifi access controller 2 ip address (dhcp option 138, rfc 5417). type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- wifi_ac3 (Alias name: wifi-ac3) Wifi access controller 3 ip address (dhcp option 138, rfc 5417). type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- wins_server1 (Alias name: wins-server1) Wins server 1. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- wins_server2 (Alias name: wins-server2) Wins server 2. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- relay_agent (Alias name: relay-agent) Relay agent ip. type: str
more...
Supported Version Ranges: v7.4.0 -> latest
- shared_subnet (Alias name: shared-subnet) Enable/disable shared subnet. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.0 -> latest
- interface Interface. type: dict
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- dhcp_relay_agent_option (Alias name: dhcp-relay-agent-option) Dhcp relay agent option. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- dhcp_relay_ip (Alias name: dhcp-relay-ip) Dhcp relay ip. type: list
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- dhcp_relay_service (Alias name: dhcp-relay-service) Dhcp relay service. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- dhcp_relay_type (Alias name: dhcp-relay-type) Dhcp relay type. type: str choices: [regular, ipsec]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ip Ip. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ipv6 Ipv6. type: dict
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- autoconf Enable/disable address auto config. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- dhcp6_client_options (Alias name: dhcp6-client-options) Dhcp6 client options. type: list choices: [rapid, iapd, iana, dns, dnsname]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- dhcp6_information_request (Alias name: dhcp6-information-request) Enable/disable dhcpv6 information request. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- dhcp6_prefix_delegation (Alias name: dhcp6-prefix-delegation) Enable/disable dhcpv6 prefix delegation. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- dhcp6_prefix_hint (Alias name: dhcp6-prefix-hint) Dhcpv6 prefix that will be used as a hint to the upstream dhcpv6 server. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- dhcp6_prefix_hint_plt (Alias name: dhcp6-prefix-hint-plt) Dhcpv6 prefix hint preferred life time (sec), 0 means unlimited lease time. type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- dhcp6_prefix_hint_vlt (Alias name: dhcp6-prefix-hint-vlt) Dhcpv6 prefix hint valid life time (sec). type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- dhcp6_relay_ip (Alias name: dhcp6-relay-ip) Dhcpv6 relay ip address. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- dhcp6_relay_service (Alias name: dhcp6-relay-service) Enable/disable dhcpv6 relay. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- dhcp6_relay_type (Alias name: dhcp6-relay-type) Dhcpv6 relay type. type: str choices: [regular]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- icmp6_send_redirect (Alias name: icmp6-send-redirect) Enable/disable sending of icmpv6 redirects. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.4.5 -> latest
- interface_identifier (Alias name: interface-identifier) Ipv6 interface identifier. type: str
more...
Supported Version Ranges: v6.4.5 -> latest
- ip6_address (Alias name: ip6-address) Primary ipv6 address prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ip6_allowaccess (Alias name: ip6-allowaccess) Allow management access to the interface. type: list choices: [https, ping, ssh, snmp, http, telnet, fgfm, capwap, fabric, scim, probe-response]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ip6_default_life (Alias name: ip6-default-life) Default life (sec). type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ip6_delegated_prefix_list (Alias name: ip6-delegated-prefix-list) Ip6 delegated prefix list. type: list
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- autonomous_flag (Alias name: autonomous-flag) Enable/disable the autonomous flag. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- onlink_flag (Alias name: onlink-flag) Enable/disable the onlink flag. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- prefix_id (Alias name: prefix-id) Prefix id. type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- rdnss Recursive dns server option. type: list
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- rdnss_service (Alias name: rdnss-service) Recursive dns service option. type: str choices: [delegated, default, specify]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- subnet Add subnet id to routing prefix. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- upstream_interface (Alias name: upstream-interface) Name of the interface that provides delegated information. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- delegated_prefix_iaid (Alias name: delegated-prefix-iaid) Iaid of obtained delegated-prefix from the upstream interface. type: int
more...
Supported Version Ranges: v7.0.2 -> latest
- dnssl_service (Alias name: dnssl-service) Enable/disable use of domain from delegated prefix for dnssl. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.5 -> latest
- ip6_dns_server_override (Alias name: ip6-dns-server-override) Enable/disable using the dns server acquired by dhcp. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ip6_extra_addr (Alias name: ip6-extra-addr) Ip6 extra addr. type: list
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- prefix Ipv6 address prefix. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ip6_hop_limit (Alias name: ip6-hop-limit) Hop limit (0 means unspecified). type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ip6_link_mtu (Alias name: ip6-link-mtu) Ipv6 link mtu. type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ip6_manage_flag (Alias name: ip6-manage-flag) Enable/disable the managed flag. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ip6_max_interval (Alias name: ip6-max-interval) Ipv6 maximum interval (4 to 1800 sec). type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ip6_min_interval (Alias name: ip6-min-interval) Ipv6 minimum interval (3 to 1350 sec). type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ip6_mode (Alias name: ip6-mode) Addressing mode (static, dhcp, delegated). type: str choices: [static, dhcp, pppoe, delegated]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ip6_other_flag (Alias name: ip6-other-flag) Enable/disable the other ipv6 flag. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ip6_prefix_list (Alias name: ip6-prefix-list) Ip6 prefix list. type: list
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- autonomous_flag (Alias name: autonomous-flag) Enable/disable the autonomous flag. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- dnssl Dns search list option. type: list
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- onlink_flag (Alias name: onlink-flag) Enable/disable the onlink flag. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- preferred_life_time (Alias name: preferred-life-time) Preferred life time (sec). type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- prefix Ipv6 prefix. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- rdnss Recursive dns server option. type: list
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- valid_life_time (Alias name: valid-life-time) Valid life time (sec). type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ip6_reachable_time (Alias name: ip6-reachable-time) Ipv6 reachable time (milliseconds; 0 means unspecified). type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ip6_retrans_time (Alias name: ip6-retrans-time) Ipv6 retransmit time (milliseconds; 0 means unspecified). type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ip6_send_adv (Alias name: ip6-send-adv) Enable/disable sending advertisements about the interface. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ip6_subnet (Alias name: ip6-subnet) Subnet to routing prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ip6_upstream_interface (Alias name: ip6-upstream-interface) Interface name providing delegated information. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- nd_cert (Alias name: nd-cert) Neighbor discovery certificate. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- nd_cga_modifier (Alias name: nd-cga-modifier) Neighbor discovery cga modifier. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- nd_mode (Alias name: nd-mode) Neighbor discovery mode. type: str choices: [basic, SEND-compatible]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- nd_security_level (Alias name: nd-security-level) Neighbor discovery security level (0 - 7; 0 = least secure, default = 0). type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- nd_timestamp_delta (Alias name: nd-timestamp-delta) Neighbor discovery timestamp delta value (1 - 3600 sec; default = 300). type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- nd_timestamp_fuzz (Alias name: nd-timestamp-fuzz) Neighbor discovery timestamp fuzz factor (1 - 60 sec; default = 1). type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- unique_autoconf_addr (Alias name: unique-autoconf-addr) Enable/disable unique auto config address. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.4.5 -> latest
- vrip6_link_local Link-local ipv6 address of virtual router. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- vrrp_virtual_mac6 (Alias name: vrrp-virtual-mac6) Enable/disable virtual mac for vrrp. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- vrrp6 Vrrp6. type: list
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- accept_mode (Alias name: accept-mode) Enable/disable accept mode. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- adv_interval (Alias name: adv-interval) Advertisement interval (1 - 255 seconds). type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- preempt Enable/disable preempt mode. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- priority Priority of the virtual router (1 - 255). type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- start_time (Alias name: start-time) Startup time (1 - 255 seconds). type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- status Enable/disable vrrp. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- vrdst6 Monitor the route to this destination. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- vrgrp Vrrp group id (1 - 65535). type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- vrid Virtual router identifier (1 - 255). type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- vrip6 Ipv6 address of the virtual router. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ignore_default_route (Alias name: ignore-default-route) Enable/disable ignoring of default route when checking destination. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.2 -> latest
- vrdst_priority (Alias name: vrdst-priority) Priority of the virtual router when the virtual router destination becomes unreachable (0 - 254). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- cli_conn6_status (Alias name: cli-conn6-status) Cli conn6 status. type: int
more...
Supported Version Ranges: v7.0.0 -> latest
- ip6_prefix_mode (Alias name: ip6-prefix-mode) Assigning a prefix from dhcp or ra. type: str choices: [dhcp6, ra]
more...
Supported Version Ranges: v7.0.0 -> latest
- ra_send_mtu (Alias name: ra-send-mtu) Enable/disable sending link mtu in ra packet. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.4.6 -> latest
- ip6_delegated_prefix_iaid (Alias name: ip6-delegated-prefix-iaid) Iaid of obtained delegated-prefix from the upstream interface. type: int
more...
Supported Version Ranges: v7.0.2 -> latest
- 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...
Supported Version Ranges: v7.2.2 -> latest
- dhcp6_relay_interface_id (Alias name: dhcp6-relay-interface-id) Dhcp6 relay interface id. type: str
more...
Supported Version Ranges: v7.4.1 -> latest
- dhcp6_relay_source_ip (Alias name: dhcp6-relay-source-ip) Ipv6 address used by the dhcp6 relay as its source ip. type: str
more...
Supported Version Ranges: v7.4.1 -> latest
- ip6_adv_rio (Alias name: ip6-adv-rio) Enable/disable sending advertisements with route information option. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.2 -> latest
- ip6_route_pref (Alias name: ip6-route-pref) Set route preference to the interface (default = medium). type: str choices: [medium, high, low]
more...
Supported Version Ranges: v7.6.2 -> latest
- secondary_IP (Alias name: secondary-IP) Secondary ip. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- secondaryip Secondaryip. type: list
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- allowaccess Management access settings for the secondary ip address. type: list choices: [https, ping, ssh, snmp, http, telnet, fgfm, auto-ipsec, radius-acct, probe-response, capwap, dnp, ftm, fabric, speed-test, icond, scim]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- detectprotocol Protocols used to detect the server. type: list choices: [ping, tcp-echo, udp-echo]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> v7.2.0
- detectserver Gateways ping server for this ip. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> v7.2.0
- gwdetect Enable/disable detect gateway alive for first. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> v7.2.0
- ha_priority (Alias name: ha-priority) Ha election priority for the ping server. type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> v7.2.0
- id Id. type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ip Secondary ip address of the interface. type: str
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- ping_serv_status (Alias name: ping-serv-status) Ping serv status. type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> v7.2.0
- seq Seq. type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- secip_relay_ip (Alias name: secip-relay-ip) Dhcp relay ip address. type: str
more...
Supported Version Ranges: v7.4.0 -> latest
- vlanid Vlanid. type: int
more...
Supported Version Ranges: v6.2.8 -> v6.2.13, v6.4.5 -> latest
- dhcp_relay_interface_select_method (Alias name: dhcp-relay-interface-select-method) Dhcp relay interface select method. type: str choices: [auto, sdwan, specify]
more...
Supported Version Ranges: v6.4.8 -> v6.4.15, v7.0.4 -> latest
- vrrp Vrrp. type: list
more...
Supported Version Ranges: v7.4.0 -> latest
- accept_mode (Alias name: accept-mode) Enable/disable accept mode. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.0 -> latest
- adv_interval (Alias name: adv-interval) Advertisement interval (1 - 255 seconds). type: int
more...
Supported Version Ranges: v7.4.0 -> latest
- ignore_default_route (Alias name: ignore-default-route) Enable/disable ignoring of default route when checking destination. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.0 -> latest
- preempt Enable/disable preempt mode. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.0 -> latest
- priority Priority of the virtual router (1 - 255). type: int
more...
Supported Version Ranges: v7.4.0 -> latest
- proxy_arp (Alias name: proxy-arp) Proxy arp. type: list
more...
Supported Version Ranges: v7.4.0 -> latest
- id Id. type: int
more...
Supported Version Ranges: v7.4.0 -> latest
- ip Set ip addresses of proxy arp. type: str
more...
Supported Version Ranges: v7.4.0 -> latest
- start_time (Alias name: start-time) Startup time (1 - 255 seconds). type: int
more...
Supported Version Ranges: v7.4.0 -> latest
- status Enable/disable this vrrp configuration. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.0 -> latest
- version Vrrp version. type: str choices: [2, 3]
more...
Supported Version Ranges: v7.4.0 -> latest
- vrdst Monitor the route to this destination. type: list
more...
Supported Version Ranges: v7.4.0 -> latest
- vrdst_priority (Alias name: vrdst-priority) Priority of the virtual router when the virtual router destination becomes unreachable (0 - 254). type: int
more...
Supported Version Ranges: v7.4.0 -> latest
- vrgrp Vrrp group id (1 - 65535). type: int
more...
Supported Version Ranges: v7.4.0 -> latest
- vrid Virtual router identifier (1 - 255). type: int
more...
Supported Version Ranges: v7.4.0 -> latest
- vrip Ip address of the virtual router. type: str
more...
Supported Version Ranges: v7.4.0 -> latest
- allowaccess Allowaccess. type: list choices: [https, ping, ssh, snmp, http, telnet, fgfm, radius-acct, probe-response, dnp, ftm, fabric, speed-test, icond, scim]
more...
Supported Version Ranges: v7.4.7 -> v7.4.10, v7.6.3 -> latest
- dhcp_relay_request_all_server (Alias name: dhcp-relay-request-all-server) Dhcp relay request all server. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.7 -> v7.4.10, v7.6.3 -> latest
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
--------
.. code-block:: yaml+jinja
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Fsp vlan dynamic mapping
fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping:
# workspace_locking_adom:
adom:
vlan:
state: present #
fsp_vlan_dynamicmapping:
# _dhcp_status:
# _scope:
# - name:
# vdom:
# dhcp_server:
# auto_configuration:
# auto_managed_status:
# conflicted_ip_timeout:
# ddns_auth:
# ddns_key:
# ddns_keyname:
# ddns_server_ip:
# ddns_ttl:
# ddns_update:
# ddns_update_override:
# ddns_zone:
# default_gateway:
# dhcp_settings_from_fortiipam:
# dns_server1:
# dns_server2:
# dns_server3:
# dns_server4:
# dns_service:
# domain:
# enable:
# exclude_range:
# - end_ip:
# id:
# start_ip:
# vci_match:
# vci_string:
# lease_time:
# uci_match:
# uci_string:
# filename:
# forticlient_on_net_status:
# id:
# ip_mode:
# ip_range:
# - end_ip:
# id:
# start_ip:
# vci_match:
# vci_string:
# lease_time:
# uci_match:
# uci_string:
# ipsec_lease_hold:
# lease_time:
# mac_acl_default_action:
# netmask:
# next_server:
# ntp_server1:
# ntp_server2:
# ntp_server3:
# ntp_service:
# option1:
# option2:
# option3:
# option4:
# option5:
# option6:
# options:
# - code:
# id:
# ip:
# type:
# value:
# vci_match:
# vci_string:
# uci_match:
# uci_string:
# reserved_address:
# - action:
# circuit_id:
# circuit_id_type:
# description:
# id:
# ip:
# mac:
# remote_id:
# remote_id_type:
# type:
# server_type:
# status:
# tftp_server:
# timezone:
# timezone_option:
# vci_match:
# vci_string:
# wifi_ac_service:
# wifi_ac1:
# wifi_ac2:
# wifi_ac3:
# wins_server1:
# wins_server2:
# relay_agent:
# shared_subnet:
# interface:
# dhcp_relay_agent_option:
# dhcp_relay_ip:
# dhcp_relay_service:
# dhcp_relay_type:
# ip:
# ipv6:
# autoconf:
# dhcp6_client_options: ["rapid", "iapd", "iana", "dns", "dnsname"]
# dhcp6_information_request:
# dhcp6_prefix_delegation:
# dhcp6_prefix_hint:
# dhcp6_prefix_hint_plt:
# dhcp6_prefix_hint_vlt:
# dhcp6_relay_ip:
# dhcp6_relay_service:
# dhcp6_relay_type:
# icmp6_send_redirect:
# interface_identifier:
# ip6_address:
# ip6_allowaccess: ["https", "ping", "ssh", "snmp", "http", "telnet", "fgfm",
# "capwap", "fabric", "scim", "probe-response"]
# ip6_default_life:
# ip6_delegated_prefix_list:
# - autonomous_flag:
# onlink_flag:
# prefix_id:
# rdnss:
# rdnss_service:
# subnet:
# upstream_interface:
# delegated_prefix_iaid:
# dnssl_service:
# ip6_dns_server_override:
# ip6_extra_addr:
# - prefix:
# ip6_hop_limit:
# ip6_link_mtu:
# ip6_manage_flag:
# ip6_max_interval:
# ip6_min_interval:
# ip6_mode:
# ip6_other_flag:
# ip6_prefix_list:
# - autonomous_flag:
# dnssl:
# onlink_flag:
# preferred_life_time:
# prefix:
# rdnss:
# valid_life_time:
# ip6_reachable_time:
# ip6_retrans_time:
# ip6_send_adv:
# ip6_subnet:
# ip6_upstream_interface:
# nd_cert:
# nd_cga_modifier:
# nd_mode:
# nd_security_level:
# nd_timestamp_delta:
# nd_timestamp_fuzz:
# unique_autoconf_addr:
# vrip6_link_local:
# vrrp_virtual_mac6:
# vrrp6:
# - accept_mode:
# adv_interval:
# preempt:
# priority:
# start_time:
# status:
# vrdst6:
# vrgrp:
# vrid:
# vrip6:
# ignore_default_route:
# vrdst_priority:
# cli_conn6_status:
# ip6_prefix_mode:
# ra_send_mtu:
# ip6_delegated_prefix_iaid:
# dhcp6_relay_source_interface:
# dhcp6_relay_interface_id:
# dhcp6_relay_source_ip:
# ip6_adv_rio:
# ip6_route_pref:
# secondary_IP:
# secondaryip:
# - allowaccess: ["https", "ping", "ssh", "snmp", "http", "telnet", "fgfm",
# "auto-ipsec", "radius-acct", "probe-response", "capwap", "dnp",
# "ftm", "fabric", "speed-test", "icond", "scim"]
# detectprotocol: ["ping", "tcp-echo", "udp-echo"]
# detectserver:
# gwdetect:
# ha_priority:
# id:
# ip:
# ping_serv_status:
# seq:
# secip_relay_ip:
# vlanid:
# dhcp_relay_interface_select_method:
# vrrp:
# - accept_mode:
# adv_interval:
# ignore_default_route:
# preempt:
# priority:
# proxy_arp:
# - id:
# ip:
# start_time:
# status:
# version:
# vrdst:
# vrdst_priority:
# vrgrp:
# vrid:
# vrip:
# allowaccess: ["https", "ping", "ssh", "snmp", "http", "telnet", "fgfm",
# "radius-acct", "probe-response", "dnp", "ftm", "fabric", "speed-test",
# "icond", "scim"]
# dhcp_relay_request_all_server:
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:
.. raw:: html
- 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.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)