Try Spotterno description
| "added in version" 2.0.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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: No description
fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping:
# 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>
state: present # <value in [present, absent]>
fsp_vlan_dynamicmapping:
_dhcp_status: <value in [disable, enable]>
_scope:
-
name: <string>
vdom: <string>
dhcp_server:
auto_configuration: <value in [disable, enable]>
auto_managed_status: <value in [disable, enable]>
conflicted_ip_timeout: <integer>
ddns_auth: <value in [disable, tsig]>
ddns_key: <list or string>
ddns_keyname: <string>
ddns_server_ip: <string>
ddns_ttl: <integer>
ddns_update: <value in [disable, enable]>
ddns_update_override: <value in [disable, enable]>
ddns_zone: <string>
default_gateway: <string>
dhcp_settings_from_fortiipam: <value in [disable, enable]>
dns_server1: <string>
dns_server2: <string>
dns_server3: <string>
dns_server4: <string>
dns_service: <value in [default, specify, local]>
domain: <string>
enable: <value in [disable, enable]>
exclude_range:
-
end_ip: <string>
id: <integer>
start_ip: <string>
vci_match: <value in [disable, enable]>
vci_string: <list or string>
lease_time: <integer>
uci_match: <value in [disable, enable]>
uci_string: <list or string>
filename: <string>
forticlient_on_net_status: <value in [disable, enable]>
id: <integer>
ip_mode: <value in [range, usrgrp]>
ip_range:
-
end_ip: <string>
id: <integer>
start_ip: <string>
vci_match: <value in [disable, enable]>
vci_string: <list or string>
lease_time: <integer>
uci_match: <value in [disable, enable]>
uci_string: <list or string>
ipsec_lease_hold: <integer>
lease_time: <integer>
mac_acl_default_action: <value in [assign, block]>
netmask: <string>
next_server: <string>
ntp_server1: <string>
ntp_server2: <string>
ntp_server3: <string>
ntp_service: <value in [default, specify, local]>
option1: <list or string>
option2: <list or string>
option3: <list or string>
option4: <string>
option5: <string>
option6: <string>
options:
-
code: <integer>
id: <integer>
ip: <list or string>
type: <value in [hex, string, ip, ...]>
value: <string>
vci_match: <value in [disable, enable]>
vci_string: <list or string>
uci_match: <value in [disable, enable]>
uci_string: <list or string>
reserved_address:
-
action: <value in [assign, block, reserved]>
circuit_id: <string>
circuit_id_type: <value in [hex, string]>
description: <string>
id: <integer>
ip: <string>
mac: <string>
remote_id: <string>
remote_id_type: <value in [hex, string]>
type: <value in [mac, option82]>
server_type: <value in [regular, ipsec]>
status: <value in [disable, enable]>
tftp_server: <list or string>
timezone: <value in [00, 01, 02, ...]>
timezone_option: <value in [disable, default, specify]>
vci_match: <value in [disable, enable]>
vci_string: <list or string>
wifi_ac_service: <value in [specify, local]>
wifi_ac1: <string>
wifi_ac2: <string>
wifi_ac3: <string>
wins_server1: <string>
wins_server2: <string>
relay_agent: <string>
shared_subnet: <value in [disable, enable]>
interface:
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]>
ip: <string>
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]>
icmp6_send_redirect: <value in [disable, enable]>
interface_identifier: <string>
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>
unique_autoconf_addr: <value in [disable, enable]>
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>
ignore_default_route: <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]>
dhcp6_relay_interface_id: <string>
dhcp6_relay_source_ip: <string>
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>
vlanid: <integer>
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>
adom:
description: The parameter (adom) in requested url.
required: true
type: str
vlan:
description: The parameter (vlan) in requested url.
required: true
type: str
state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
fsp_vlan_dynamicmapping:
description: The top level parameters set.
required: false
suboptions:
_dhcp-status:
choices:
- disable
- enable
description: Deprecated, please rename it to _dhcp_status.
type: str
_scope:
description: No description.
elements: dict
suboptions:
name:
description: No description.
type: str
vdom:
description: No description.
type: str
type: list
dhcp-server:
description: Deprecated, please rename it to dhcp_server.
suboptions:
auto-configuration:
choices:
- disable
- enable
description: Deprecated, please rename it to auto_configuration. Enable/disable
auto configuration.
type: str
auto-managed-status:
choices:
- disable
- enable
description: Deprecated, please rename it to auto_managed_status. Enable/disable
use of this DHCP server once this interface ha...
type: str
conflicted-ip-timeout:
description: Deprecated, please rename it to conflicted_ip_timeout. Time in
seconds to wait after a conflicted IP address is re...
type: int
ddns-auth:
choices:
- disable
- tsig
description: Deprecated, please rename it to ddns_auth. DDNS authentication
mode.
type: str
ddns-key:
description: (list or str) Deprecated, please rename it to ddns_key. DDNS
update key
type: raw
ddns-keyname:
description: Deprecated, please rename it to ddns_keyname. DDNS update key
name.
type: str
ddns-server-ip:
description: Deprecated, please rename it to ddns_server_ip. DDNS server IP.
type: str
ddns-ttl:
description: Deprecated, please rename it to ddns_ttl. TTL.
type: int
ddns-update:
choices:
- disable
- enable
description: Deprecated, please rename it to ddns_update. Enable/disable DDNS
update for DHCP.
type: str
ddns-update-override:
choices:
- disable
- enable
description: Deprecated, please rename it to ddns_update_override. Enable/disable
DDNS update override for DHCP.
type: str
ddns-zone:
description: Deprecated, please rename it to ddns_zone. Zone of your domain
name
type: str
default-gateway:
description: Deprecated, please rename it to default_gateway. Default gateway
IP address assigned by the DHCP server.
type: str
dhcp-settings-from-fortiipam:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp_settings_from_fortiipam.
Enable/disable populating of DHCP server settings fr...
type: str
dns-server1:
description: Deprecated, please rename it to dns_server1. DNS server 1.
type: str
dns-server2:
description: Deprecated, please rename it to dns_server2. DNS server 2.
type: str
dns-server3:
description: Deprecated, please rename it to dns_server3. DNS server 3.
type: str
dns-server4:
description: Deprecated, please rename it to dns_server4. DNS server 4.
type: str
dns-service:
choices:
- default
- specify
- local
description: Deprecated, please rename it to dns_service. Options for assigning
DNS servers to DHCP clients.
type: str
domain:
description: Domain name suffix for the IP addresses that the DHCP server
assigns to clients.
type: str
enable:
choices:
- disable
- enable
description: No description.
type: str
exclude-range:
description: Deprecated, please rename it to exclude_range.
elements: dict
suboptions:
end-ip:
description: Deprecated, please rename it to end_ip. End of IP range.
type: str
id:
description: ID.
type: int
lease-time:
description: Deprecated, please rename it to lease_time. Lease time in
seconds, 0 means default lease time.
type: int
start-ip:
description: Deprecated, please rename it to start_ip. Start of IP range.
type: str
uci-match:
choices:
- disable
- enable
description: Deprecated, please rename it to uci_match. Enable/disable
user class identifier
type: str
uci-string:
description: (list) Deprecated, please rename it to uci_string.
type: raw
vci-match:
choices:
- disable
- enable
description: Deprecated, please rename it to vci_match. Enable/disable
vendor class identifier
type: str
vci-string:
description: (list) Deprecated, please rename it to vci_string.
type: raw
type: list
filename:
description: Name of the boot file on the TFTP server.
type: str
forticlient-on-net-status:
choices:
- disable
- enable
description: Deprecated, please rename it to forticlient_on_net_status. Enable/disable
FortiClient-On-Net service for this DHCP...
type: str
id:
description: ID.
type: int
ip-mode:
choices:
- range
- usrgrp
description: Deprecated, please rename it to ip_mode. Method used to assign
client IP.
type: str
ip-range:
description: Deprecated, please rename it to ip_range.
elements: dict
suboptions:
end-ip:
description: Deprecated, please rename it to end_ip. End of IP range.
type: str
id:
description: ID.
type: int
lease-time:
description: Deprecated, please rename it to lease_time. Lease time in
seconds, 0 means default lease time.
type: int
start-ip:
description: Deprecated, please rename it to start_ip. Start of IP range.
type: str
uci-match:
choices:
- disable
- enable
description: Deprecated, please rename it to uci_match. Enable/disable
user class identifier
type: str
uci-string:
description: (list) Deprecated, please rename it to uci_string.
type: raw
vci-match:
choices:
- disable
- enable
description: Deprecated, please rename it to vci_match. Enable/disable
vendor class identifier
type: str
vci-string:
description: (list) Deprecated, please rename it to vci_string.
type: raw
type: list
ipsec-lease-hold:
description: Deprecated, please rename it to ipsec_lease_hold. DHCP over IPsec
leases expire this many seconds after tunnel down
type: int
lease-time:
description: Deprecated, please rename it to lease_time. Lease time in seconds,
0 means unlimited.
type: int
mac-acl-default-action:
choices:
- assign
- block
description: Deprecated, please rename it to mac_acl_default_action. MAC access
control default action
type: str
netmask:
description: Netmask assigned by the DHCP server.
type: str
next-server:
description: Deprecated, please rename it to next_server. IP address of a
server
type: str
ntp-server1:
description: Deprecated, please rename it to ntp_server1. NTP server 1.
type: str
ntp-server2:
description: Deprecated, please rename it to ntp_server2. NTP server 2.
type: str
ntp-server3:
description: Deprecated, please rename it to ntp_server3. NTP server 3.
type: str
ntp-service:
choices:
- default
- specify
- local
description: Deprecated, please rename it to ntp_service. Options for assigning
Network Time Protocol
type: str
option1:
description: (list) No description.
type: raw
option2:
description: (list) No description.
type: raw
option3:
description: (list) No description.
type: raw
option4:
description: No description.
type: str
option5:
description: No description.
type: str
option6:
description: No description.
type: str
options:
description: No description.
elements: dict
suboptions:
code:
description: DHCP option code.
type: int
id:
description: ID.
type: int
ip:
description: (list) No description.
type: raw
type:
choices:
- hex
- string
- ip
- fqdn
description: DHCP option type.
type: str
uci-match:
choices:
- disable
- enable
description: Deprecated, please rename it to uci_match. Enable/disable
user class identifier
type: str
uci-string:
description: (list) Deprecated, please rename it to uci_string.
type: raw
value:
description: DHCP option value.
type: str
vci-match:
choices:
- disable
- enable
description: Deprecated, please rename it to vci_match. Enable/disable
vendor class identifier
type: str
vci-string:
description: (list) Deprecated, please rename it to vci_string.
type: raw
type: list
relay-agent:
description: Deprecated, please rename it to relay_agent. Relay agent IP.
type: str
reserved-address:
description: Deprecated, please rename it to reserved_address.
elements: dict
suboptions:
action:
choices:
- assign
- block
- reserved
description: Options for the DHCP server to configure the client with
the reserved MAC address.
type: str
circuit-id:
description: Deprecated, please rename it to circuit_id. Option 82 circuit-ID
of the client that will get the reserved ...
type: str
circuit-id-type:
choices:
- hex
- string
description: Deprecated, please rename it to circuit_id_type. DHCP option
type.
type: str
description:
description: Description.
type: str
id:
description: ID.
type: int
ip:
description: IP address to be reserved for the MAC address.
type: str
mac:
description: MAC address of the client that will get the reserved IP address.
type: str
remote-id:
description: Deprecated, please rename it to remote_id. Option 82 remote-ID
of the client that will get the reserved IP...
type: str
remote-id-type:
choices:
- hex
- string
description: Deprecated, please rename it to remote_id_type. DHCP option
type.
type: str
type:
choices:
- mac
- option82
description: DHCP reserved-address type.
type: str
type: list
server-type:
choices:
- regular
- ipsec
description: Deprecated, please rename it to server_type. DHCP server can
be a normal DHCP server or an IPsec DHCP server.
type: str
shared-subnet:
choices:
- disable
- enable
description: Deprecated, please rename it to shared_subnet. Enable/disable
shared subnet.
type: str
status:
choices:
- disable
- enable
description: Enable/disable this DHCP configuration.
type: str
tftp-server:
description: (list) Deprecated, please rename it to tftp_server.
type: raw
timezone:
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'
description: Select the time zone to be assigned to DHCP clients.
type: str
timezone-option:
choices:
- disable
- default
- specify
description: Deprecated, please rename it to timezone_option. Options for
the DHCP server to set the clients time zone.
type: str
vci-match:
choices:
- disable
- enable
description: Deprecated, please rename it to vci_match. Enable/disable vendor
class identifier
type: str
vci-string:
description: (list) Deprecated, please rename it to vci_string.
type: raw
wifi-ac-service:
choices:
- specify
- local
description: Deprecated, please rename it to wifi_ac_service. Options for
assigning WiFi Access Controllers to DHCP clients
type: str
wifi-ac1:
description: Deprecated, please rename it to wifi_ac1. WiFi Access Controller
1 IP address
type: str
wifi-ac2:
description: Deprecated, please rename it to wifi_ac2. WiFi Access Controller
2 IP address
type: str
wifi-ac3:
description: Deprecated, please rename it to wifi_ac3. WiFi Access Controller
3 IP address
type: str
wins-server1:
description: Deprecated, please rename it to wins_server1. WINS server 1.
type: str
wins-server2:
description: Deprecated, please rename it to wins_server2. WINS server 2.
type: str
type: dict
interface:
description: No description.
suboptions:
dhcp-relay-agent-option:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp_relay_agent_option.
type: str
dhcp-relay-interface-select-method:
choices:
- auto
- sdwan
- specify
description: Deprecated, please rename it to dhcp_relay_interface_select_method.
type: str
dhcp-relay-ip:
description: (list) Deprecated, please rename it to dhcp_relay_ip.
type: raw
dhcp-relay-service:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp_relay_service.
type: str
dhcp-relay-type:
choices:
- regular
- ipsec
description: Deprecated, please rename it to dhcp_relay_type.
type: str
ip:
description: No description.
type: str
ipv6:
description: No description.
suboptions:
autoconf:
choices:
- disable
- enable
description: Enable/disable address auto config.
type: str
cli-conn6-status:
description: Deprecated, please rename it to cli_conn6_status.
type: int
dhcp6-client-options:
choices:
- rapid
- iapd
- iana
- dns
- dnsname
description: Deprecated, please rename it to dhcp6_client_options.
elements: str
type: list
dhcp6-information-request:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp6_information_request.
Enable/disable DHCPv6 information request.
type: str
dhcp6-prefix-delegation:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp6_prefix_delegation.
Enable/disable DHCPv6 prefix delegation.
type: str
dhcp6-prefix-hint:
description: Deprecated, please rename it to dhcp6_prefix_hint. DHCPv6
prefix that will be used as a hint to the upstre...
type: str
dhcp6-prefix-hint-plt:
description: Deprecated, please rename it to dhcp6_prefix_hint_plt. DHCPv6
prefix hint preferred life time
type: int
dhcp6-prefix-hint-vlt:
description: Deprecated, please rename it to dhcp6_prefix_hint_vlt. DHCPv6
prefix hint valid life time
type: int
dhcp6-relay-interface-id:
description: Deprecated, please rename it to dhcp6_relay_interface_id.
DHCP6 relay interface ID.
type: str
dhcp6-relay-ip:
description: Deprecated, please rename it to dhcp6_relay_ip. DHCPv6 relay
IP address.
type: str
dhcp6-relay-service:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp6_relay_service. Enable/disable
DHCPv6 relay.
type: str
dhcp6-relay-source-interface:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp6_relay_source_interface.
Enable/disable use of address on this interf...
type: str
dhcp6-relay-source-ip:
description: Deprecated, please rename it to dhcp6_relay_source_ip. IPv6
address used by the DHCP6 relay as its source IP.
type: str
dhcp6-relay-type:
choices:
- regular
description: Deprecated, please rename it to dhcp6_relay_type. DHCPv6
relay type.
type: str
icmp6-send-redirect:
choices:
- disable
- enable
description: Deprecated, please rename it to icmp6_send_redirect. Enable/disable
sending of ICMPv6 redirects.
type: str
interface-identifier:
description: Deprecated, please rename it to interface_identifier. IPv6
interface identifier.
type: str
ip6-address:
description: Deprecated, please rename it to ip6_address. Primary IPv6
address prefix, syntax
type: str
ip6-allowaccess:
choices:
- https
- ping
- ssh
- snmp
- http
- telnet
- fgfm
- capwap
- fabric
description: Deprecated, please rename it to ip6_allowaccess.
elements: str
type: list
ip6-default-life:
description: Deprecated, please rename it to ip6_default_life. Default
life
type: int
ip6-delegated-prefix-iaid:
description: Deprecated, please rename it to ip6_delegated_prefix_iaid.
IAID of obtained delegated-prefix from the upst...
type: int
ip6-delegated-prefix-list:
description: Deprecated, please rename it to ip6_delegated_prefix_list.
elements: dict
suboptions:
autonomous-flag:
choices:
- disable
- enable
description: Deprecated, please rename it to autonomous_flag. Enable/disable
the autonomous flag.
type: str
delegated-prefix-iaid:
description: Deprecated, please rename it to delegated_prefix_iaid.
IAID of obtained delegated-prefix from the ...
type: int
onlink-flag:
choices:
- disable
- enable
description: Deprecated, please rename it to onlink_flag. Enable/disable
the onlink flag.
type: str
prefix-id:
description: Deprecated, please rename it to prefix_id. Prefix ID.
type: int
rdnss:
description: (list) No description.
type: raw
rdnss-service:
choices:
- delegated
- default
- specify
description: Deprecated, please rename it to rdnss_service. Recursive
DNS service option.
type: str
subnet:
description: Add subnet ID to routing prefix.
type: str
upstream-interface:
description: Deprecated, please rename it to upstream_interface. Name
of the interface that provides delegated ...
type: str
type: list
ip6-dns-server-override:
choices:
- disable
- enable
description: Deprecated, please rename it to ip6_dns_server_override.
Enable/disable using the DNS server acquired by DHCP.
type: str
ip6-extra-addr:
description: Deprecated, please rename it to ip6_extra_addr.
elements: dict
suboptions:
prefix:
description: IPv6 address prefix.
type: str
type: list
ip6-hop-limit:
description: Deprecated, please rename it to ip6_hop_limit. Hop limit
type: int
ip6-link-mtu:
description: Deprecated, please rename it to ip6_link_mtu. IPv6 link MTU.
type: int
ip6-manage-flag:
choices:
- disable
- enable
description: Deprecated, please rename it to ip6_manage_flag. Enable/disable
the managed flag.
type: str
ip6-max-interval:
description: Deprecated, please rename it to ip6_max_interval. IPv6 maximum
interval
type: int
ip6-min-interval:
description: Deprecated, please rename it to ip6_min_interval. IPv6 minimum
interval
type: int
ip6-mode:
choices:
- static
- dhcp
- pppoe
- delegated
description: Deprecated, please rename it to ip6_mode. Addressing mode
type: str
ip6-other-flag:
choices:
- disable
- enable
description: Deprecated, please rename it to ip6_other_flag. Enable/disable
the other IPv6 flag.
type: str
ip6-prefix-list:
description: Deprecated, please rename it to ip6_prefix_list.
elements: dict
suboptions:
autonomous-flag:
choices:
- disable
- enable
description: Deprecated, please rename it to autonomous_flag. Enable/disable
the autonomous flag.
type: str
dnssl:
description: (list) No description.
type: raw
onlink-flag:
choices:
- disable
- enable
description: Deprecated, please rename it to onlink_flag. Enable/disable
the onlink flag.
type: str
preferred-life-time:
description: Deprecated, please rename it to preferred_life_time.
Preferred life time
type: int
prefix:
description: IPv6 prefix.
type: str
rdnss:
description: (list) No description.
type: raw
valid-life-time:
description: Deprecated, please rename it to valid_life_time. Valid
life time
type: int
type: list
ip6-prefix-mode:
choices:
- dhcp6
- ra
description: Deprecated, please rename it to ip6_prefix_mode. Assigning
a prefix from DHCP or RA.
type: str
ip6-reachable-time:
description: Deprecated, please rename it to ip6_reachable_time. IPv6
reachable time
type: int
ip6-retrans-time:
description: Deprecated, please rename it to ip6_retrans_time. IPv6 retransmit
time
type: int
ip6-send-adv:
choices:
- disable
- enable
description: Deprecated, please rename it to ip6_send_adv. Enable/disable
sending advertisements about the interface.
type: str
ip6-subnet:
description: Deprecated, please rename it to ip6_subnet. Subnet to routing
prefix, syntax
type: str
ip6-upstream-interface:
description: Deprecated, please rename it to ip6_upstream_interface. Interface
name providing delegated information.
type: str
nd-cert:
description: Deprecated, please rename it to nd_cert. Neighbor discovery
certificate.
type: str
nd-cga-modifier:
description: Deprecated, please rename it to nd_cga_modifier. Neighbor
discovery CGA modifier.
type: str
nd-mode:
choices:
- basic
- SEND-compatible
description: Deprecated, please rename it to nd_mode. Neighbor discovery
mode.
type: str
nd-security-level:
description: Deprecated, please rename it to nd_security_level. Neighbor
discovery security level
type: int
nd-timestamp-delta:
description: Deprecated, please rename it to nd_timestamp_delta. Neighbor
discovery timestamp delta value
type: int
nd-timestamp-fuzz:
description: Deprecated, please rename it to nd_timestamp_fuzz. Neighbor
discovery timestamp fuzz factor
type: int
ra-send-mtu:
choices:
- disable
- enable
description: Deprecated, please rename it to ra_send_mtu. Enable/disable
sending link MTU in RA packet.
type: str
unique-autoconf-addr:
choices:
- disable
- enable
description: Deprecated, please rename it to unique_autoconf_addr. Enable/disable
unique auto config address.
type: str
vrip6_link_local:
description: Link-local IPv6 address of virtual router.
type: str
vrrp-virtual-mac6:
choices:
- disable
- enable
description: Deprecated, please rename it to vrrp_virtual_mac6. Enable/disable
virtual MAC for VRRP.
type: str
vrrp6:
description: No description.
elements: dict
suboptions:
accept-mode:
choices:
- disable
- enable
description: Deprecated, please rename it to accept_mode. Enable/disable
accept mode.
type: str
adv-interval:
description: Deprecated, please rename it to adv_interval. Advertisement
interval
type: int
ignore-default-route:
choices:
- disable
- enable
description: Deprecated, please rename it to ignore_default_route.
Enable/disable ignoring of default route whe...
type: str
preempt:
choices:
- disable
- enable
description: Enable/disable preempt mode.
type: str
priority:
description: Priority of the virtual router
type: int
start-time:
description: Deprecated, please rename it to start_time. Startup time
type: int
status:
choices:
- disable
- enable
description: Enable/disable VRRP.
type: str
vrdst6:
description: Monitor the route to this destination.
type: str
vrgrp:
description: VRRP group ID
type: int
vrid:
description: Virtual router identifier
type: int
vrip6:
description: IPv6 address of the virtual router.
type: str
type: list
type: dict
secondary-IP:
choices:
- disable
- enable
description: Deprecated, please rename it to secondary_IP.
type: str
secondaryip:
description: No description.
elements: dict
suboptions:
allowaccess:
choices:
- https
- ping
- ssh
- snmp
- http
- telnet
- fgfm
- auto-ipsec
- radius-acct
- probe-response
- capwap
- dnp
- ftm
- fabric
- speed-test
description: No description.
elements: str
type: list
detectprotocol:
choices:
- ping
- tcp-echo
- udp-echo
description: No description.
elements: str
type: list
detectserver:
description: Gateways ping server for this IP.
type: str
gwdetect:
choices:
- disable
- enable
description: Enable/disable detect gateway alive for first.
type: str
ha-priority:
description: Deprecated, please rename it to ha_priority. HA election
priority for the PING server.
type: int
id:
description: ID.
type: int
ip:
description: Secondary IP address of the interface.
type: str
ping-serv-status:
description: Deprecated, please rename it to ping_serv_status.
type: int
secip-relay-ip:
description: Deprecated, please rename it to secip_relay_ip. DHCP relay
IP address.
type: str
seq:
description: No description.
type: int
type: list
vlanid:
description: No description.
type: int
vrrp:
description: No description.
elements: dict
suboptions:
accept-mode:
choices:
- disable
- enable
description: Deprecated, please rename it to accept_mode. Enable/disable
accept mode.
type: str
adv-interval:
description: Deprecated, please rename it to adv_interval. Advertisement
interval
type: int
ignore-default-route:
choices:
- disable
- enable
description: Deprecated, please rename it to ignore_default_route. Enable/disable
ignoring of default route when checki...
type: str
preempt:
choices:
- disable
- enable
description: Enable/disable preempt mode.
type: str
priority:
description: Priority of the virtual router
type: int
proxy-arp:
description: Deprecated, please rename it to proxy_arp.
elements: dict
suboptions:
id:
description: ID.
type: int
ip:
description: Set IP addresses of proxy ARP.
type: str
type: list
start-time:
description: Deprecated, please rename it to start_time. Startup time
type: int
status:
choices:
- disable
- enable
description: Enable/disable this VRRP configuration.
type: str
version:
choices:
- '2'
- '3'
description: VRRP version.
type: str
vrdst:
description: (list) No description.
type: raw
vrdst-priority:
description: Deprecated, please rename it to vrdst_priority. Priority
of the virtual router when the virtual router des...
type: int
vrgrp:
description: VRRP group ID
type: int
vrid:
description: Virtual router identifier
type: int
vrip:
description: IP address of the virtual router.
type: str
type: list
type: dict
type: dict
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list