Try Spotterno description
| "added in version" 2.0.0 of drmofu.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 drmofu.fortimanager:==2.2.2
collections:
- name: drmofu.fortimanager
version: 2.2.2This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: no description
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: <value in [present, absent]>
fsp_vlan_dynamicmapping:
_dhcp-status: <value in [disable, enable]>
_scope:
-
name: <value of string>
vdom: <value of string>
dhcp-server:
auto-configuration: <value in [disable, enable]>
auto-managed-status: <value in [disable, enable]>
conflicted-ip-timeout: <value of integer>
ddns-auth: <value in [disable, tsig]>
ddns-key: <value of string>
ddns-keyname: <value of string>
ddns-server-ip: <value of string>
ddns-ttl: <value of integer>
ddns-update: <value in [disable, enable]>
ddns-update-override: <value in [disable, enable]>
ddns-zone: <value of string>
default-gateway: <value of string>
dhcp-settings-from-fortiipam: <value in [disable, enable]>
dns-server1: <value of string>
dns-server2: <value of string>
dns-server3: <value of string>
dns-server4: <value of string>
dns-service: <value in [default, specify, local]>
domain: <value of string>
enable: <value in [disable, enable]>
exclude-range:
-
end-ip: <value of string>
id: <value of integer>
start-ip: <value of string>
vci-match: <value in [disable, enable]>
vci-string: <value of string>
lease-time: <value of integer>
uci-match: <value in [disable, enable]>
uci-string: <value of string>
filename: <value of string>
forticlient-on-net-status: <value in [disable, enable]>
id: <value of integer>
ip-mode: <value in [range, usrgrp]>
ip-range:
-
end-ip: <value of string>
id: <value of integer>
start-ip: <value of string>
vci-match: <value in [disable, enable]>
vci-string: <value of string>
lease-time: <value of integer>
uci-match: <value in [disable, enable]>
uci-string: <value of string>
ipsec-lease-hold: <value of integer>
lease-time: <value of integer>
mac-acl-default-action: <value in [assign, block]>
netmask: <value of string>
next-server: <value of string>
ntp-server1: <value of string>
ntp-server2: <value of string>
ntp-server3: <value of string>
ntp-service: <value in [default, specify, local]>
option1: <value of string>
option2: <value of string>
option3: <value of string>
option4: <value of string>
option5: <value of string>
option6: <value of string>
options:
-
code: <value of integer>
id: <value of integer>
ip: <value of string>
type: <value in [hex, string, ip, ...]>
value: <value of string>
vci-match: <value in [disable, enable]>
vci-string: <value of string>
uci-match: <value in [disable, enable]>
uci-string: <value of string>
reserved-address:
-
action: <value in [assign, block, reserved]>
circuit-id: <value of string>
circuit-id-type: <value in [hex, string]>
description: <value of string>
id: <value of integer>
ip: <value of string>
mac: <value of string>
remote-id: <value of 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: <value of string>
timezone: <value in [00, 01, 02, ...]>
timezone-option: <value in [disable, default, specify]>
vci-match: <value in [disable, enable]>
vci-string: <value of string>
wifi-ac-service: <value in [specify, local]>
wifi-ac1: <value of string>
wifi-ac2: <value of string>
wifi-ac3: <value of string>
wins-server1: <value of string>
wins-server2: <value of string>
relay-agent: <value of string>
shared-subnet: <value in [disable, enable]>
interface:
dhcp-relay-agent-option: <value in [disable, enable]>
dhcp-relay-ip: <value of string>
dhcp-relay-service: <value in [disable, enable]>
dhcp-relay-type: <value in [regular, ipsec]>
ip: <value of 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: <value of string>
dhcp6-prefix-hint-plt: <value of integer>
dhcp6-prefix-hint-vlt: <value of integer>
dhcp6-relay-ip: <value of string>
dhcp6-relay-service: <value in [disable, enable]>
dhcp6-relay-type: <value in [regular]>
icmp6-send-redirect: <value in [disable, enable]>
interface-identifier: <value of string>
ip6-address: <value of string>
ip6-allowaccess:
- https
- ping
- ssh
- snmp
- http
- telnet
- fgfm
- capwap
- fabric
ip6-default-life: <value of integer>
ip6-delegated-prefix-list:
-
autonomous-flag: <value in [disable, enable]>
onlink-flag: <value in [disable, enable]>
prefix-id: <value of integer>
rdnss: <value of string>
rdnss-service: <value in [delegated, default, specify]>
subnet: <value of string>
upstream-interface: <value of string>
delegated-prefix-iaid: <value of integer>
ip6-dns-server-override: <value in [disable, enable]>
ip6-extra-addr:
-
prefix: <value of string>
ip6-hop-limit: <value of integer>
ip6-link-mtu: <value of integer>
ip6-manage-flag: <value in [disable, enable]>
ip6-max-interval: <value of integer>
ip6-min-interval: <value of 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: <value of string>
onlink-flag: <value in [disable, enable]>
preferred-life-time: <value of integer>
prefix: <value of string>
rdnss: <value of string>
valid-life-time: <value of integer>
ip6-reachable-time: <value of integer>
ip6-retrans-time: <value of integer>
ip6-send-adv: <value in [disable, enable]>
ip6-subnet: <value of string>
ip6-upstream-interface: <value of string>
nd-cert: <value of string>
nd-cga-modifier: <value of string>
nd-mode: <value in [basic, SEND-compatible]>
nd-security-level: <value of integer>
nd-timestamp-delta: <value of integer>
nd-timestamp-fuzz: <value of integer>
unique-autoconf-addr: <value in [disable, enable]>
vrip6_link_local: <value of string>
vrrp-virtual-mac6: <value in [disable, enable]>
vrrp6:
-
accept-mode: <value in [disable, enable]>
adv-interval: <value of integer>
preempt: <value in [disable, enable]>
priority: <value of integer>
start-time: <value of integer>
status: <value in [disable, enable]>
vrdst6: <value of string>
vrgrp: <value of integer>
vrid: <value of integer>
vrip6: <value of string>
cli-conn6-status: <value of integer>
ip6-prefix-mode: <value in [dhcp6, ra]>
ra-send-mtu: <value in [disable, enable]>
ip6-delegated-prefix-iaid: <value of 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: <value of string>
gwdetect: <value in [disable, enable]>
ha-priority: <value of integer>
id: <value of integer>
ip: <value of string>
ping-serv-status: <value of integer>
seq: <value of integer>
secip-relay-ip: <value of string>
vlanid: <value of integer>
dhcp-relay-interface-select-method: <value in [auto, sdwan, specify]>
vrrp:
-
accept-mode: <value in [disable, enable]>
adv-interval: <value of integer>
ignore-default-route: <value in [disable, enable]>
preempt: <value in [disable, enable]>
priority: <value of integer>
proxy-arp:
-
id: <value of integer>
ip: <value of string>
start-time: <value of integer>
status: <value in [disable, enable]>
version: <value in [2, 3]>
vrdst: <value of string>
vrdst-priority: <value of integer>
vrgrp: <value of integer>
vrid: <value of integer>
vrip: <value of 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
required: false
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
required: false
type: bool
access_token:
description: The token to access FortiManager without using username and password.
required: false
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
required: false
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
required: false
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.
required: false
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.
required: false
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
required: false
type: str
fsp_vlan_dynamicmapping:
description: the top level parameters set
required: false
suboptions:
_dhcp-status:
choices:
- disable
- enable
description: no description
type: str
_scope:
description: description
elements: dict
suboptions:
name:
description: no description
type: str
vdom:
description: no description
type: str
type: list
dhcp-server:
description: no description
required: false
suboptions:
auto-configuration:
choices:
- disable
- enable
description: Enable/disable auto configuration.
type: str
auto-managed-status:
choices:
- disable
- enable
description: Enable/disable use of this DHCP server once this interface has
been assigned an IP address from FortiIPAM.
type: str
conflicted-ip-timeout:
description: Time in seconds to wait after a conflicted IP address is removed
from the DHCP range before it can be reused.
type: int
ddns-auth:
choices:
- disable
- tsig
description: DDNS authentication mode.
type: str
ddns-key:
description: DDNS update key
type: str
ddns-keyname:
description: DDNS update key name.
type: str
ddns-server-ip:
description: DDNS server IP.
type: str
ddns-ttl:
description: TTL.
type: int
ddns-update:
choices:
- disable
- enable
description: Enable/disable DDNS update for DHCP.
type: str
ddns-update-override:
choices:
- disable
- enable
description: Enable/disable DDNS update override for DHCP.
type: str
ddns-zone:
description: Zone of your domain name
type: str
default-gateway:
description: Default gateway IP address assigned by the DHCP server.
type: str
dhcp-settings-from-fortiipam:
choices:
- disable
- enable
description: Enable/disable populating of DHCP server settings from FortiIPAM.
type: str
dns-server1:
description: DNS server 1.
type: str
dns-server2:
description: DNS server 2.
type: str
dns-server3:
description: DNS server 3.
type: str
dns-server4:
description: DNS server 4.
type: str
dns-service:
choices:
- default
- specify
- local
description: 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: description
elements: dict
suboptions:
end-ip:
description: End of IP range.
type: str
id:
description: ID.
type: int
lease-time:
description: Lease time in seconds, 0 means default lease time.
type: int
start-ip:
description: Start of IP range.
type: str
uci-match:
choices:
- disable
- enable
description: Enable/disable user class identifier
type: str
uci-string:
description: description
type: str
vci-match:
choices:
- disable
- enable
description: Enable/disable vendor class identifier
type: str
vci-string:
description: description
type: str
type: list
filename:
description: Name of the boot file on the TFTP server.
type: str
forticlient-on-net-status:
choices:
- disable
- enable
description: Enable/disable FortiClient-On-Net service for this DHCP server.
type: str
id:
description: ID.
type: int
ip-mode:
choices:
- range
- usrgrp
description: Method used to assign client IP.
type: str
ip-range:
description: description
elements: dict
suboptions:
end-ip:
description: End of IP range.
type: str
id:
description: ID.
type: int
lease-time:
description: Lease time in seconds, 0 means default lease time.
type: int
start-ip:
description: Start of IP range.
type: str
uci-match:
choices:
- disable
- enable
description: Enable/disable user class identifier
type: str
uci-string:
description: description
type: str
vci-match:
choices:
- disable
- enable
description: Enable/disable vendor class identifier
type: str
vci-string:
description: description
type: str
type: list
ipsec-lease-hold:
description: DHCP over IPsec leases expire this many seconds after tunnel
down
type: int
lease-time:
description: Lease time in seconds, 0 means unlimited.
type: int
mac-acl-default-action:
choices:
- assign
- block
description: MAC access control default action
type: str
netmask:
description: Netmask assigned by the DHCP server.
type: str
next-server:
description: IP address of a server
type: str
ntp-server1:
description: NTP server 1.
type: str
ntp-server2:
description: NTP server 2.
type: str
ntp-server3:
description: NTP server 3.
type: str
ntp-service:
choices:
- default
- specify
- local
description: Options for assigning Network Time Protocol
type: str
option1:
description: description
type: str
option2:
description: description
type: str
option3:
description: description
type: str
option4:
description: no description
type: str
option5:
description: no description
type: str
option6:
description: no description
type: str
options:
description: description
elements: dict
suboptions:
code:
description: DHCP option code.
type: int
id:
description: ID.
type: int
ip:
description: description
type: str
type:
choices:
- hex
- string
- ip
- fqdn
description: DHCP option type.
type: str
uci-match:
choices:
- disable
- enable
description: Enable/disable user class identifier
type: str
uci-string:
description: description
type: str
value:
description: DHCP option value.
type: str
vci-match:
choices:
- disable
- enable
description: Enable/disable vendor class identifier
type: str
vci-string:
description: description
type: str
type: list
relay-agent:
description: Relay agent IP.
type: str
reserved-address:
description: description
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: Option 82 circuit-ID of the client that will get the reserved
IP address.
type: str
circuit-id-type:
choices:
- hex
- string
description: 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: Option 82 remote-ID of the client that will get the reserved
IP address.
type: str
remote-id-type:
choices:
- hex
- string
description: DHCP option type.
type: str
type:
choices:
- mac
- option82
description: DHCP reserved-address type.
type: str
type: list
server-type:
choices:
- regular
- ipsec
description: DHCP server can be a normal DHCP server or an IPsec DHCP server.
type: str
shared-subnet:
choices:
- disable
- enable
description: Enable/disable shared subnet.
type: str
status:
choices:
- disable
- enable
description: Enable/disable this DHCP configuration.
type: str
tftp-server:
description: description
type: str
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: Options for the DHCP server to set the clients time zone.
type: str
vci-match:
choices:
- disable
- enable
description: Enable/disable vendor class identifier
type: str
vci-string:
description: description
type: str
wifi-ac-service:
choices:
- specify
- local
description: Options for assigning WiFi Access Controllers to DHCP clients
type: str
wifi-ac1:
description: WiFi Access Controller 1 IP address
type: str
wifi-ac2:
description: WiFi Access Controller 2 IP address
type: str
wifi-ac3:
description: WiFi Access Controller 3 IP address
type: str
wins-server1:
description: WINS server 1.
type: str
wins-server2:
description: WINS server 2.
type: str
type: dict
interface:
description: no description
required: false
suboptions:
dhcp-relay-agent-option:
choices:
- disable
- enable
description: no description
type: str
dhcp-relay-interface-select-method:
choices:
- auto
- sdwan
- specify
description: no description
type: str
dhcp-relay-ip:
description: description
type: str
dhcp-relay-service:
choices:
- disable
- enable
description: no description
type: str
dhcp-relay-type:
choices:
- regular
- ipsec
description: no description
type: str
ip:
description: no description
type: str
ipv6:
description: no description
required: false
suboptions:
autoconf:
choices:
- disable
- enable
description: Enable/disable address auto config.
type: str
cli-conn6-status:
description: no description
type: int
dhcp6-client-options:
choices:
- rapid
- iapd
- iana
- dns
- dnsname
description: description
elements: str
type: list
dhcp6-information-request:
choices:
- disable
- enable
description: Enable/disable DHCPv6 information request.
type: str
dhcp6-prefix-delegation:
choices:
- disable
- enable
description: Enable/disable DHCPv6 prefix delegation.
type: str
dhcp6-prefix-hint:
description: DHCPv6 prefix that will be used as a hint to the upstream
DHCPv6 server.
type: str
dhcp6-prefix-hint-plt:
description: DHCPv6 prefix hint preferred life time
type: int
dhcp6-prefix-hint-vlt:
description: DHCPv6 prefix hint valid life time
type: int
dhcp6-relay-ip:
description: DHCPv6 relay IP address.
type: str
dhcp6-relay-service:
choices:
- disable
- enable
description: Enable/disable DHCPv6 relay.
type: str
dhcp6-relay-source-interface:
choices:
- disable
- enable
description: Enable/disable use of address on this interface as the source
address of the relay message.
type: str
dhcp6-relay-type:
choices:
- regular
description: DHCPv6 relay type.
type: str
icmp6-send-redirect:
choices:
- disable
- enable
description: Enable/disable sending of ICMPv6 redirects.
type: str
interface-identifier:
description: IPv6 interface identifier.
type: str
ip6-address:
description: Primary IPv6 address prefix, syntax
type: str
ip6-allowaccess:
choices:
- https
- ping
- ssh
- snmp
- http
- telnet
- fgfm
- capwap
- fabric
description: description
elements: str
type: list
ip6-default-life:
description: Default life
type: int
ip6-delegated-prefix-iaid:
description: IAID of obtained delegated-prefix from the upstream interface.
type: int
ip6-delegated-prefix-list:
description: description
elements: dict
suboptions:
autonomous-flag:
choices:
- disable
- enable
description: Enable/disable the autonomous flag.
type: str
delegated-prefix-iaid:
description: IAID of obtained delegated-prefix from the upstream interface.
type: int
onlink-flag:
choices:
- disable
- enable
description: Enable/disable the onlink flag.
type: str
prefix-id:
description: Prefix ID.
type: int
rdnss:
description: description
type: str
rdnss-service:
choices:
- delegated
- default
- specify
description: Recursive DNS service option.
type: str
subnet:
description: Add subnet ID to routing prefix.
type: str
upstream-interface:
description: Name of the interface that provides delegated information.
type: str
type: list
ip6-dns-server-override:
choices:
- disable
- enable
description: Enable/disable using the DNS server acquired by DHCP.
type: str
ip6-extra-addr:
description: description
elements: dict
suboptions:
prefix:
description: IPv6 address prefix.
type: str
type: list
ip6-hop-limit:
description: Hop limit
type: int
ip6-link-mtu:
description: IPv6 link MTU.
type: int
ip6-manage-flag:
choices:
- disable
- enable
description: Enable/disable the managed flag.
type: str
ip6-max-interval:
description: IPv6 maximum interval
type: int
ip6-min-interval:
description: IPv6 minimum interval
type: int
ip6-mode:
choices:
- static
- dhcp
- pppoe
- delegated
description: Addressing mode
type: str
ip6-other-flag:
choices:
- disable
- enable
description: Enable/disable the other IPv6 flag.
type: str
ip6-prefix-list:
description: description
elements: dict
suboptions:
autonomous-flag:
choices:
- disable
- enable
description: Enable/disable the autonomous flag.
type: str
dnssl:
description: description
type: str
onlink-flag:
choices:
- disable
- enable
description: Enable/disable the onlink flag.
type: str
preferred-life-time:
description: Preferred life time
type: int
prefix:
description: IPv6 prefix.
type: str
rdnss:
description: description
type: str
valid-life-time:
description: Valid life time
type: int
type: list
ip6-prefix-mode:
choices:
- dhcp6
- ra
description: Assigning a prefix from DHCP or RA.
type: str
ip6-reachable-time:
description: IPv6 reachable time
type: int
ip6-retrans-time:
description: IPv6 retransmit time
type: int
ip6-send-adv:
choices:
- disable
- enable
description: Enable/disable sending advertisements about the interface.
type: str
ip6-subnet:
description: Subnet to routing prefix, syntax
type: str
ip6-upstream-interface:
description: Interface name providing delegated information.
type: str
nd-cert:
description: Neighbor discovery certificate.
type: str
nd-cga-modifier:
description: Neighbor discovery CGA modifier.
type: str
nd-mode:
choices:
- basic
- SEND-compatible
description: Neighbor discovery mode.
type: str
nd-security-level:
description: Neighbor discovery security level
type: int
nd-timestamp-delta:
description: Neighbor discovery timestamp delta value
type: int
nd-timestamp-fuzz:
description: Neighbor discovery timestamp fuzz factor
type: int
ra-send-mtu:
choices:
- disable
- enable
description: Enable/disable sending link MTU in RA packet.
type: str
unique-autoconf-addr:
choices:
- disable
- enable
description: 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: Enable/disable virtual MAC for VRRP.
type: str
vrrp6:
description: description
elements: dict
suboptions:
accept-mode:
choices:
- disable
- enable
description: Enable/disable accept mode.
type: str
adv-interval:
description: Advertisement interval
type: int
preempt:
choices:
- disable
- enable
description: Enable/disable preempt mode.
type: str
priority:
description: Priority of the virtual router
type: int
start-time:
description: 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: no description
type: str
secondaryip:
description: 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: description
elements: str
type: list
detectprotocol:
choices:
- ping
- tcp-echo
- udp-echo
description: 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: 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: no description
type: int
secip-relay-ip:
description: DHCP relay IP address.
type: str
seq:
description: no description
type: int
type: list
vlanid:
description: no description
type: int
vrrp:
description: description
elements: dict
suboptions:
accept-mode:
choices:
- disable
- enable
description: Enable/disable accept mode.
type: str
adv-interval:
description: Advertisement interval
type: int
ignore-default-route:
choices:
- disable
- enable
description: Enable/disable ignoring of default route when checking destination.
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: description
elements: dict
suboptions:
id:
description: ID.
type: int
ip:
description: Set IP addresses of proxy ARP.
type: str
type: list
start-time:
description: 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: description
type: str
vrdst-priority:
description: Priority of the virtual router when the virtual router destination
becomes unreachable
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.
required: false
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