Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse
fortios.system.getInterface
Explore with Pulumi AI
Use this data source to get information on an fortios system interface
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as fortios from "@pulumi/fortios";
const sample1 = fortios.system.getInterface({
name: "port1",
});
export const output1 = sample1.then(sample1 => sample1.ip);
import pulumi
import pulumi_fortios as fortios
sample1 = fortios.system.get_interface(name="port1")
pulumi.export("output1", sample1.ip)
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/system"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
sample1, err := system.LookupInterface(ctx, &system.LookupInterfaceArgs{
Name: "port1",
}, nil)
if err != nil {
return err
}
ctx.Export("output1", sample1.Ip)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumi.Fortios;
return await Deployment.RunAsync(() =>
{
var sample1 = Fortios.System.GetInterface.Invoke(new()
{
Name = "port1",
});
return new Dictionary<string, object?>
{
["output1"] = sample1.Apply(getInterfaceResult => getInterfaceResult.Ip),
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.system.SystemFunctions;
import com.pulumi.fortios.system.inputs.GetInterfaceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var sample1 = SystemFunctions.getInterface(GetInterfaceArgs.builder()
.name("port1")
.build());
ctx.export("output1", sample1.applyValue(getInterfaceResult -> getInterfaceResult.ip()));
}
}
variables:
sample1:
fn::invoke:
Function: fortios:system:getInterface
Arguments:
name: port1
outputs:
output1: ${sample1.ip}
Using getInterface
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getInterface(args: GetInterfaceArgs, opts?: InvokeOptions): Promise<GetInterfaceResult>
function getInterfaceOutput(args: GetInterfaceOutputArgs, opts?: InvokeOptions): Output<GetInterfaceResult>
def get_interface(name: Optional[str] = None,
vdomparam: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetInterfaceResult
def get_interface_output(name: Optional[pulumi.Input[str]] = None,
vdomparam: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetInterfaceResult]
func LookupInterface(ctx *Context, args *LookupInterfaceArgs, opts ...InvokeOption) (*LookupInterfaceResult, error)
func LookupInterfaceOutput(ctx *Context, args *LookupInterfaceOutputArgs, opts ...InvokeOption) LookupInterfaceResultOutput
> Note: This function is named LookupInterface
in the Go SDK.
public static class GetInterface
{
public static Task<GetInterfaceResult> InvokeAsync(GetInterfaceArgs args, InvokeOptions? opts = null)
public static Output<GetInterfaceResult> Invoke(GetInterfaceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetInterfaceResult> getInterface(GetInterfaceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: fortios:system/getInterface:getInterface
arguments:
# arguments dictionary
The following arguments are supported:
- Name string
- Specify the name of the desired system interface.
- Vdomparam string
- Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- Name string
- Specify the name of the desired system interface.
- Vdomparam string
- Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- name String
- Specify the name of the desired system interface.
- vdomparam String
- Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- name string
- Specify the name of the desired system interface.
- vdomparam string
- Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- name str
- Specify the name of the desired system interface.
- vdomparam str
- Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
- name String
- Specify the name of the desired system interface.
- vdomparam String
- Specifies the vdom to which the data source will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
getInterface Result
The following output properties are available:
- Ac
Name string - PPPoE server name.
- Aggregate string
- Aggregate interface.
- Aggregate
Type string - Type of aggregation.
- Algorithm string
- Frame distribution algorithm.
- Alias string
- Alias will be displayed with the interface name to make it easier to distinguish.
- Allowaccess string
- Management access settings for the secondary IP address.
- Ap
Discover string - Enable/disable automatic registration of unknown FortiAP devices.
- Arpforward string
- Enable/disable ARP forwarding.
- Auth
Cert string - HTTPS server certificate.
- Auth
Portal stringAddr - Address of captive portal.
- Auth
Type string - PPP authentication type to use.
- Auto
Auth stringExtension Device - Enable/disable automatic authorization of dedicated Fortinet extension device on this interface.
- Bandwidth
Measure intTime - Bandwidth measure time
- Bfd string
- Bidirectional Forwarding Detection (BFD) settings.
- Bfd
Desired intMin Tx - BFD desired minimal transmit interval.
- Bfd
Detect intMult - BFD detection multiplier.
- Bfd
Required intMin Rx - BFD required minimal receive interval.
- Broadcast
Forticlient stringDiscovery - Enable/disable broadcasting FortiClient discovery messages.
- Broadcast
Forward string - Enable/disable broadcast forwarding.
- Captive
Portal int - Enable/disable captive portal.
- Cli
Conn intStatus - CLI connection status.
- Client
Options List<Pulumiverse.Fortios. System. Outputs. Get Interface Client Option> - DHCP client options. The structure of
client_options
block is documented below. - Color int
- Color of icon on the GUI.
- Data string
- Interface name.
- Dedicated
To string - Configure interface for single purpose.
- Default
Purdue stringLevel - default purdue level of device detected on this interface.
- Defaultgw string
- Enable to get the gateway IP from the DHCP or PPPoE server.
- Description string
- Description.
- Detected
Peer intMtu - MTU of detected peer (0 - 4294967295).
- Detectprotocol string
- Protocols used to detect the server.
- Detectserver string
- Gateway's ping server for this IP.
- Device
Access stringList - Device access list.
- Device
Identification string - Enable/disable passively gathering of device identity information about the devices on the network connected to this interface.
- Device
Identification stringActive Scan - Enable/disable active gathering of device identity information about the devices on the network connected to this interface.
- Device
Netscan string - Enable/disable inclusion of devices detected on this interface in network vulnerability scans.
- Device
User stringIdentification - Enable/disable passive gathering of user identity information about users on this interface.
- Devindex int
- Device Index.
- Dhcp
Broadcast stringFlag - Enable/disable setting of the broadcast flag in messages sent by the DHCP client (default = enable).
- Dhcp
Classless stringRoute Addition - Enable/disable addition of classless static routes retrieved from DHCP server.
- Dhcp
Client stringIdentifier - DHCP client identifier.
- Dhcp
Relay stringAgent Option - Enable/disable DHCP relay agent option.
- Dhcp
Relay stringCircuit Id - DHCP relay circuit ID.
- Dhcp
Relay stringInterface - Specify outgoing interface to reach server.
- Dhcp
Relay stringInterface Select Method - Specify how to select outgoing interface to reach server.
- Dhcp
Relay stringIp - DHCP relay IP address.
- Dhcp
Relay stringLink Selection - DHCP relay link selection.
- Dhcp
Relay stringRequest All Server - Enable/disable sending DHCP request to all servers.
- Dhcp
Relay stringService - Enable/disable allowing this interface to act as a DHCP relay.
- Dhcp
Relay stringSource Ip - IP address used by the DHCP relay as its source IP.
- Dhcp
Relay stringType - DHCP relay type (regular or IPsec).
- Dhcp
Renew intTime - DHCP renew time in seconds (300-604800), 0 means use the renew time provided by the server.
- Dhcp
Smart stringRelay - Enable/disable DHCP smart relay.
- Dhcp
Snooping List<Pulumiverse.Server Lists Fortios. System. Outputs. Get Interface Dhcp Snooping Server List> - Configure DHCP server access list. The structure of
dhcp_snooping_server_list
block is documented below. - Disc
Retry intTimeout - Time in seconds to wait before retrying to start a PPPoE discovery, 0 means no timeout.
- Disconnect
Threshold int - Time in milliseconds to wait before sending a notification that this interface is down or disconnected.
- Distance int
- Distance for routes learned through PPPoE or DHCP, lower distance indicates preferred route.
- Dns
Server stringOverride - Enable/disable use DNS acquired by DHCP or PPPoE.
- Dns
Server stringProtocol - DNS transport protocols.
- Drop
Fragment string - Enable/disable drop fragment packets.
- Drop
Overlapped stringFragment - Enable/disable drop overlapped fragment packets.
- Eap
Ca stringCert - EAP CA certificate name.
- Eap
Identity string - EAP identity.
- Eap
Method string - EAP method.
- Eap
Password string - EAP password.
- Eap
Supplicant string - Enable/disable EAP-Supplicant.
- Eap
User stringCert - EAP user certificate name.
- Egress
Shaping stringProfile - Outgoing traffic shaping profile.
- Endpoint
Compliance string - Enable/disable endpoint compliance enforcement.
- Estimated
Downstream intBandwidth - Estimated maximum downstream bandwidth (kbps). Used to estimate link utilization.
- Estimated
Upstream intBandwidth - Estimated maximum upstream bandwidth (kbps). Used to estimate link utilization.
- Explicit
Ftp stringProxy - Enable/disable the explicit FTP proxy on this interface.
- Explicit
Web stringProxy - Enable/disable the explicit web proxy on this interface.
- External string
- Enable/disable identifying the interface as an external interface (which usually means it's connected to the Internet).
- Fail
Action stringOn Extender - Action on extender when interface fail .
- Fail
Alert List<Pulumiverse.Interfaces Fortios. System. Outputs. Get Interface Fail Alert Interface> - Names of the FortiGate interfaces from which the link failure alert is sent for this interface. The structure of
fail_alert_interfaces
block is documented below. - Fail
Alert stringMethod - Select link-failed-signal or link-down method to alert about a failed link.
- Fail
Detect string - Enable/disable fail detection features for this interface.
- Fail
Detect stringOption - Options for detecting that this interface has failed.
- Fortiheartbeat string
- Enable/disable FortiHeartBeat (FortiTelemetry on GUI).
- Fortilink string
- Enable FortiLink to dedicate this interface to manage other Fortinet devices.
- Fortilink
Backup intLink - fortilink split interface backup link.
- Fortilink
Neighbor stringDetect - Protocol for FortiGate neighbor discovery.
- Fortilink
Split stringInterface - Enable/disable FortiLink split interface to connect member link to different FortiSwitch in stack for uplink redundancy.
- Fortilink
Stacking string - Enable/disable FortiLink switch-stacking on this interface.
- Forward
Domain int - Transparent mode forward domain.
- Forward
Error stringCorrection - Configure forward error correction (FEC).
- Gwdetect string
- Enable/disable detect gateway alive for first.
- Ha
Priority int - HA election priority for the PING server.
- Icmp
Accept stringRedirect - Enable/disable ICMP accept redirect.
- Icmp
Send stringRedirect - Enable/disable ICMP send redirect.
- Id string
- The provider-assigned unique ID for this managed resource.
- Ident
Accept string - Enable/disable authentication for this interface.
- Idle
Timeout int - PPPoE auto disconnect after idle timeout seconds, 0 means no timeout.
- Ike
Saml stringServer - Configure IKE authentication SAML server.
- Inbandwidth int
- Bandwidth limit for incoming traffic (0 - 16776000 kbps), 0 means unlimited.
- Ingress
Shaping stringProfile - Incoming traffic shaping profile.
- Ingress
Spillover intThreshold - Ingress Spillover threshold (0 - 16776000 kbps).
- Internal int
- Implicitly created.
- Ip string
- Secondary IP address of the interface.
- Ip
Managed stringBy Fortiipam - Enable/disable automatic IP address assignment of this interface by FortiIPAM.
- Ipmac string
- Enable/disable IP/MAC binding.
- Ips
Sniffer stringMode - Enable/disable the use of this interface as a one-armed sniffer.
- Ipunnumbered string
- Unnumbered IP used for PPPoE interfaces for which no unique local address is provided.
- Ipv6s
List<Pulumiverse.
Fortios. System. Outputs. Get Interface Ipv6> - IPv6 of interface. The structure of
ipv6
block is documented below. - L2forward string
- Enable/disable l2 forwarding.
- Lacp
Ha stringSecondary - LACP HA secondary member.
- Lacp
Ha stringSlave - LACP HA slave.
- Lacp
Mode string - LACP mode.
- Lacp
Speed string - How often the interface sends LACP messages.
- Lcp
Echo intInterval - Time in seconds between PPPoE Link Control Protocol (LCP) echo requests.
- Lcp
Max intEcho Fails - Maximum missed LCP echo messages before disconnect.
- Link
Up intDelay - Number of milliseconds to wait before considering a link is up.
- Lldp
Network stringPolicy - LLDP-MED network policy profile.
- Lldp
Reception string - Enable/disable Link Layer Discovery Protocol (LLDP) reception.
- Lldp
Transmission string - Enable/disable Link Layer Discovery Protocol (LLDP) transmission.
- Macaddr string
- Change the interface's MAC address.
- Managed
Devices List<Pulumiverse.Fortios. System. Outputs. Get Interface Managed Device> - Available when FortiLink is enabled, used for managed devices through FortiLink interface. The structure of
managed_device
block is documented below. - Managed
Subnetwork stringSize - Number of IP addresses to be allocated by FortiIPAM and used by this FortiGate unit's DHCP server settings.
- Management
Ip string - High Availability in-band management IP address of this interface.
- Measured
Downstream intBandwidth - Measured downstream bandwidth (kbps).
- Measured
Upstream intBandwidth - Measured upstream bandwidth (kbps).
- Mediatype string
- Select SFP media interface type
- Members
List<Pulumiverse.
Fortios. System. Outputs. Get Interface Member> - Physical interfaces that belong to the aggregate or redundant interface. The structure of
member
block is documented below. - Min
Links int - Minimum number of aggregated ports that must be up.
- Min
Links stringDown - Action to take when less than the configured minimum number of links are active.
- Mode string
- Addressing mode (static, DHCP, PPPoE).
- Monitor
Bandwidth string - Enable monitoring bandwidth on this interface.
- Mtu int
- MTU value for this interface.
- Mtu
Override string - Enable to set a custom MTU for this interface.
- Name string
- Tag name.
- Ndiscforward string
- Enable/disable NDISC forwarding.
- Netbios
Forward string - Enable/disable NETBIOS forwarding.
- Netflow
Sampler string - Enable/disable NetFlow on this interface and set the data that NetFlow collects (rx, tx, or both).
- Outbandwidth int
- Bandwidth limit for outgoing traffic (0 - 16776000 kbps).
- Padt
Retry intTimeout - PPPoE Active Discovery Terminate (PADT) used to terminate sessions after an idle time.
- Password string
- PPPoE account's password.
- Ping
Serv intStatus - PING server status.
- Polling
Interval int - sFlow polling interval (1 - 255 sec).
- Pppoe
Unnumbered stringNegotiate - Enable/disable PPPoE unnumbered negotiation.
- Pptp
Auth stringType - PPTP authentication type.
- Pptp
Client string - Enable/disable PPTP client.
- Pptp
Password string - PPTP password.
- Pptp
Server stringIp - PPTP server IP address.
- Pptp
Timeout int - Idle timer in minutes (0 for disabled).
- Pptp
User string - PPTP user name.
- Preserve
Session stringRoute - Enable/disable preservation of session route when dirty.
- Priority int
- Priority of the virtual router (1 - 255).
- Priority
Override string - Enable/disable fail back to higher priority port once recovered.
- Proxy
Captive stringPortal - Enable/disable proxy captive portal on this interface.
- Reachable
Time int - IPv4 reachable time in milliseconds (30000 - 3600000, default = 30000).
- Redundant
Interface string - Redundant interface.
- Remote
Ip string - Remote IP address of tunnel.
- Replacemsg
Override stringGroup - Replacement message override group.
- Ring
Rx int - RX ring size.
- Ring
Tx int - TX ring size.
- Role string
- Interface role.
- Sample
Direction string - Data that NetFlow collects (rx, tx, or both).
- Sample
Rate int - sFlow sample rate (10 - 99999).
- Scan
Botnet stringConnections - Enable monitoring or blocking connections to Botnet servers through this interface.
- Secondary
Ip string - Enable/disable adding a secondary IP to this interface.
- Secondaryips
List<Pulumiverse.
Fortios. System. Outputs. Get Interface Secondaryip> - Second IP address of interface. The structure of
secondaryip
block is documented below. - Security
Exempt stringList - Name of security-exempt-list.
- Security
External stringLogout - URL of external authentication logout server.
- Security
External stringWeb - URL of external authentication web server.
- Security
Groups List<Pulumiverse.Fortios. System. Outputs. Get Interface Security Group> - User groups that can authenticate with the captive portal. The structure of
security_groups
block is documented below. - Security
Mac stringAuth Bypass - Enable/disable MAC authentication bypass.
- Security
Mode string - Turn on captive portal authentication for this interface.
- Security
Redirect stringUrl - URL redirection after disclaimer/authentication.
- Service
Name string - PPPoE service name.
- Sflow
Sampler string - Enable/disable sFlow on this interface.
- Snmp
Index int - Permanent SNMP Index of the interface.
- Speed string
- Interface speed. The default setting and the options available depend on the interface hardware.
- Spillover
Threshold int - Egress Spillover threshold (0 - 16776000 kbps), 0 means unlimited.
- Src
Check string - Enable/disable source IP check.
- Status string
- Enable/disable VRRP.
- Stp string
- Enable/disable STP.
- Stp
Ha stringSecondary - Control STP behaviour on HA secondary.
- Stpforward string
- Enable/disable STP forwarding.
- Stpforward
Mode string - Configure STP forwarding mode.
- Subst string
- Enable to always send packets from this interface to a destination MAC address.
- Substitute
Dst stringMac - Destination MAC address that all packets are sent to from this interface.
- Swc
First intCreate - Initial create for switch-controller VLANs.
- Swc
Vlan int - Creation status for switch-controller VLANs.
- Switch string
- Contained in switch.
- Switch
Controller stringAccess Vlan - Block FortiSwitch port-to-port traffic.
- Switch
Controller stringArp Inspection - Enable/disable FortiSwitch ARP inspection.
- Switch
Controller stringDhcp Snooping - Switch controller DHCP snooping.
- Switch
Controller stringDhcp Snooping Option82 - Switch controller DHCP snooping option82.
- Switch
Controller stringDhcp Snooping Verify Mac - Switch controller DHCP snooping verify MAC.
- Switch
Controller stringDynamic - Integrated FortiLink settings for managed FortiSwitch.
- Switch
Controller stringFeature - Interface's purpose when assigning traffic (read only).
- Switch
Controller stringIgmp Snooping - Switch controller IGMP snooping.
- Switch
Controller stringIgmp Snooping Fast Leave - Switch controller IGMP snooping fast-leave.
- Switch
Controller stringIgmp Snooping Proxy - Switch controller IGMP snooping proxy.
- Switch
Controller stringIot Scanning - Enable/disable managed FortiSwitch IoT scanning.
- Switch
Controller intLearning Limit - Limit the number of dynamic MAC addresses on this VLAN (1 - 128, 0 = no limit, default).
- Switch
Controller intMgmt Vlan - VLAN to use for FortiLink management purposes.
- Switch
Controller stringNac - Integrated NAC settings for managed FortiSwitch.
- Switch
Controller stringNetflow Collect - NetFlow collection and processing.
- Switch
Controller stringOffload - Enable/disable managed FortiSwitch routing offload.
- Switch
Controller stringOffload Gw - Enable/disable managed FortiSwitch routing offload gateway.
- Switch
Controller stringOffload Ip - IP for routing offload on FortiSwitch.
- Switch
Controller stringRspan Mode - Stop Layer2 MAC learning and interception of BPDUs and other packets on this interface.
- Switch
Controller stringSource Ip - Source IP address used in FortiLink over L3 connections.
- Switch
Controller stringTraffic Policy - Switch controller traffic policy for the VLAN.
- System
Id string - Define a system ID for the aggregate interface.
- System
Id stringType - Method in which system ID is generated.
- Taggings
List<Pulumiverse.
Fortios. System. Outputs. Get Interface Tagging> - Config object tagging. The structure of
tagging
block is documented below. - Tcp
Mss int - TCP maximum segment size. 0 means do not change segment size.
- Trunk string
- Enable/disable VLAN trunk.
- Trust
Ip1 string - Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
- Trust
Ip2 string - Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
- Trust
Ip3 string - Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
- Trust
Ip61 string - Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
- Trust
Ip62 string - Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
- Trust
Ip63 string - Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
- Type string
- DHCP client option type.
- Username string
- Username of the PPPoE account, provided by your ISP.
- Vdom string
- Interface is in this virtual domain (VDOM).
- Vindex int
- Switch control interface VLAN ID.
- Vlan
Protocol string - Ethernet protocol of VLAN.
- Vlanforward string
- Enable/disable traffic forwarding between VLANs on this interface.
- Vlanid int
- VLAN ID (1 - 4094).
- Vrf int
- Virtual Routing Forwarding ID.
- Vrrp
Virtual stringMac - Enable/disable use of virtual MAC for VRRP.
- Vrrps
List<Pulumiverse.
Fortios. System. Outputs. Get Interface Vrrp> - VRRP configuration. The structure of
vrrp
block is documented below. - Wccp string
- Enable/disable WCCP on this interface. Used for encapsulated WCCP communication between WCCP clients and servers.
- Weight int
- Default weight for static routes (if route has no weight configured).
- Wins
Ip string - WINS server IP.
- Vdomparam string
- Ac
Name string - PPPoE server name.
- Aggregate string
- Aggregate interface.
- Aggregate
Type string - Type of aggregation.
- Algorithm string
- Frame distribution algorithm.
- Alias string
- Alias will be displayed with the interface name to make it easier to distinguish.
- Allowaccess string
- Management access settings for the secondary IP address.
- Ap
Discover string - Enable/disable automatic registration of unknown FortiAP devices.
- Arpforward string
- Enable/disable ARP forwarding.
- Auth
Cert string - HTTPS server certificate.
- Auth
Portal stringAddr - Address of captive portal.
- Auth
Type string - PPP authentication type to use.
- Auto
Auth stringExtension Device - Enable/disable automatic authorization of dedicated Fortinet extension device on this interface.
- Bandwidth
Measure intTime - Bandwidth measure time
- Bfd string
- Bidirectional Forwarding Detection (BFD) settings.
- Bfd
Desired intMin Tx - BFD desired minimal transmit interval.
- Bfd
Detect intMult - BFD detection multiplier.
- Bfd
Required intMin Rx - BFD required minimal receive interval.
- Broadcast
Forticlient stringDiscovery - Enable/disable broadcasting FortiClient discovery messages.
- Broadcast
Forward string - Enable/disable broadcast forwarding.
- Captive
Portal int - Enable/disable captive portal.
- Cli
Conn intStatus - CLI connection status.
- Client
Options []GetInterface Client Option - DHCP client options. The structure of
client_options
block is documented below. - Color int
- Color of icon on the GUI.
- Dedicated
To string - Configure interface for single purpose.
- Default
Purdue stringLevel - default purdue level of device detected on this interface.
- Defaultgw string
- Enable to get the gateway IP from the DHCP or PPPoE server.
- Description string
- Description.
- Detected
Peer intMtu - MTU of detected peer (0 - 4294967295).
- Detectprotocol string
- Protocols used to detect the server.
- Detectserver string
- Gateway's ping server for this IP.
- Device
Access stringList - Device access list.
- Device
Identification string - Enable/disable passively gathering of device identity information about the devices on the network connected to this interface.
- Device
Identification stringActive Scan - Enable/disable active gathering of device identity information about the devices on the network connected to this interface.
- Device
Netscan string - Enable/disable inclusion of devices detected on this interface in network vulnerability scans.
- Device
User stringIdentification - Enable/disable passive gathering of user identity information about users on this interface.
- Devindex int
- Device Index.
- Dhcp
Broadcast stringFlag - Enable/disable setting of the broadcast flag in messages sent by the DHCP client (default = enable).
- Dhcp
Classless stringRoute Addition - Enable/disable addition of classless static routes retrieved from DHCP server.
- Dhcp
Client stringIdentifier - DHCP client identifier.
- Dhcp
Relay stringAgent Option - Enable/disable DHCP relay agent option.
- Dhcp
Relay stringCircuit Id - DHCP relay circuit ID.
- Dhcp
Relay stringInterface - Specify outgoing interface to reach server.
- Dhcp
Relay stringInterface Select Method - Specify how to select outgoing interface to reach server.
- Dhcp
Relay stringIp - DHCP relay IP address.
- Dhcp
Relay stringLink Selection - DHCP relay link selection.
- Dhcp
Relay stringRequest All Server - Enable/disable sending DHCP request to all servers.
- Dhcp
Relay stringService - Enable/disable allowing this interface to act as a DHCP relay.
- Dhcp
Relay stringSource Ip - IP address used by the DHCP relay as its source IP.
- Dhcp
Relay stringType - DHCP relay type (regular or IPsec).
- Dhcp
Renew intTime - DHCP renew time in seconds (300-604800), 0 means use the renew time provided by the server.
- Dhcp
Smart stringRelay - Enable/disable DHCP smart relay.
- Dhcp
Snooping []GetServer Lists Interface Dhcp Snooping Server List - Configure DHCP server access list. The structure of
dhcp_snooping_server_list
block is documented below. - Disc
Retry intTimeout - Time in seconds to wait before retrying to start a PPPoE discovery, 0 means no timeout.
- Disconnect
Threshold int - Time in milliseconds to wait before sending a notification that this interface is down or disconnected.
- Distance int
- Distance for routes learned through PPPoE or DHCP, lower distance indicates preferred route.
- Dns
Server stringOverride - Enable/disable use DNS acquired by DHCP or PPPoE.
- Dns
Server stringProtocol - DNS transport protocols.
- Drop
Fragment string - Enable/disable drop fragment packets.
- Drop
Overlapped stringFragment - Enable/disable drop overlapped fragment packets.
- Eap
Ca stringCert - EAP CA certificate name.
- Eap
Identity string - EAP identity.
- Eap
Method string - EAP method.
- Eap
Password string - EAP password.
- Eap
Supplicant string - Enable/disable EAP-Supplicant.
- Eap
User stringCert - EAP user certificate name.
- Egress
Shaping stringProfile - Outgoing traffic shaping profile.
- Endpoint
Compliance string - Enable/disable endpoint compliance enforcement.
- Estimated
Downstream intBandwidth - Estimated maximum downstream bandwidth (kbps). Used to estimate link utilization.
- Estimated
Upstream intBandwidth - Estimated maximum upstream bandwidth (kbps). Used to estimate link utilization.
- Explicit
Ftp stringProxy - Enable/disable the explicit FTP proxy on this interface.
- Explicit
Web stringProxy - Enable/disable the explicit web proxy on this interface.
- External string
- Enable/disable identifying the interface as an external interface (which usually means it's connected to the Internet).
- Fail
Action stringOn Extender - Action on extender when interface fail .
- Fail
Alert []GetInterfaces Interface Fail Alert Interface - Names of the FortiGate interfaces from which the link failure alert is sent for this interface. The structure of
fail_alert_interfaces
block is documented below. - Fail
Alert stringMethod - Select link-failed-signal or link-down method to alert about a failed link.
- Fail
Detect string - Enable/disable fail detection features for this interface.
- Fail
Detect stringOption - Options for detecting that this interface has failed.
- Fortiheartbeat string
- Enable/disable FortiHeartBeat (FortiTelemetry on GUI).
- Fortilink string
- Enable FortiLink to dedicate this interface to manage other Fortinet devices.
- Fortilink
Backup intLink - fortilink split interface backup link.
- Fortilink
Neighbor stringDetect - Protocol for FortiGate neighbor discovery.
- Fortilink
Split stringInterface - Enable/disable FortiLink split interface to connect member link to different FortiSwitch in stack for uplink redundancy.
- Fortilink
Stacking string - Enable/disable FortiLink switch-stacking on this interface.
- Forward
Domain int - Transparent mode forward domain.
- Forward
Error stringCorrection - Configure forward error correction (FEC).
- Gwdetect string
- Enable/disable detect gateway alive for first.
- Ha
Priority int - HA election priority for the PING server.
- Icmp
Accept stringRedirect - Enable/disable ICMP accept redirect.
- Icmp
Send stringRedirect - Enable/disable ICMP send redirect.
- Id string
- The provider-assigned unique ID for this managed resource.
- Ident
Accept string - Enable/disable authentication for this interface.
- Idle
Timeout int - PPPoE auto disconnect after idle timeout seconds, 0 means no timeout.
- Ike
Saml stringServer - Configure IKE authentication SAML server.
- Inbandwidth int
- Bandwidth limit for incoming traffic (0 - 16776000 kbps), 0 means unlimited.
- Ingress
Shaping stringProfile - Incoming traffic shaping profile.
- Ingress
Spillover intThreshold - Ingress Spillover threshold (0 - 16776000 kbps).
- Interface string
- Interface name.
- Internal int
- Implicitly created.
- Ip string
- Secondary IP address of the interface.
- Ip
Managed stringBy Fortiipam - Enable/disable automatic IP address assignment of this interface by FortiIPAM.
- Ipmac string
- Enable/disable IP/MAC binding.
- Ips
Sniffer stringMode - Enable/disable the use of this interface as a one-armed sniffer.
- Ipunnumbered string
- Unnumbered IP used for PPPoE interfaces for which no unique local address is provided.
- Ipv6s
[]Get
Interface Ipv6 - IPv6 of interface. The structure of
ipv6
block is documented below. - L2forward string
- Enable/disable l2 forwarding.
- Lacp
Ha stringSecondary - LACP HA secondary member.
- Lacp
Ha stringSlave - LACP HA slave.
- Lacp
Mode string - LACP mode.
- Lacp
Speed string - How often the interface sends LACP messages.
- Lcp
Echo intInterval - Time in seconds between PPPoE Link Control Protocol (LCP) echo requests.
- Lcp
Max intEcho Fails - Maximum missed LCP echo messages before disconnect.
- Link
Up intDelay - Number of milliseconds to wait before considering a link is up.
- Lldp
Network stringPolicy - LLDP-MED network policy profile.
- Lldp
Reception string - Enable/disable Link Layer Discovery Protocol (LLDP) reception.
- Lldp
Transmission string - Enable/disable Link Layer Discovery Protocol (LLDP) transmission.
- Macaddr string
- Change the interface's MAC address.
- Managed
Devices []GetInterface Managed Device - Available when FortiLink is enabled, used for managed devices through FortiLink interface. The structure of
managed_device
block is documented below. - Managed
Subnetwork stringSize - Number of IP addresses to be allocated by FortiIPAM and used by this FortiGate unit's DHCP server settings.
- Management
Ip string - High Availability in-band management IP address of this interface.
- Measured
Downstream intBandwidth - Measured downstream bandwidth (kbps).
- Measured
Upstream intBandwidth - Measured upstream bandwidth (kbps).
- Mediatype string
- Select SFP media interface type
- Members
[]Get
Interface Member - Physical interfaces that belong to the aggregate or redundant interface. The structure of
member
block is documented below. - Min
Links int - Minimum number of aggregated ports that must be up.
- Min
Links stringDown - Action to take when less than the configured minimum number of links are active.
- Mode string
- Addressing mode (static, DHCP, PPPoE).
- Monitor
Bandwidth string - Enable monitoring bandwidth on this interface.
- Mtu int
- MTU value for this interface.
- Mtu
Override string - Enable to set a custom MTU for this interface.
- Name string
- Tag name.
- Ndiscforward string
- Enable/disable NDISC forwarding.
- Netbios
Forward string - Enable/disable NETBIOS forwarding.
- Netflow
Sampler string - Enable/disable NetFlow on this interface and set the data that NetFlow collects (rx, tx, or both).
- Outbandwidth int
- Bandwidth limit for outgoing traffic (0 - 16776000 kbps).
- Padt
Retry intTimeout - PPPoE Active Discovery Terminate (PADT) used to terminate sessions after an idle time.
- Password string
- PPPoE account's password.
- Ping
Serv intStatus - PING server status.
- Polling
Interval int - sFlow polling interval (1 - 255 sec).
- Pppoe
Unnumbered stringNegotiate - Enable/disable PPPoE unnumbered negotiation.
- Pptp
Auth stringType - PPTP authentication type.
- Pptp
Client string - Enable/disable PPTP client.
- Pptp
Password string - PPTP password.
- Pptp
Server stringIp - PPTP server IP address.
- Pptp
Timeout int - Idle timer in minutes (0 for disabled).
- Pptp
User string - PPTP user name.
- Preserve
Session stringRoute - Enable/disable preservation of session route when dirty.
- Priority int
- Priority of the virtual router (1 - 255).
- Priority
Override string - Enable/disable fail back to higher priority port once recovered.
- Proxy
Captive stringPortal - Enable/disable proxy captive portal on this interface.
- Reachable
Time int - IPv4 reachable time in milliseconds (30000 - 3600000, default = 30000).
- Redundant
Interface string - Redundant interface.
- Remote
Ip string - Remote IP address of tunnel.
- Replacemsg
Override stringGroup - Replacement message override group.
- Ring
Rx int - RX ring size.
- Ring
Tx int - TX ring size.
- Role string
- Interface role.
- Sample
Direction string - Data that NetFlow collects (rx, tx, or both).
- Sample
Rate int - sFlow sample rate (10 - 99999).
- Scan
Botnet stringConnections - Enable monitoring or blocking connections to Botnet servers through this interface.
- Secondary
Ip string - Enable/disable adding a secondary IP to this interface.
- Secondaryips
[]Get
Interface Secondaryip - Second IP address of interface. The structure of
secondaryip
block is documented below. - Security
Exempt stringList - Name of security-exempt-list.
- Security
External stringLogout - URL of external authentication logout server.
- Security
External stringWeb - URL of external authentication web server.
- Security
Groups []GetInterface Security Group - User groups that can authenticate with the captive portal. The structure of
security_groups
block is documented below. - Security
Mac stringAuth Bypass - Enable/disable MAC authentication bypass.
- Security
Mode string - Turn on captive portal authentication for this interface.
- Security
Redirect stringUrl - URL redirection after disclaimer/authentication.
- Service
Name string - PPPoE service name.
- Sflow
Sampler string - Enable/disable sFlow on this interface.
- Snmp
Index int - Permanent SNMP Index of the interface.
- Speed string
- Interface speed. The default setting and the options available depend on the interface hardware.
- Spillover
Threshold int - Egress Spillover threshold (0 - 16776000 kbps), 0 means unlimited.
- Src
Check string - Enable/disable source IP check.
- Status string
- Enable/disable VRRP.
- Stp string
- Enable/disable STP.
- Stp
Ha stringSecondary - Control STP behaviour on HA secondary.
- Stpforward string
- Enable/disable STP forwarding.
- Stpforward
Mode string - Configure STP forwarding mode.
- Subst string
- Enable to always send packets from this interface to a destination MAC address.
- Substitute
Dst stringMac - Destination MAC address that all packets are sent to from this interface.
- Swc
First intCreate - Initial create for switch-controller VLANs.
- Swc
Vlan int - Creation status for switch-controller VLANs.
- Switch string
- Contained in switch.
- Switch
Controller stringAccess Vlan - Block FortiSwitch port-to-port traffic.
- Switch
Controller stringArp Inspection - Enable/disable FortiSwitch ARP inspection.
- Switch
Controller stringDhcp Snooping - Switch controller DHCP snooping.
- Switch
Controller stringDhcp Snooping Option82 - Switch controller DHCP snooping option82.
- Switch
Controller stringDhcp Snooping Verify Mac - Switch controller DHCP snooping verify MAC.
- Switch
Controller stringDynamic - Integrated FortiLink settings for managed FortiSwitch.
- Switch
Controller stringFeature - Interface's purpose when assigning traffic (read only).
- Switch
Controller stringIgmp Snooping - Switch controller IGMP snooping.
- Switch
Controller stringIgmp Snooping Fast Leave - Switch controller IGMP snooping fast-leave.
- Switch
Controller stringIgmp Snooping Proxy - Switch controller IGMP snooping proxy.
- Switch
Controller stringIot Scanning - Enable/disable managed FortiSwitch IoT scanning.
- Switch
Controller intLearning Limit - Limit the number of dynamic MAC addresses on this VLAN (1 - 128, 0 = no limit, default).
- Switch
Controller intMgmt Vlan - VLAN to use for FortiLink management purposes.
- Switch
Controller stringNac - Integrated NAC settings for managed FortiSwitch.
- Switch
Controller stringNetflow Collect - NetFlow collection and processing.
- Switch
Controller stringOffload - Enable/disable managed FortiSwitch routing offload.
- Switch
Controller stringOffload Gw - Enable/disable managed FortiSwitch routing offload gateway.
- Switch
Controller stringOffload Ip - IP for routing offload on FortiSwitch.
- Switch
Controller stringRspan Mode - Stop Layer2 MAC learning and interception of BPDUs and other packets on this interface.
- Switch
Controller stringSource Ip - Source IP address used in FortiLink over L3 connections.
- Switch
Controller stringTraffic Policy - Switch controller traffic policy for the VLAN.
- System
Id string - Define a system ID for the aggregate interface.
- System
Id stringType - Method in which system ID is generated.
- Taggings
[]Get
Interface Tagging - Config object tagging. The structure of
tagging
block is documented below. - Tcp
Mss int - TCP maximum segment size. 0 means do not change segment size.
- Trunk string
- Enable/disable VLAN trunk.
- Trust
Ip1 string - Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
- Trust
Ip2 string - Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
- Trust
Ip3 string - Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
- Trust
Ip61 string - Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
- Trust
Ip62 string - Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
- Trust
Ip63 string - Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
- Type string
- DHCP client option type.
- Username string
- Username of the PPPoE account, provided by your ISP.
- Vdom string
- Interface is in this virtual domain (VDOM).
- Vindex int
- Switch control interface VLAN ID.
- Vlan
Protocol string - Ethernet protocol of VLAN.
- Vlanforward string
- Enable/disable traffic forwarding between VLANs on this interface.
- Vlanid int
- VLAN ID (1 - 4094).
- Vrf int
- Virtual Routing Forwarding ID.
- Vrrp
Virtual stringMac - Enable/disable use of virtual MAC for VRRP.
- Vrrps
[]Get
Interface Vrrp - VRRP configuration. The structure of
vrrp
block is documented below. - Wccp string
- Enable/disable WCCP on this interface. Used for encapsulated WCCP communication between WCCP clients and servers.
- Weight int
- Default weight for static routes (if route has no weight configured).
- Wins
Ip string - WINS server IP.
- Vdomparam string
- ac
Name String - PPPoE server name.
- aggregate String
- Aggregate interface.
- aggregate
Type String - Type of aggregation.
- algorithm String
- Frame distribution algorithm.
- alias String
- Alias will be displayed with the interface name to make it easier to distinguish.
- allowaccess String
- Management access settings for the secondary IP address.
- ap
Discover String - Enable/disable automatic registration of unknown FortiAP devices.
- arpforward String
- Enable/disable ARP forwarding.
- auth
Cert String - HTTPS server certificate.
- auth
Portal StringAddr - Address of captive portal.
- auth
Type String - PPP authentication type to use.
- auto
Auth StringExtension Device - Enable/disable automatic authorization of dedicated Fortinet extension device on this interface.
- bandwidth
Measure IntegerTime - Bandwidth measure time
- bfd String
- Bidirectional Forwarding Detection (BFD) settings.
- bfd
Desired IntegerMin Tx - BFD desired minimal transmit interval.
- bfd
Detect IntegerMult - BFD detection multiplier.
- bfd
Required IntegerMin Rx - BFD required minimal receive interval.
- broadcast
Forticlient StringDiscovery - Enable/disable broadcasting FortiClient discovery messages.
- broadcast
Forward String - Enable/disable broadcast forwarding.
- captive
Portal Integer - Enable/disable captive portal.
- cli
Conn IntegerStatus - CLI connection status.
- client
Options List<GetInterface Client Option> - DHCP client options. The structure of
client_options
block is documented below. - color Integer
- Color of icon on the GUI.
- dedicated
To String - Configure interface for single purpose.
- default
Purdue StringLevel - default purdue level of device detected on this interface.
- defaultgw String
- Enable to get the gateway IP from the DHCP or PPPoE server.
- description String
- Description.
- detected
Peer IntegerMtu - MTU of detected peer (0 - 4294967295).
- detectprotocol String
- Protocols used to detect the server.
- detectserver String
- Gateway's ping server for this IP.
- device
Access StringList - Device access list.
- device
Identification String - Enable/disable passively gathering of device identity information about the devices on the network connected to this interface.
- device
Identification StringActive Scan - Enable/disable active gathering of device identity information about the devices on the network connected to this interface.
- device
Netscan String - Enable/disable inclusion of devices detected on this interface in network vulnerability scans.
- device
User StringIdentification - Enable/disable passive gathering of user identity information about users on this interface.
- devindex Integer
- Device Index.
- dhcp
Broadcast StringFlag - Enable/disable setting of the broadcast flag in messages sent by the DHCP client (default = enable).
- dhcp
Classless StringRoute Addition - Enable/disable addition of classless static routes retrieved from DHCP server.
- dhcp
Client StringIdentifier - DHCP client identifier.
- dhcp
Relay StringAgent Option - Enable/disable DHCP relay agent option.
- dhcp
Relay StringCircuit Id - DHCP relay circuit ID.
- dhcp
Relay StringInterface - Specify outgoing interface to reach server.
- dhcp
Relay StringInterface Select Method - Specify how to select outgoing interface to reach server.
- dhcp
Relay StringIp - DHCP relay IP address.
- dhcp
Relay StringLink Selection - DHCP relay link selection.
- dhcp
Relay StringRequest All Server - Enable/disable sending DHCP request to all servers.
- dhcp
Relay StringService - Enable/disable allowing this interface to act as a DHCP relay.
- dhcp
Relay StringSource Ip - IP address used by the DHCP relay as its source IP.
- dhcp
Relay StringType - DHCP relay type (regular or IPsec).
- dhcp
Renew IntegerTime - DHCP renew time in seconds (300-604800), 0 means use the renew time provided by the server.
- dhcp
Smart StringRelay - Enable/disable DHCP smart relay.
- dhcp
Snooping List<GetServer Lists Interface Dhcp Snooping Server List> - Configure DHCP server access list. The structure of
dhcp_snooping_server_list
block is documented below. - disc
Retry IntegerTimeout - Time in seconds to wait before retrying to start a PPPoE discovery, 0 means no timeout.
- disconnect
Threshold Integer - Time in milliseconds to wait before sending a notification that this interface is down or disconnected.
- distance Integer
- Distance for routes learned through PPPoE or DHCP, lower distance indicates preferred route.
- dns
Server StringOverride - Enable/disable use DNS acquired by DHCP or PPPoE.
- dns
Server StringProtocol - DNS transport protocols.
- drop
Fragment String - Enable/disable drop fragment packets.
- drop
Overlapped StringFragment - Enable/disable drop overlapped fragment packets.
- eap
Ca StringCert - EAP CA certificate name.
- eap
Identity String - EAP identity.
- eap
Method String - EAP method.
- eap
Password String - EAP password.
- eap
Supplicant String - Enable/disable EAP-Supplicant.
- eap
User StringCert - EAP user certificate name.
- egress
Shaping StringProfile - Outgoing traffic shaping profile.
- endpoint
Compliance String - Enable/disable endpoint compliance enforcement.
- estimated
Downstream IntegerBandwidth - Estimated maximum downstream bandwidth (kbps). Used to estimate link utilization.
- estimated
Upstream IntegerBandwidth - Estimated maximum upstream bandwidth (kbps). Used to estimate link utilization.
- explicit
Ftp StringProxy - Enable/disable the explicit FTP proxy on this interface.
- explicit
Web StringProxy - Enable/disable the explicit web proxy on this interface.
- external String
- Enable/disable identifying the interface as an external interface (which usually means it's connected to the Internet).
- fail
Action StringOn Extender - Action on extender when interface fail .
- fail
Alert List<GetInterfaces Interface Fail Alert Interface> - Names of the FortiGate interfaces from which the link failure alert is sent for this interface. The structure of
fail_alert_interfaces
block is documented below. - fail
Alert StringMethod - Select link-failed-signal or link-down method to alert about a failed link.
- fail
Detect String - Enable/disable fail detection features for this interface.
- fail
Detect StringOption - Options for detecting that this interface has failed.
- fortiheartbeat String
- Enable/disable FortiHeartBeat (FortiTelemetry on GUI).
- fortilink String
- Enable FortiLink to dedicate this interface to manage other Fortinet devices.
- fortilink
Backup IntegerLink - fortilink split interface backup link.
- fortilink
Neighbor StringDetect - Protocol for FortiGate neighbor discovery.
- fortilink
Split StringInterface - Enable/disable FortiLink split interface to connect member link to different FortiSwitch in stack for uplink redundancy.
- fortilink
Stacking String - Enable/disable FortiLink switch-stacking on this interface.
- forward
Domain Integer - Transparent mode forward domain.
- forward
Error StringCorrection - Configure forward error correction (FEC).
- gwdetect String
- Enable/disable detect gateway alive for first.
- ha
Priority Integer - HA election priority for the PING server.
- icmp
Accept StringRedirect - Enable/disable ICMP accept redirect.
- icmp
Send StringRedirect - Enable/disable ICMP send redirect.
- id String
- The provider-assigned unique ID for this managed resource.
- ident
Accept String - Enable/disable authentication for this interface.
- idle
Timeout Integer - PPPoE auto disconnect after idle timeout seconds, 0 means no timeout.
- ike
Saml StringServer - Configure IKE authentication SAML server.
- inbandwidth Integer
- Bandwidth limit for incoming traffic (0 - 16776000 kbps), 0 means unlimited.
- ingress
Shaping StringProfile - Incoming traffic shaping profile.
- ingress
Spillover IntegerThreshold - Ingress Spillover threshold (0 - 16776000 kbps).
- interface_ String
- Interface name.
- internal Integer
- Implicitly created.
- ip String
- Secondary IP address of the interface.
- ip
Managed StringBy Fortiipam - Enable/disable automatic IP address assignment of this interface by FortiIPAM.
- ipmac String
- Enable/disable IP/MAC binding.
- ips
Sniffer StringMode - Enable/disable the use of this interface as a one-armed sniffer.
- ipunnumbered String
- Unnumbered IP used for PPPoE interfaces for which no unique local address is provided.
- ipv6s
List<Get
Interface Ipv6> - IPv6 of interface. The structure of
ipv6
block is documented below. - l2forward String
- Enable/disable l2 forwarding.
- lacp
Ha StringSecondary - LACP HA secondary member.
- lacp
Ha StringSlave - LACP HA slave.
- lacp
Mode String - LACP mode.
- lacp
Speed String - How often the interface sends LACP messages.
- lcp
Echo IntegerInterval - Time in seconds between PPPoE Link Control Protocol (LCP) echo requests.
- lcp
Max IntegerEcho Fails - Maximum missed LCP echo messages before disconnect.
- link
Up IntegerDelay - Number of milliseconds to wait before considering a link is up.
- lldp
Network StringPolicy - LLDP-MED network policy profile.
- lldp
Reception String - Enable/disable Link Layer Discovery Protocol (LLDP) reception.
- lldp
Transmission String - Enable/disable Link Layer Discovery Protocol (LLDP) transmission.
- macaddr String
- Change the interface's MAC address.
- managed
Devices List<GetInterface Managed Device> - Available when FortiLink is enabled, used for managed devices through FortiLink interface. The structure of
managed_device
block is documented below. - managed
Subnetwork StringSize - Number of IP addresses to be allocated by FortiIPAM and used by this FortiGate unit's DHCP server settings.
- management
Ip String - High Availability in-band management IP address of this interface.
- measured
Downstream IntegerBandwidth - Measured downstream bandwidth (kbps).
- measured
Upstream IntegerBandwidth - Measured upstream bandwidth (kbps).
- mediatype String
- Select SFP media interface type
- members
List<Get
Interface Member> - Physical interfaces that belong to the aggregate or redundant interface. The structure of
member
block is documented below. - min
Links Integer - Minimum number of aggregated ports that must be up.
- min
Links StringDown - Action to take when less than the configured minimum number of links are active.
- mode String
- Addressing mode (static, DHCP, PPPoE).
- monitor
Bandwidth String - Enable monitoring bandwidth on this interface.
- mtu Integer
- MTU value for this interface.
- mtu
Override String - Enable to set a custom MTU for this interface.
- name String
- Tag name.
- ndiscforward String
- Enable/disable NDISC forwarding.
- netbios
Forward String - Enable/disable NETBIOS forwarding.
- netflow
Sampler String - Enable/disable NetFlow on this interface and set the data that NetFlow collects (rx, tx, or both).
- outbandwidth Integer
- Bandwidth limit for outgoing traffic (0 - 16776000 kbps).
- padt
Retry IntegerTimeout - PPPoE Active Discovery Terminate (PADT) used to terminate sessions after an idle time.
- password String
- PPPoE account's password.
- ping
Serv IntegerStatus - PING server status.
- polling
Interval Integer - sFlow polling interval (1 - 255 sec).
- pppoe
Unnumbered StringNegotiate - Enable/disable PPPoE unnumbered negotiation.
- pptp
Auth StringType - PPTP authentication type.
- pptp
Client String - Enable/disable PPTP client.
- pptp
Password String - PPTP password.
- pptp
Server StringIp - PPTP server IP address.
- pptp
Timeout Integer - Idle timer in minutes (0 for disabled).
- pptp
User String - PPTP user name.
- preserve
Session StringRoute - Enable/disable preservation of session route when dirty.
- priority Integer
- Priority of the virtual router (1 - 255).
- priority
Override String - Enable/disable fail back to higher priority port once recovered.
- proxy
Captive StringPortal - Enable/disable proxy captive portal on this interface.
- reachable
Time Integer - IPv4 reachable time in milliseconds (30000 - 3600000, default = 30000).
- redundant
Interface String - Redundant interface.
- remote
Ip String - Remote IP address of tunnel.
- replacemsg
Override StringGroup - Replacement message override group.
- ring
Rx Integer - RX ring size.
- ring
Tx Integer - TX ring size.
- role String
- Interface role.
- sample
Direction String - Data that NetFlow collects (rx, tx, or both).
- sample
Rate Integer - sFlow sample rate (10 - 99999).
- scan
Botnet StringConnections - Enable monitoring or blocking connections to Botnet servers through this interface.
- secondary
Ip String - Enable/disable adding a secondary IP to this interface.
- secondaryips
List<Get
Interface Secondaryip> - Second IP address of interface. The structure of
secondaryip
block is documented below. - security
Exempt StringList - Name of security-exempt-list.
- security
External StringLogout - URL of external authentication logout server.
- security
External StringWeb - URL of external authentication web server.
- security
Groups List<GetInterface Security Group> - User groups that can authenticate with the captive portal. The structure of
security_groups
block is documented below. - security
Mac StringAuth Bypass - Enable/disable MAC authentication bypass.
- security
Mode String - Turn on captive portal authentication for this interface.
- security
Redirect StringUrl - URL redirection after disclaimer/authentication.
- service
Name String - PPPoE service name.
- sflow
Sampler String - Enable/disable sFlow on this interface.
- snmp
Index Integer - Permanent SNMP Index of the interface.
- speed String
- Interface speed. The default setting and the options available depend on the interface hardware.
- spillover
Threshold Integer - Egress Spillover threshold (0 - 16776000 kbps), 0 means unlimited.
- src
Check String - Enable/disable source IP check.
- status String
- Enable/disable VRRP.
- stp String
- Enable/disable STP.
- stp
Ha StringSecondary - Control STP behaviour on HA secondary.
- stpforward String
- Enable/disable STP forwarding.
- stpforward
Mode String - Configure STP forwarding mode.
- subst String
- Enable to always send packets from this interface to a destination MAC address.
- substitute
Dst StringMac - Destination MAC address that all packets are sent to from this interface.
- swc
First IntegerCreate - Initial create for switch-controller VLANs.
- swc
Vlan Integer - Creation status for switch-controller VLANs.
- switch
Controller StringAccess Vlan - Block FortiSwitch port-to-port traffic.
- switch
Controller StringArp Inspection - Enable/disable FortiSwitch ARP inspection.
- switch
Controller StringDhcp Snooping - Switch controller DHCP snooping.
- switch
Controller StringDhcp Snooping Option82 - Switch controller DHCP snooping option82.
- switch
Controller StringDhcp Snooping Verify Mac - Switch controller DHCP snooping verify MAC.
- switch
Controller StringDynamic - Integrated FortiLink settings for managed FortiSwitch.
- switch
Controller StringFeature - Interface's purpose when assigning traffic (read only).
- switch
Controller StringIgmp Snooping - Switch controller IGMP snooping.
- switch
Controller StringIgmp Snooping Fast Leave - Switch controller IGMP snooping fast-leave.
- switch
Controller StringIgmp Snooping Proxy - Switch controller IGMP snooping proxy.
- switch
Controller StringIot Scanning - Enable/disable managed FortiSwitch IoT scanning.
- switch
Controller IntegerLearning Limit - Limit the number of dynamic MAC addresses on this VLAN (1 - 128, 0 = no limit, default).
- switch
Controller IntegerMgmt Vlan - VLAN to use for FortiLink management purposes.
- switch
Controller StringNac - Integrated NAC settings for managed FortiSwitch.
- switch
Controller StringNetflow Collect - NetFlow collection and processing.
- switch
Controller StringOffload - Enable/disable managed FortiSwitch routing offload.
- switch
Controller StringOffload Gw - Enable/disable managed FortiSwitch routing offload gateway.
- switch
Controller StringOffload Ip - IP for routing offload on FortiSwitch.
- switch
Controller StringRspan Mode - Stop Layer2 MAC learning and interception of BPDUs and other packets on this interface.
- switch
Controller StringSource Ip - Source IP address used in FortiLink over L3 connections.
- switch
Controller StringTraffic Policy - Switch controller traffic policy for the VLAN.
- switch_ String
- Contained in switch.
- system
Id String - Define a system ID for the aggregate interface.
- system
Id StringType - Method in which system ID is generated.
- taggings
List<Get
Interface Tagging> - Config object tagging. The structure of
tagging
block is documented below. - tcp
Mss Integer - TCP maximum segment size. 0 means do not change segment size.
- trunk String
- Enable/disable VLAN trunk.
- trust
Ip1 String - Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
- trust
Ip2 String - Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
- trust
Ip3 String - Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
- trust
Ip61 String - Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
- trust
Ip62 String - Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
- trust
Ip63 String - Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
- type String
- DHCP client option type.
- username String
- Username of the PPPoE account, provided by your ISP.
- vdom String
- Interface is in this virtual domain (VDOM).
- vindex Integer
- Switch control interface VLAN ID.
- vlan
Protocol String - Ethernet protocol of VLAN.
- vlanforward String
- Enable/disable traffic forwarding between VLANs on this interface.
- vlanid Integer
- VLAN ID (1 - 4094).
- vrf Integer
- Virtual Routing Forwarding ID.
- vrrp
Virtual StringMac - Enable/disable use of virtual MAC for VRRP.
- vrrps
List<Get
Interface Vrrp> - VRRP configuration. The structure of
vrrp
block is documented below. - wccp String
- Enable/disable WCCP on this interface. Used for encapsulated WCCP communication between WCCP clients and servers.
- weight Integer
- Default weight for static routes (if route has no weight configured).
- wins
Ip String - WINS server IP.
- vdomparam String
- ac
Name string - PPPoE server name.
- aggregate string
- Aggregate interface.
- aggregate
Type string - Type of aggregation.
- algorithm string
- Frame distribution algorithm.
- alias string
- Alias will be displayed with the interface name to make it easier to distinguish.
- allowaccess string
- Management access settings for the secondary IP address.
- ap
Discover string - Enable/disable automatic registration of unknown FortiAP devices.
- arpforward string
- Enable/disable ARP forwarding.
- auth
Cert string - HTTPS server certificate.
- auth
Portal stringAddr - Address of captive portal.
- auth
Type string - PPP authentication type to use.
- auto
Auth stringExtension Device - Enable/disable automatic authorization of dedicated Fortinet extension device on this interface.
- bandwidth
Measure numberTime - Bandwidth measure time
- bfd string
- Bidirectional Forwarding Detection (BFD) settings.
- bfd
Desired numberMin Tx - BFD desired minimal transmit interval.
- bfd
Detect numberMult - BFD detection multiplier.
- bfd
Required numberMin Rx - BFD required minimal receive interval.
- broadcast
Forticlient stringDiscovery - Enable/disable broadcasting FortiClient discovery messages.
- broadcast
Forward string - Enable/disable broadcast forwarding.
- captive
Portal number - Enable/disable captive portal.
- cli
Conn numberStatus - CLI connection status.
- client
Options GetInterface Client Option[] - DHCP client options. The structure of
client_options
block is documented below. - color number
- Color of icon on the GUI.
- dedicated
To string - Configure interface for single purpose.
- default
Purdue stringLevel - default purdue level of device detected on this interface.
- defaultgw string
- Enable to get the gateway IP from the DHCP or PPPoE server.
- description string
- Description.
- detected
Peer numberMtu - MTU of detected peer (0 - 4294967295).
- detectprotocol string
- Protocols used to detect the server.
- detectserver string
- Gateway's ping server for this IP.
- device
Access stringList - Device access list.
- device
Identification string - Enable/disable passively gathering of device identity information about the devices on the network connected to this interface.
- device
Identification stringActive Scan - Enable/disable active gathering of device identity information about the devices on the network connected to this interface.
- device
Netscan string - Enable/disable inclusion of devices detected on this interface in network vulnerability scans.
- device
User stringIdentification - Enable/disable passive gathering of user identity information about users on this interface.
- devindex number
- Device Index.
- dhcp
Broadcast stringFlag - Enable/disable setting of the broadcast flag in messages sent by the DHCP client (default = enable).
- dhcp
Classless stringRoute Addition - Enable/disable addition of classless static routes retrieved from DHCP server.
- dhcp
Client stringIdentifier - DHCP client identifier.
- dhcp
Relay stringAgent Option - Enable/disable DHCP relay agent option.
- dhcp
Relay stringCircuit Id - DHCP relay circuit ID.
- dhcp
Relay stringInterface - Specify outgoing interface to reach server.
- dhcp
Relay stringInterface Select Method - Specify how to select outgoing interface to reach server.
- dhcp
Relay stringIp - DHCP relay IP address.
- dhcp
Relay stringLink Selection - DHCP relay link selection.
- dhcp
Relay stringRequest All Server - Enable/disable sending DHCP request to all servers.
- dhcp
Relay stringService - Enable/disable allowing this interface to act as a DHCP relay.
- dhcp
Relay stringSource Ip - IP address used by the DHCP relay as its source IP.
- dhcp
Relay stringType - DHCP relay type (regular or IPsec).
- dhcp
Renew numberTime - DHCP renew time in seconds (300-604800), 0 means use the renew time provided by the server.
- dhcp
Smart stringRelay - Enable/disable DHCP smart relay.
- dhcp
Snooping GetServer Lists Interface Dhcp Snooping Server List[] - Configure DHCP server access list. The structure of
dhcp_snooping_server_list
block is documented below. - disc
Retry numberTimeout - Time in seconds to wait before retrying to start a PPPoE discovery, 0 means no timeout.
- disconnect
Threshold number - Time in milliseconds to wait before sending a notification that this interface is down or disconnected.
- distance number
- Distance for routes learned through PPPoE or DHCP, lower distance indicates preferred route.
- dns
Server stringOverride - Enable/disable use DNS acquired by DHCP or PPPoE.
- dns
Server stringProtocol - DNS transport protocols.
- drop
Fragment string - Enable/disable drop fragment packets.
- drop
Overlapped stringFragment - Enable/disable drop overlapped fragment packets.
- eap
Ca stringCert - EAP CA certificate name.
- eap
Identity string - EAP identity.
- eap
Method string - EAP method.
- eap
Password string - EAP password.
- eap
Supplicant string - Enable/disable EAP-Supplicant.
- eap
User stringCert - EAP user certificate name.
- egress
Shaping stringProfile - Outgoing traffic shaping profile.
- endpoint
Compliance string - Enable/disable endpoint compliance enforcement.
- estimated
Downstream numberBandwidth - Estimated maximum downstream bandwidth (kbps). Used to estimate link utilization.
- estimated
Upstream numberBandwidth - Estimated maximum upstream bandwidth (kbps). Used to estimate link utilization.
- explicit
Ftp stringProxy - Enable/disable the explicit FTP proxy on this interface.
- explicit
Web stringProxy - Enable/disable the explicit web proxy on this interface.
- external string
- Enable/disable identifying the interface as an external interface (which usually means it's connected to the Internet).
- fail
Action stringOn Extender - Action on extender when interface fail .
- fail
Alert GetInterfaces Interface Fail Alert Interface[] - Names of the FortiGate interfaces from which the link failure alert is sent for this interface. The structure of
fail_alert_interfaces
block is documented below. - fail
Alert stringMethod - Select link-failed-signal or link-down method to alert about a failed link.
- fail
Detect string - Enable/disable fail detection features for this interface.
- fail
Detect stringOption - Options for detecting that this interface has failed.
- fortiheartbeat string
- Enable/disable FortiHeartBeat (FortiTelemetry on GUI).
- fortilink string
- Enable FortiLink to dedicate this interface to manage other Fortinet devices.
- fortilink
Backup numberLink - fortilink split interface backup link.
- fortilink
Neighbor stringDetect - Protocol for FortiGate neighbor discovery.
- fortilink
Split stringInterface - Enable/disable FortiLink split interface to connect member link to different FortiSwitch in stack for uplink redundancy.
- fortilink
Stacking string - Enable/disable FortiLink switch-stacking on this interface.
- forward
Domain number - Transparent mode forward domain.
- forward
Error stringCorrection - Configure forward error correction (FEC).
- gwdetect string
- Enable/disable detect gateway alive for first.
- ha
Priority number - HA election priority for the PING server.
- icmp
Accept stringRedirect - Enable/disable ICMP accept redirect.
- icmp
Send stringRedirect - Enable/disable ICMP send redirect.
- id string
- The provider-assigned unique ID for this managed resource.
- ident
Accept string - Enable/disable authentication for this interface.
- idle
Timeout number - PPPoE auto disconnect after idle timeout seconds, 0 means no timeout.
- ike
Saml stringServer - Configure IKE authentication SAML server.
- inbandwidth number
- Bandwidth limit for incoming traffic (0 - 16776000 kbps), 0 means unlimited.
- ingress
Shaping stringProfile - Incoming traffic shaping profile.
- ingress
Spillover numberThreshold - Ingress Spillover threshold (0 - 16776000 kbps).
- interface string
- Interface name.
- internal number
- Implicitly created.
- ip string
- Secondary IP address of the interface.
- ip
Managed stringBy Fortiipam - Enable/disable automatic IP address assignment of this interface by FortiIPAM.
- ipmac string
- Enable/disable IP/MAC binding.
- ips
Sniffer stringMode - Enable/disable the use of this interface as a one-armed sniffer.
- ipunnumbered string
- Unnumbered IP used for PPPoE interfaces for which no unique local address is provided.
- ipv6s
Get
Interface Ipv6[] - IPv6 of interface. The structure of
ipv6
block is documented below. - l2forward string
- Enable/disable l2 forwarding.
- lacp
Ha stringSecondary - LACP HA secondary member.
- lacp
Ha stringSlave - LACP HA slave.
- lacp
Mode string - LACP mode.
- lacp
Speed string - How often the interface sends LACP messages.
- lcp
Echo numberInterval - Time in seconds between PPPoE Link Control Protocol (LCP) echo requests.
- lcp
Max numberEcho Fails - Maximum missed LCP echo messages before disconnect.
- link
Up numberDelay - Number of milliseconds to wait before considering a link is up.
- lldp
Network stringPolicy - LLDP-MED network policy profile.
- lldp
Reception string - Enable/disable Link Layer Discovery Protocol (LLDP) reception.
- lldp
Transmission string - Enable/disable Link Layer Discovery Protocol (LLDP) transmission.
- macaddr string
- Change the interface's MAC address.
- managed
Devices GetInterface Managed Device[] - Available when FortiLink is enabled, used for managed devices through FortiLink interface. The structure of
managed_device
block is documented below. - managed
Subnetwork stringSize - Number of IP addresses to be allocated by FortiIPAM and used by this FortiGate unit's DHCP server settings.
- management
Ip string - High Availability in-band management IP address of this interface.
- measured
Downstream numberBandwidth - Measured downstream bandwidth (kbps).
- measured
Upstream numberBandwidth - Measured upstream bandwidth (kbps).
- mediatype string
- Select SFP media interface type
- members
Get
Interface Member[] - Physical interfaces that belong to the aggregate or redundant interface. The structure of
member
block is documented below. - min
Links number - Minimum number of aggregated ports that must be up.
- min
Links stringDown - Action to take when less than the configured minimum number of links are active.
- mode string
- Addressing mode (static, DHCP, PPPoE).
- monitor
Bandwidth string - Enable monitoring bandwidth on this interface.
- mtu number
- MTU value for this interface.
- mtu
Override string - Enable to set a custom MTU for this interface.
- name string
- Tag name.
- ndiscforward string
- Enable/disable NDISC forwarding.
- netbios
Forward string - Enable/disable NETBIOS forwarding.
- netflow
Sampler string - Enable/disable NetFlow on this interface and set the data that NetFlow collects (rx, tx, or both).
- outbandwidth number
- Bandwidth limit for outgoing traffic (0 - 16776000 kbps).
- padt
Retry numberTimeout - PPPoE Active Discovery Terminate (PADT) used to terminate sessions after an idle time.
- password string
- PPPoE account's password.
- ping
Serv numberStatus - PING server status.
- polling
Interval number - sFlow polling interval (1 - 255 sec).
- pppoe
Unnumbered stringNegotiate - Enable/disable PPPoE unnumbered negotiation.
- pptp
Auth stringType - PPTP authentication type.
- pptp
Client string - Enable/disable PPTP client.
- pptp
Password string - PPTP password.
- pptp
Server stringIp - PPTP server IP address.
- pptp
Timeout number - Idle timer in minutes (0 for disabled).
- pptp
User string - PPTP user name.
- preserve
Session stringRoute - Enable/disable preservation of session route when dirty.
- priority number
- Priority of the virtual router (1 - 255).
- priority
Override string - Enable/disable fail back to higher priority port once recovered.
- proxy
Captive stringPortal - Enable/disable proxy captive portal on this interface.
- reachable
Time number - IPv4 reachable time in milliseconds (30000 - 3600000, default = 30000).
- redundant
Interface string - Redundant interface.
- remote
Ip string - Remote IP address of tunnel.
- replacemsg
Override stringGroup - Replacement message override group.
- ring
Rx number - RX ring size.
- ring
Tx number - TX ring size.
- role string
- Interface role.
- sample
Direction string - Data that NetFlow collects (rx, tx, or both).
- sample
Rate number - sFlow sample rate (10 - 99999).
- scan
Botnet stringConnections - Enable monitoring or blocking connections to Botnet servers through this interface.
- secondary
Ip string - Enable/disable adding a secondary IP to this interface.
- secondaryips
Get
Interface Secondaryip[] - Second IP address of interface. The structure of
secondaryip
block is documented below. - security
Exempt stringList - Name of security-exempt-list.
- security
External stringLogout - URL of external authentication logout server.
- security
External stringWeb - URL of external authentication web server.
- security
Groups GetInterface Security Group[] - User groups that can authenticate with the captive portal. The structure of
security_groups
block is documented below. - security
Mac stringAuth Bypass - Enable/disable MAC authentication bypass.
- security
Mode string - Turn on captive portal authentication for this interface.
- security
Redirect stringUrl - URL redirection after disclaimer/authentication.
- service
Name string - PPPoE service name.
- sflow
Sampler string - Enable/disable sFlow on this interface.
- snmp
Index number - Permanent SNMP Index of the interface.
- speed string
- Interface speed. The default setting and the options available depend on the interface hardware.
- spillover
Threshold number - Egress Spillover threshold (0 - 16776000 kbps), 0 means unlimited.
- src
Check string - Enable/disable source IP check.
- status string
- Enable/disable VRRP.
- stp string
- Enable/disable STP.
- stp
Ha stringSecondary - Control STP behaviour on HA secondary.
- stpforward string
- Enable/disable STP forwarding.
- stpforward
Mode string - Configure STP forwarding mode.
- subst string
- Enable to always send packets from this interface to a destination MAC address.
- substitute
Dst stringMac - Destination MAC address that all packets are sent to from this interface.
- swc
First numberCreate - Initial create for switch-controller VLANs.
- swc
Vlan number - Creation status for switch-controller VLANs.
- switch string
- Contained in switch.
- switch
Controller stringAccess Vlan - Block FortiSwitch port-to-port traffic.
- switch
Controller stringArp Inspection - Enable/disable FortiSwitch ARP inspection.
- switch
Controller stringDhcp Snooping - Switch controller DHCP snooping.
- switch
Controller stringDhcp Snooping Option82 - Switch controller DHCP snooping option82.
- switch
Controller stringDhcp Snooping Verify Mac - Switch controller DHCP snooping verify MAC.
- switch
Controller stringDynamic - Integrated FortiLink settings for managed FortiSwitch.
- switch
Controller stringFeature - Interface's purpose when assigning traffic (read only).
- switch
Controller stringIgmp Snooping - Switch controller IGMP snooping.
- switch
Controller stringIgmp Snooping Fast Leave - Switch controller IGMP snooping fast-leave.
- switch
Controller stringIgmp Snooping Proxy - Switch controller IGMP snooping proxy.
- switch
Controller stringIot Scanning - Enable/disable managed FortiSwitch IoT scanning.
- switch
Controller numberLearning Limit - Limit the number of dynamic MAC addresses on this VLAN (1 - 128, 0 = no limit, default).
- switch
Controller numberMgmt Vlan - VLAN to use for FortiLink management purposes.
- switch
Controller stringNac - Integrated NAC settings for managed FortiSwitch.
- switch
Controller stringNetflow Collect - NetFlow collection and processing.
- switch
Controller stringOffload - Enable/disable managed FortiSwitch routing offload.
- switch
Controller stringOffload Gw - Enable/disable managed FortiSwitch routing offload gateway.
- switch
Controller stringOffload Ip - IP for routing offload on FortiSwitch.
- switch
Controller stringRspan Mode - Stop Layer2 MAC learning and interception of BPDUs and other packets on this interface.
- switch
Controller stringSource Ip - Source IP address used in FortiLink over L3 connections.
- switch
Controller stringTraffic Policy - Switch controller traffic policy for the VLAN.
- system
Id string - Define a system ID for the aggregate interface.
- system
Id stringType - Method in which system ID is generated.
- taggings
Get
Interface Tagging[] - Config object tagging. The structure of
tagging
block is documented below. - tcp
Mss number - TCP maximum segment size. 0 means do not change segment size.
- trunk string
- Enable/disable VLAN trunk.
- trust
Ip1 string - Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
- trust
Ip2 string - Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
- trust
Ip3 string - Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
- trust
Ip61 string - Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
- trust
Ip62 string - Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
- trust
Ip63 string - Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
- type string
- DHCP client option type.
- username string
- Username of the PPPoE account, provided by your ISP.
- vdom string
- Interface is in this virtual domain (VDOM).
- vindex number
- Switch control interface VLAN ID.
- vlan
Protocol string - Ethernet protocol of VLAN.
- vlanforward string
- Enable/disable traffic forwarding between VLANs on this interface.
- vlanid number
- VLAN ID (1 - 4094).
- vrf number
- Virtual Routing Forwarding ID.
- vrrp
Virtual stringMac - Enable/disable use of virtual MAC for VRRP.
- vrrps
Get
Interface Vrrp[] - VRRP configuration. The structure of
vrrp
block is documented below. - wccp string
- Enable/disable WCCP on this interface. Used for encapsulated WCCP communication between WCCP clients and servers.
- weight number
- Default weight for static routes (if route has no weight configured).
- wins
Ip string - WINS server IP.
- vdomparam string
- ac_
name str - PPPoE server name.
- aggregate str
- Aggregate interface.
- aggregate_
type str - Type of aggregation.
- algorithm str
- Frame distribution algorithm.
- alias str
- Alias will be displayed with the interface name to make it easier to distinguish.
- allowaccess str
- Management access settings for the secondary IP address.
- ap_
discover str - Enable/disable automatic registration of unknown FortiAP devices.
- arpforward str
- Enable/disable ARP forwarding.
- auth_
cert str - HTTPS server certificate.
- auth_
portal_ straddr - Address of captive portal.
- auth_
type str - PPP authentication type to use.
- auto_
auth_ strextension_ device - Enable/disable automatic authorization of dedicated Fortinet extension device on this interface.
- bandwidth_
measure_ inttime - Bandwidth measure time
- bfd str
- Bidirectional Forwarding Detection (BFD) settings.
- bfd_
desired_ intmin_ tx - BFD desired minimal transmit interval.
- bfd_
detect_ intmult - BFD detection multiplier.
- bfd_
required_ intmin_ rx - BFD required minimal receive interval.
- broadcast_
forticlient_ strdiscovery - Enable/disable broadcasting FortiClient discovery messages.
- broadcast_
forward str - Enable/disable broadcast forwarding.
- captive_
portal int - Enable/disable captive portal.
- cli_
conn_ intstatus - CLI connection status.
- client_
options Sequence[GetInterface Client Option] - DHCP client options. The structure of
client_options
block is documented below. - color int
- Color of icon on the GUI.
- dedicated_
to str - Configure interface for single purpose.
- default_
purdue_ strlevel - default purdue level of device detected on this interface.
- defaultgw str
- Enable to get the gateway IP from the DHCP or PPPoE server.
- description str
- Description.
- detected_
peer_ intmtu - MTU of detected peer (0 - 4294967295).
- detectprotocol str
- Protocols used to detect the server.
- detectserver str
- Gateway's ping server for this IP.
- device_
access_ strlist - Device access list.
- device_
identification str - Enable/disable passively gathering of device identity information about the devices on the network connected to this interface.
- device_
identification_ stractive_ scan - Enable/disable active gathering of device identity information about the devices on the network connected to this interface.
- device_
netscan str - Enable/disable inclusion of devices detected on this interface in network vulnerability scans.
- device_
user_ stridentification - Enable/disable passive gathering of user identity information about users on this interface.
- devindex int
- Device Index.
- dhcp_
broadcast_ strflag - Enable/disable setting of the broadcast flag in messages sent by the DHCP client (default = enable).
- dhcp_
classless_ strroute_ addition - Enable/disable addition of classless static routes retrieved from DHCP server.
- dhcp_
client_ stridentifier - DHCP client identifier.
- dhcp_
relay_ stragent_ option - Enable/disable DHCP relay agent option.
- dhcp_
relay_ strcircuit_ id - DHCP relay circuit ID.
- dhcp_
relay_ strinterface - Specify outgoing interface to reach server.
- dhcp_
relay_ strinterface_ select_ method - Specify how to select outgoing interface to reach server.
- dhcp_
relay_ strip - DHCP relay IP address.
- dhcp_
relay_ strlink_ selection - DHCP relay link selection.
- dhcp_
relay_ strrequest_ all_ server - Enable/disable sending DHCP request to all servers.
- dhcp_
relay_ strservice - Enable/disable allowing this interface to act as a DHCP relay.
- dhcp_
relay_ strsource_ ip - IP address used by the DHCP relay as its source IP.
- dhcp_
relay_ strtype - DHCP relay type (regular or IPsec).
- dhcp_
renew_ inttime - DHCP renew time in seconds (300-604800), 0 means use the renew time provided by the server.
- dhcp_
smart_ strrelay - Enable/disable DHCP smart relay.
- dhcp_
snooping_ Sequence[Getserver_ lists Interface Dhcp Snooping Server List] - Configure DHCP server access list. The structure of
dhcp_snooping_server_list
block is documented below. - disc_
retry_ inttimeout - Time in seconds to wait before retrying to start a PPPoE discovery, 0 means no timeout.
- disconnect_
threshold int - Time in milliseconds to wait before sending a notification that this interface is down or disconnected.
- distance int
- Distance for routes learned through PPPoE or DHCP, lower distance indicates preferred route.
- dns_
server_ stroverride - Enable/disable use DNS acquired by DHCP or PPPoE.
- dns_
server_ strprotocol - DNS transport protocols.
- drop_
fragment str - Enable/disable drop fragment packets.
- drop_
overlapped_ strfragment - Enable/disable drop overlapped fragment packets.
- eap_
ca_ strcert - EAP CA certificate name.
- eap_
identity str - EAP identity.
- eap_
method str - EAP method.
- eap_
password str - EAP password.
- eap_
supplicant str - Enable/disable EAP-Supplicant.
- eap_
user_ strcert - EAP user certificate name.
- egress_
shaping_ strprofile - Outgoing traffic shaping profile.
- endpoint_
compliance str - Enable/disable endpoint compliance enforcement.
- estimated_
downstream_ intbandwidth - Estimated maximum downstream bandwidth (kbps). Used to estimate link utilization.
- estimated_
upstream_ intbandwidth - Estimated maximum upstream bandwidth (kbps). Used to estimate link utilization.
- explicit_
ftp_ strproxy - Enable/disable the explicit FTP proxy on this interface.
- explicit_
web_ strproxy - Enable/disable the explicit web proxy on this interface.
- external str
- Enable/disable identifying the interface as an external interface (which usually means it's connected to the Internet).
- fail_
action_ stron_ extender - Action on extender when interface fail .
- fail_
alert_ Sequence[Getinterfaces Interface Fail Alert Interface] - Names of the FortiGate interfaces from which the link failure alert is sent for this interface. The structure of
fail_alert_interfaces
block is documented below. - fail_
alert_ strmethod - Select link-failed-signal or link-down method to alert about a failed link.
- fail_
detect str - Enable/disable fail detection features for this interface.
- fail_
detect_ stroption - Options for detecting that this interface has failed.
- fortiheartbeat str
- Enable/disable FortiHeartBeat (FortiTelemetry on GUI).
- fortilink str
- Enable FortiLink to dedicate this interface to manage other Fortinet devices.
- fortilink_
backup_ intlink - fortilink split interface backup link.
- fortilink_
neighbor_ strdetect - Protocol for FortiGate neighbor discovery.
- fortilink_
split_ strinterface - Enable/disable FortiLink split interface to connect member link to different FortiSwitch in stack for uplink redundancy.
- fortilink_
stacking str - Enable/disable FortiLink switch-stacking on this interface.
- forward_
domain int - Transparent mode forward domain.
- forward_
error_ strcorrection - Configure forward error correction (FEC).
- gwdetect str
- Enable/disable detect gateway alive for first.
- ha_
priority int - HA election priority for the PING server.
- icmp_
accept_ strredirect - Enable/disable ICMP accept redirect.
- icmp_
send_ strredirect - Enable/disable ICMP send redirect.
- id str
- The provider-assigned unique ID for this managed resource.
- ident_
accept str - Enable/disable authentication for this interface.
- idle_
timeout int - PPPoE auto disconnect after idle timeout seconds, 0 means no timeout.
- ike_
saml_ strserver - Configure IKE authentication SAML server.
- inbandwidth int
- Bandwidth limit for incoming traffic (0 - 16776000 kbps), 0 means unlimited.
- ingress_
shaping_ strprofile - Incoming traffic shaping profile.
- ingress_
spillover_ intthreshold - Ingress Spillover threshold (0 - 16776000 kbps).
- interface str
- Interface name.
- internal int
- Implicitly created.
- ip str
- Secondary IP address of the interface.
- ip_
managed_ strby_ fortiipam - Enable/disable automatic IP address assignment of this interface by FortiIPAM.
- ipmac str
- Enable/disable IP/MAC binding.
- ips_
sniffer_ strmode - Enable/disable the use of this interface as a one-armed sniffer.
- ipunnumbered str
- Unnumbered IP used for PPPoE interfaces for which no unique local address is provided.
- ipv6s
Sequence[Get
Interface Ipv6] - IPv6 of interface. The structure of
ipv6
block is documented below. - l2forward str
- Enable/disable l2 forwarding.
- lacp_
ha_ strsecondary - LACP HA secondary member.
- lacp_
ha_ strslave - LACP HA slave.
- lacp_
mode str - LACP mode.
- lacp_
speed str - How often the interface sends LACP messages.
- lcp_
echo_ intinterval - Time in seconds between PPPoE Link Control Protocol (LCP) echo requests.
- lcp_
max_ intecho_ fails - Maximum missed LCP echo messages before disconnect.
- link_
up_ intdelay - Number of milliseconds to wait before considering a link is up.
- lldp_
network_ strpolicy - LLDP-MED network policy profile.
- lldp_
reception str - Enable/disable Link Layer Discovery Protocol (LLDP) reception.
- lldp_
transmission str - Enable/disable Link Layer Discovery Protocol (LLDP) transmission.
- macaddr str
- Change the interface's MAC address.
- managed_
devices Sequence[GetInterface Managed Device] - Available when FortiLink is enabled, used for managed devices through FortiLink interface. The structure of
managed_device
block is documented below. - managed_
subnetwork_ strsize - Number of IP addresses to be allocated by FortiIPAM and used by this FortiGate unit's DHCP server settings.
- management_
ip str - High Availability in-band management IP address of this interface.
- measured_
downstream_ intbandwidth - Measured downstream bandwidth (kbps).
- measured_
upstream_ intbandwidth - Measured upstream bandwidth (kbps).
- mediatype str
- Select SFP media interface type
- members
Sequence[Get
Interface Member] - Physical interfaces that belong to the aggregate or redundant interface. The structure of
member
block is documented below. - min_
links int - Minimum number of aggregated ports that must be up.
- min_
links_ strdown - Action to take when less than the configured minimum number of links are active.
- mode str
- Addressing mode (static, DHCP, PPPoE).
- monitor_
bandwidth str - Enable monitoring bandwidth on this interface.
- mtu int
- MTU value for this interface.
- mtu_
override str - Enable to set a custom MTU for this interface.
- name str
- Tag name.
- ndiscforward str
- Enable/disable NDISC forwarding.
- netbios_
forward str - Enable/disable NETBIOS forwarding.
- netflow_
sampler str - Enable/disable NetFlow on this interface and set the data that NetFlow collects (rx, tx, or both).
- outbandwidth int
- Bandwidth limit for outgoing traffic (0 - 16776000 kbps).
- padt_
retry_ inttimeout - PPPoE Active Discovery Terminate (PADT) used to terminate sessions after an idle time.
- password str
- PPPoE account's password.
- ping_
serv_ intstatus - PING server status.
- polling_
interval int - sFlow polling interval (1 - 255 sec).
- pppoe_
unnumbered_ strnegotiate - Enable/disable PPPoE unnumbered negotiation.
- pptp_
auth_ strtype - PPTP authentication type.
- pptp_
client str - Enable/disable PPTP client.
- pptp_
password str - PPTP password.
- pptp_
server_ strip - PPTP server IP address.
- pptp_
timeout int - Idle timer in minutes (0 for disabled).
- pptp_
user str - PPTP user name.
- preserve_
session_ strroute - Enable/disable preservation of session route when dirty.
- priority int
- Priority of the virtual router (1 - 255).
- priority_
override str - Enable/disable fail back to higher priority port once recovered.
- proxy_
captive_ strportal - Enable/disable proxy captive portal on this interface.
- reachable_
time int - IPv4 reachable time in milliseconds (30000 - 3600000, default = 30000).
- redundant_
interface str - Redundant interface.
- remote_
ip str - Remote IP address of tunnel.
- replacemsg_
override_ strgroup - Replacement message override group.
- ring_
rx int - RX ring size.
- ring_
tx int - TX ring size.
- role str
- Interface role.
- sample_
direction str - Data that NetFlow collects (rx, tx, or both).
- sample_
rate int - sFlow sample rate (10 - 99999).
- scan_
botnet_ strconnections - Enable monitoring or blocking connections to Botnet servers through this interface.
- secondary_
ip str - Enable/disable adding a secondary IP to this interface.
- secondaryips
Sequence[Get
Interface Secondaryip] - Second IP address of interface. The structure of
secondaryip
block is documented below. - security_
exempt_ strlist - Name of security-exempt-list.
- security_
external_ strlogout - URL of external authentication logout server.
- security_
external_ strweb - URL of external authentication web server.
- security_
groups Sequence[GetInterface Security Group] - User groups that can authenticate with the captive portal. The structure of
security_groups
block is documented below. - security_
mac_ strauth_ bypass - Enable/disable MAC authentication bypass.
- security_
mode str - Turn on captive portal authentication for this interface.
- security_
redirect_ strurl - URL redirection after disclaimer/authentication.
- service_
name str - PPPoE service name.
- sflow_
sampler str - Enable/disable sFlow on this interface.
- snmp_
index int - Permanent SNMP Index of the interface.
- speed str
- Interface speed. The default setting and the options available depend on the interface hardware.
- spillover_
threshold int - Egress Spillover threshold (0 - 16776000 kbps), 0 means unlimited.
- src_
check str - Enable/disable source IP check.
- status str
- Enable/disable VRRP.
- stp str
- Enable/disable STP.
- stp_
ha_ strsecondary - Control STP behaviour on HA secondary.
- stpforward str
- Enable/disable STP forwarding.
- stpforward_
mode str - Configure STP forwarding mode.
- subst str
- Enable to always send packets from this interface to a destination MAC address.
- substitute_
dst_ strmac - Destination MAC address that all packets are sent to from this interface.
- swc_
first_ intcreate - Initial create for switch-controller VLANs.
- swc_
vlan int - Creation status for switch-controller VLANs.
- switch str
- Contained in switch.
- switch_
controller_ straccess_ vlan - Block FortiSwitch port-to-port traffic.
- switch_
controller_ strarp_ inspection - Enable/disable FortiSwitch ARP inspection.
- switch_
controller_ strdhcp_ snooping - Switch controller DHCP snooping.
- switch_
controller_ strdhcp_ snooping_ option82 - Switch controller DHCP snooping option82.
- switch_
controller_ strdhcp_ snooping_ verify_ mac - Switch controller DHCP snooping verify MAC.
- switch_
controller_ strdynamic - Integrated FortiLink settings for managed FortiSwitch.
- switch_
controller_ strfeature - Interface's purpose when assigning traffic (read only).
- switch_
controller_ strigmp_ snooping - Switch controller IGMP snooping.
- switch_
controller_ strigmp_ snooping_ fast_ leave - Switch controller IGMP snooping fast-leave.
- switch_
controller_ strigmp_ snooping_ proxy - Switch controller IGMP snooping proxy.
- switch_
controller_ striot_ scanning - Enable/disable managed FortiSwitch IoT scanning.
- switch_
controller_ intlearning_ limit - Limit the number of dynamic MAC addresses on this VLAN (1 - 128, 0 = no limit, default).
- switch_
controller_ intmgmt_ vlan - VLAN to use for FortiLink management purposes.
- switch_
controller_ strnac - Integrated NAC settings for managed FortiSwitch.
- switch_
controller_ strnetflow_ collect - NetFlow collection and processing.
- switch_
controller_ stroffload - Enable/disable managed FortiSwitch routing offload.
- switch_
controller_ stroffload_ gw - Enable/disable managed FortiSwitch routing offload gateway.
- switch_
controller_ stroffload_ ip - IP for routing offload on FortiSwitch.
- switch_
controller_ strrspan_ mode - Stop Layer2 MAC learning and interception of BPDUs and other packets on this interface.
- switch_
controller_ strsource_ ip - Source IP address used in FortiLink over L3 connections.
- switch_
controller_ strtraffic_ policy - Switch controller traffic policy for the VLAN.
- system_
id str - Define a system ID for the aggregate interface.
- system_
id_ strtype - Method in which system ID is generated.
- taggings
Sequence[Get
Interface Tagging] - Config object tagging. The structure of
tagging
block is documented below. - tcp_
mss int - TCP maximum segment size. 0 means do not change segment size.
- trunk str
- Enable/disable VLAN trunk.
- trust_
ip1 str - Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
- trust_
ip2 str - Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
- trust_
ip3 str - Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
- trust_
ip61 str - Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
- trust_
ip62 str - Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
- trust_
ip63 str - Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
- type str
- DHCP client option type.
- username str
- Username of the PPPoE account, provided by your ISP.
- vdom str
- Interface is in this virtual domain (VDOM).
- vindex int
- Switch control interface VLAN ID.
- vlan_
protocol str - Ethernet protocol of VLAN.
- vlanforward str
- Enable/disable traffic forwarding between VLANs on this interface.
- vlanid int
- VLAN ID (1 - 4094).
- vrf int
- Virtual Routing Forwarding ID.
- vrrp_
virtual_ strmac - Enable/disable use of virtual MAC for VRRP.
- vrrps
Sequence[Get
Interface Vrrp] - VRRP configuration. The structure of
vrrp
block is documented below. - wccp str
- Enable/disable WCCP on this interface. Used for encapsulated WCCP communication between WCCP clients and servers.
- weight int
- Default weight for static routes (if route has no weight configured).
- wins_
ip str - WINS server IP.
- vdomparam str
- ac
Name String - PPPoE server name.
- aggregate String
- Aggregate interface.
- aggregate
Type String - Type of aggregation.
- algorithm String
- Frame distribution algorithm.
- alias String
- Alias will be displayed with the interface name to make it easier to distinguish.
- allowaccess String
- Management access settings for the secondary IP address.
- ap
Discover String - Enable/disable automatic registration of unknown FortiAP devices.
- arpforward String
- Enable/disable ARP forwarding.
- auth
Cert String - HTTPS server certificate.
- auth
Portal StringAddr - Address of captive portal.
- auth
Type String - PPP authentication type to use.
- auto
Auth StringExtension Device - Enable/disable automatic authorization of dedicated Fortinet extension device on this interface.
- bandwidth
Measure NumberTime - Bandwidth measure time
- bfd String
- Bidirectional Forwarding Detection (BFD) settings.
- bfd
Desired NumberMin Tx - BFD desired minimal transmit interval.
- bfd
Detect NumberMult - BFD detection multiplier.
- bfd
Required NumberMin Rx - BFD required minimal receive interval.
- broadcast
Forticlient StringDiscovery - Enable/disable broadcasting FortiClient discovery messages.
- broadcast
Forward String - Enable/disable broadcast forwarding.
- captive
Portal Number - Enable/disable captive portal.
- cli
Conn NumberStatus - CLI connection status.
- client
Options List<Property Map> - DHCP client options. The structure of
client_options
block is documented below. - color Number
- Color of icon on the GUI.
- dedicated
To String - Configure interface for single purpose.
- default
Purdue StringLevel - default purdue level of device detected on this interface.
- defaultgw String
- Enable to get the gateway IP from the DHCP or PPPoE server.
- description String
- Description.
- detected
Peer NumberMtu - MTU of detected peer (0 - 4294967295).
- detectprotocol String
- Protocols used to detect the server.
- detectserver String
- Gateway's ping server for this IP.
- device
Access StringList - Device access list.
- device
Identification String - Enable/disable passively gathering of device identity information about the devices on the network connected to this interface.
- device
Identification StringActive Scan - Enable/disable active gathering of device identity information about the devices on the network connected to this interface.
- device
Netscan String - Enable/disable inclusion of devices detected on this interface in network vulnerability scans.
- device
User StringIdentification - Enable/disable passive gathering of user identity information about users on this interface.
- devindex Number
- Device Index.
- dhcp
Broadcast StringFlag - Enable/disable setting of the broadcast flag in messages sent by the DHCP client (default = enable).
- dhcp
Classless StringRoute Addition - Enable/disable addition of classless static routes retrieved from DHCP server.
- dhcp
Client StringIdentifier - DHCP client identifier.
- dhcp
Relay StringAgent Option - Enable/disable DHCP relay agent option.
- dhcp
Relay StringCircuit Id - DHCP relay circuit ID.
- dhcp
Relay StringInterface - Specify outgoing interface to reach server.
- dhcp
Relay StringInterface Select Method - Specify how to select outgoing interface to reach server.
- dhcp
Relay StringIp - DHCP relay IP address.
- dhcp
Relay StringLink Selection - DHCP relay link selection.
- dhcp
Relay StringRequest All Server - Enable/disable sending DHCP request to all servers.
- dhcp
Relay StringService - Enable/disable allowing this interface to act as a DHCP relay.
- dhcp
Relay StringSource Ip - IP address used by the DHCP relay as its source IP.
- dhcp
Relay StringType - DHCP relay type (regular or IPsec).
- dhcp
Renew NumberTime - DHCP renew time in seconds (300-604800), 0 means use the renew time provided by the server.
- dhcp
Smart StringRelay - Enable/disable DHCP smart relay.
- dhcp
Snooping List<Property Map>Server Lists - Configure DHCP server access list. The structure of
dhcp_snooping_server_list
block is documented below. - disc
Retry NumberTimeout - Time in seconds to wait before retrying to start a PPPoE discovery, 0 means no timeout.
- disconnect
Threshold Number - Time in milliseconds to wait before sending a notification that this interface is down or disconnected.
- distance Number
- Distance for routes learned through PPPoE or DHCP, lower distance indicates preferred route.
- dns
Server StringOverride - Enable/disable use DNS acquired by DHCP or PPPoE.
- dns
Server StringProtocol - DNS transport protocols.
- drop
Fragment String - Enable/disable drop fragment packets.
- drop
Overlapped StringFragment - Enable/disable drop overlapped fragment packets.
- eap
Ca StringCert - EAP CA certificate name.
- eap
Identity String - EAP identity.
- eap
Method String - EAP method.
- eap
Password String - EAP password.
- eap
Supplicant String - Enable/disable EAP-Supplicant.
- eap
User StringCert - EAP user certificate name.
- egress
Shaping StringProfile - Outgoing traffic shaping profile.
- endpoint
Compliance String - Enable/disable endpoint compliance enforcement.
- estimated
Downstream NumberBandwidth - Estimated maximum downstream bandwidth (kbps). Used to estimate link utilization.
- estimated
Upstream NumberBandwidth - Estimated maximum upstream bandwidth (kbps). Used to estimate link utilization.
- explicit
Ftp StringProxy - Enable/disable the explicit FTP proxy on this interface.
- explicit
Web StringProxy - Enable/disable the explicit web proxy on this interface.
- external String
- Enable/disable identifying the interface as an external interface (which usually means it's connected to the Internet).
- fail
Action StringOn Extender - Action on extender when interface fail .
- fail
Alert List<Property Map>Interfaces - Names of the FortiGate interfaces from which the link failure alert is sent for this interface. The structure of
fail_alert_interfaces
block is documented below. - fail
Alert StringMethod - Select link-failed-signal or link-down method to alert about a failed link.
- fail
Detect String - Enable/disable fail detection features for this interface.
- fail
Detect StringOption - Options for detecting that this interface has failed.
- fortiheartbeat String
- Enable/disable FortiHeartBeat (FortiTelemetry on GUI).
- fortilink String
- Enable FortiLink to dedicate this interface to manage other Fortinet devices.
- fortilink
Backup NumberLink - fortilink split interface backup link.
- fortilink
Neighbor StringDetect - Protocol for FortiGate neighbor discovery.
- fortilink
Split StringInterface - Enable/disable FortiLink split interface to connect member link to different FortiSwitch in stack for uplink redundancy.
- fortilink
Stacking String - Enable/disable FortiLink switch-stacking on this interface.
- forward
Domain Number - Transparent mode forward domain.
- forward
Error StringCorrection - Configure forward error correction (FEC).
- gwdetect String
- Enable/disable detect gateway alive for first.
- ha
Priority Number - HA election priority for the PING server.
- icmp
Accept StringRedirect - Enable/disable ICMP accept redirect.
- icmp
Send StringRedirect - Enable/disable ICMP send redirect.
- id String
- The provider-assigned unique ID for this managed resource.
- ident
Accept String - Enable/disable authentication for this interface.
- idle
Timeout Number - PPPoE auto disconnect after idle timeout seconds, 0 means no timeout.
- ike
Saml StringServer - Configure IKE authentication SAML server.
- inbandwidth Number
- Bandwidth limit for incoming traffic (0 - 16776000 kbps), 0 means unlimited.
- ingress
Shaping StringProfile - Incoming traffic shaping profile.
- ingress
Spillover NumberThreshold - Ingress Spillover threshold (0 - 16776000 kbps).
- interface String
- Interface name.
- internal Number
- Implicitly created.
- ip String
- Secondary IP address of the interface.
- ip
Managed StringBy Fortiipam - Enable/disable automatic IP address assignment of this interface by FortiIPAM.
- ipmac String
- Enable/disable IP/MAC binding.
- ips
Sniffer StringMode - Enable/disable the use of this interface as a one-armed sniffer.
- ipunnumbered String
- Unnumbered IP used for PPPoE interfaces for which no unique local address is provided.
- ipv6s List<Property Map>
- IPv6 of interface. The structure of
ipv6
block is documented below. - l2forward String
- Enable/disable l2 forwarding.
- lacp
Ha StringSecondary - LACP HA secondary member.
- lacp
Ha StringSlave - LACP HA slave.
- lacp
Mode String - LACP mode.
- lacp
Speed String - How often the interface sends LACP messages.
- lcp
Echo NumberInterval - Time in seconds between PPPoE Link Control Protocol (LCP) echo requests.
- lcp
Max NumberEcho Fails - Maximum missed LCP echo messages before disconnect.
- link
Up NumberDelay - Number of milliseconds to wait before considering a link is up.
- lldp
Network StringPolicy - LLDP-MED network policy profile.
- lldp
Reception String - Enable/disable Link Layer Discovery Protocol (LLDP) reception.
- lldp
Transmission String - Enable/disable Link Layer Discovery Protocol (LLDP) transmission.
- macaddr String
- Change the interface's MAC address.
- managed
Devices List<Property Map> - Available when FortiLink is enabled, used for managed devices through FortiLink interface. The structure of
managed_device
block is documented below. - managed
Subnetwork StringSize - Number of IP addresses to be allocated by FortiIPAM and used by this FortiGate unit's DHCP server settings.
- management
Ip String - High Availability in-band management IP address of this interface.
- measured
Downstream NumberBandwidth - Measured downstream bandwidth (kbps).
- measured
Upstream NumberBandwidth - Measured upstream bandwidth (kbps).
- mediatype String
- Select SFP media interface type
- members List<Property Map>
- Physical interfaces that belong to the aggregate or redundant interface. The structure of
member
block is documented below. - min
Links Number - Minimum number of aggregated ports that must be up.
- min
Links StringDown - Action to take when less than the configured minimum number of links are active.
- mode String
- Addressing mode (static, DHCP, PPPoE).
- monitor
Bandwidth String - Enable monitoring bandwidth on this interface.
- mtu Number
- MTU value for this interface.
- mtu
Override String - Enable to set a custom MTU for this interface.
- name String
- Tag name.
- ndiscforward String
- Enable/disable NDISC forwarding.
- netbios
Forward String - Enable/disable NETBIOS forwarding.
- netflow
Sampler String - Enable/disable NetFlow on this interface and set the data that NetFlow collects (rx, tx, or both).
- outbandwidth Number
- Bandwidth limit for outgoing traffic (0 - 16776000 kbps).
- padt
Retry NumberTimeout - PPPoE Active Discovery Terminate (PADT) used to terminate sessions after an idle time.
- password String
- PPPoE account's password.
- ping
Serv NumberStatus - PING server status.
- polling
Interval Number - sFlow polling interval (1 - 255 sec).
- pppoe
Unnumbered StringNegotiate - Enable/disable PPPoE unnumbered negotiation.
- pptp
Auth StringType - PPTP authentication type.
- pptp
Client String - Enable/disable PPTP client.
- pptp
Password String - PPTP password.
- pptp
Server StringIp - PPTP server IP address.
- pptp
Timeout Number - Idle timer in minutes (0 for disabled).
- pptp
User String - PPTP user name.
- preserve
Session StringRoute - Enable/disable preservation of session route when dirty.
- priority Number
- Priority of the virtual router (1 - 255).
- priority
Override String - Enable/disable fail back to higher priority port once recovered.
- proxy
Captive StringPortal - Enable/disable proxy captive portal on this interface.
- reachable
Time Number - IPv4 reachable time in milliseconds (30000 - 3600000, default = 30000).
- redundant
Interface String - Redundant interface.
- remote
Ip String - Remote IP address of tunnel.
- replacemsg
Override StringGroup - Replacement message override group.
- ring
Rx Number - RX ring size.
- ring
Tx Number - TX ring size.
- role String
- Interface role.
- sample
Direction String - Data that NetFlow collects (rx, tx, or both).
- sample
Rate Number - sFlow sample rate (10 - 99999).
- scan
Botnet StringConnections - Enable monitoring or blocking connections to Botnet servers through this interface.
- secondary
Ip String - Enable/disable adding a secondary IP to this interface.
- secondaryips List<Property Map>
- Second IP address of interface. The structure of
secondaryip
block is documented below. - security
Exempt StringList - Name of security-exempt-list.
- security
External StringLogout - URL of external authentication logout server.
- security
External StringWeb - URL of external authentication web server.
- security
Groups List<Property Map> - User groups that can authenticate with the captive portal. The structure of
security_groups
block is documented below. - security
Mac StringAuth Bypass - Enable/disable MAC authentication bypass.
- security
Mode String - Turn on captive portal authentication for this interface.
- security
Redirect StringUrl - URL redirection after disclaimer/authentication.
- service
Name String - PPPoE service name.
- sflow
Sampler String - Enable/disable sFlow on this interface.
- snmp
Index Number - Permanent SNMP Index of the interface.
- speed String
- Interface speed. The default setting and the options available depend on the interface hardware.
- spillover
Threshold Number - Egress Spillover threshold (0 - 16776000 kbps), 0 means unlimited.
- src
Check String - Enable/disable source IP check.
- status String
- Enable/disable VRRP.
- stp String
- Enable/disable STP.
- stp
Ha StringSecondary - Control STP behaviour on HA secondary.
- stpforward String
- Enable/disable STP forwarding.
- stpforward
Mode String - Configure STP forwarding mode.
- subst String
- Enable to always send packets from this interface to a destination MAC address.
- substitute
Dst StringMac - Destination MAC address that all packets are sent to from this interface.
- swc
First NumberCreate - Initial create for switch-controller VLANs.
- swc
Vlan Number - Creation status for switch-controller VLANs.
- switch String
- Contained in switch.
- switch
Controller StringAccess Vlan - Block FortiSwitch port-to-port traffic.
- switch
Controller StringArp Inspection - Enable/disable FortiSwitch ARP inspection.
- switch
Controller StringDhcp Snooping - Switch controller DHCP snooping.
- switch
Controller StringDhcp Snooping Option82 - Switch controller DHCP snooping option82.
- switch
Controller StringDhcp Snooping Verify Mac - Switch controller DHCP snooping verify MAC.
- switch
Controller StringDynamic - Integrated FortiLink settings for managed FortiSwitch.
- switch
Controller StringFeature - Interface's purpose when assigning traffic (read only).
- switch
Controller StringIgmp Snooping - Switch controller IGMP snooping.
- switch
Controller StringIgmp Snooping Fast Leave - Switch controller IGMP snooping fast-leave.
- switch
Controller StringIgmp Snooping Proxy - Switch controller IGMP snooping proxy.
- switch
Controller StringIot Scanning - Enable/disable managed FortiSwitch IoT scanning.
- switch
Controller NumberLearning Limit - Limit the number of dynamic MAC addresses on this VLAN (1 - 128, 0 = no limit, default).
- switch
Controller NumberMgmt Vlan - VLAN to use for FortiLink management purposes.
- switch
Controller StringNac - Integrated NAC settings for managed FortiSwitch.
- switch
Controller StringNetflow Collect - NetFlow collection and processing.
- switch
Controller StringOffload - Enable/disable managed FortiSwitch routing offload.
- switch
Controller StringOffload Gw - Enable/disable managed FortiSwitch routing offload gateway.
- switch
Controller StringOffload Ip - IP for routing offload on FortiSwitch.
- switch
Controller StringRspan Mode - Stop Layer2 MAC learning and interception of BPDUs and other packets on this interface.
- switch
Controller StringSource Ip - Source IP address used in FortiLink over L3 connections.
- switch
Controller StringTraffic Policy - Switch controller traffic policy for the VLAN.
- system
Id String - Define a system ID for the aggregate interface.
- system
Id StringType - Method in which system ID is generated.
- taggings List<Property Map>
- Config object tagging. The structure of
tagging
block is documented below. - tcp
Mss Number - TCP maximum segment size. 0 means do not change segment size.
- trunk String
- Enable/disable VLAN trunk.
- trust
Ip1 String - Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
- trust
Ip2 String - Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
- trust
Ip3 String - Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
- trust
Ip61 String - Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
- trust
Ip62 String - Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
- trust
Ip63 String - Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
- type String
- DHCP client option type.
- username String
- Username of the PPPoE account, provided by your ISP.
- vdom String
- Interface is in this virtual domain (VDOM).
- vindex Number
- Switch control interface VLAN ID.
- vlan
Protocol String - Ethernet protocol of VLAN.
- vlanforward String
- Enable/disable traffic forwarding between VLANs on this interface.
- vlanid Number
- VLAN ID (1 - 4094).
- vrf Number
- Virtual Routing Forwarding ID.
- vrrp
Virtual StringMac - Enable/disable use of virtual MAC for VRRP.
- vrrps List<Property Map>
- VRRP configuration. The structure of
vrrp
block is documented below. - wccp String
- Enable/disable WCCP on this interface. Used for encapsulated WCCP communication between WCCP clients and servers.
- weight Number
- Default weight for static routes (if route has no weight configured).
- wins
Ip String - WINS server IP.
- vdomparam String
Supporting Types
GetInterfaceClientOption
GetInterfaceDhcpSnoopingServerList
GetInterfaceFailAlertInterface
- Name string
- Specify the name of the desired system interface.
- Name string
- Specify the name of the desired system interface.
- name String
- Specify the name of the desired system interface.
- name string
- Specify the name of the desired system interface.
- name str
- Specify the name of the desired system interface.
- name String
- Specify the name of the desired system interface.
GetInterfaceIpv6
- Autoconf string
- Enable/disable address auto config.
- Cli
Conn6Status int - CLI IPv6 connection status.
- Dhcp6Client
Options string - DHCPv6 client options.
- Dhcp6Iapd
Lists List<Pulumiverse.Fortios. System. Inputs. Get Interface Ipv6Dhcp6Iapd List> - DHCPv6 IA-PD list The structure of
dhcp6_iapd_list
block is documented below. - Dhcp6Information
Request string - Enable/disable DHCPv6 information request.
- Dhcp6Prefix
Delegation string - Enable/disable DHCPv6 prefix delegation.
- Dhcp6Prefix
Hint string - DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server.
- Dhcp6Prefix
Hint intPlt - DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time.
- Dhcp6Prefix
Hint intVlt - DHCPv6 prefix hint valid life time (sec).
- Dhcp6Relay
Interface stringId - DHCP6 relay interface ID.
- Dhcp6Relay
Ip string - DHCPv6 relay IP address.
- Dhcp6Relay
Service string - Enable/disable DHCPv6 relay.
- Dhcp6Relay
Source stringInterface - Enable/disable use of address on this interface as the source address of the relay message.
- Dhcp6Relay
Source stringIp - IPv6 address used by the DHCP6 relay as its source IP.
- Dhcp6Relay
Type string - DHCPv6 relay type.
- Icmp6Send
Redirect string - Enable/disable sending of ICMPv6 redirects.
- Interface
Identifier string - IPv6 interface identifier.
- Ip6Address string
- Primary IPv6 address prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx
- Ip6Allowaccess string
- Allow management access to the interface.
- Ip6Default
Life int - Default life (sec).
- Ip6Delegated
Prefix intIaid - IAID of obtained delegated-prefix from the upstream interface.
- Ip6Delegated
Prefix List<Pulumiverse.Lists Fortios. System. Inputs. Get Interface Ipv6Ip6Delegated Prefix List> - Advertised IPv6 delegated prefix list. The structure of
ip6_delegated_prefix_list
block is documented below. - Ip6Dns
Server stringOverride - Enable/disable using the DNS server acquired by DHCP.
- Ip6Extra
Addrs List<Pulumiverse.Fortios. System. Inputs. Get Interface Ipv6Ip6Extra Addr> - Extra IPv6 address prefixes of interface. The structure of
ip6_extra_addr
block is documented below. - Ip6Hop
Limit int - Hop limit (0 means unspecified).
- Ip6Link
Mtu int - IPv6 link MTU.
- Ip6Manage
Flag string - Enable/disable the managed flag.
- Ip6Max
Interval int - IPv6 maximum interval (4 to 1800 sec).
- Ip6Min
Interval int - IPv6 minimum interval (3 to 1350 sec).
- Ip6Mode string
- Addressing mode (static, DHCP, delegated).
- Ip6Other
Flag string - Enable/disable the other IPv6 flag.
- Ip6Prefix
Lists List<Pulumiverse.Fortios. System. Inputs. Get Interface Ipv6Ip6Prefix List> - Advertised prefix list. The structure of
ip6_prefix_list
block is documented below. - Ip6Prefix
Mode string - Assigning a prefix from DHCP or RA.
- Ip6Reachable
Time int - IPv6 reachable time (milliseconds; 0 means unspecified).
- Ip6Retrans
Time int - IPv6 retransmit time (milliseconds; 0 means unspecified).
- Ip6Send
Adv string - Enable/disable sending advertisements about the interface.
- Ip6Subnet string
- Subnet to routing prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx
- Ip6Upstream
Interface string - Interface name providing delegated information.
- Nd
Cert string - Neighbor discovery certificate.
- Nd
Cga stringModifier - Neighbor discovery CGA modifier.
- Nd
Mode string - Neighbor discovery mode.
- Nd
Security intLevel - Neighbor discovery security level (0 - 7; 0 = least secure, default = 0).
- Nd
Timestamp intDelta - Neighbor discovery timestamp delta value (1 - 3600 sec; default = 300).
- Nd
Timestamp intFuzz - Neighbor discovery timestamp fuzz factor (1 - 60 sec; default = 1).
- Ra
Send stringMtu - Enable/disable sending link MTU in RA packet.
- Unique
Autoconf stringAddr - Enable/disable unique auto config address.
- Vrip6Link
Local string - Link-local IPv6 address of virtual router.
- Vrrp6s
List<Pulumiverse.
Fortios. System. Inputs. Get Interface Ipv6Vrrp6> - IPv6 VRRP configuration. The structure of
vrrp6
block is documented below. - Vrrp
Virtual stringMac6 - Enable/disable virtual MAC for VRRP.
- Autoconf string
- Enable/disable address auto config.
- Cli
Conn6Status int - CLI IPv6 connection status.
- Dhcp6Client
Options string - DHCPv6 client options.
- Dhcp6Iapd
Lists []GetInterface Ipv6Dhcp6Iapd List - DHCPv6 IA-PD list The structure of
dhcp6_iapd_list
block is documented below. - Dhcp6Information
Request string - Enable/disable DHCPv6 information request.
- Dhcp6Prefix
Delegation string - Enable/disable DHCPv6 prefix delegation.
- Dhcp6Prefix
Hint string - DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server.
- Dhcp6Prefix
Hint intPlt - DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time.
- Dhcp6Prefix
Hint intVlt - DHCPv6 prefix hint valid life time (sec).
- Dhcp6Relay
Interface stringId - DHCP6 relay interface ID.
- Dhcp6Relay
Ip string - DHCPv6 relay IP address.
- Dhcp6Relay
Service string - Enable/disable DHCPv6 relay.
- Dhcp6Relay
Source stringInterface - Enable/disable use of address on this interface as the source address of the relay message.
- Dhcp6Relay
Source stringIp - IPv6 address used by the DHCP6 relay as its source IP.
- Dhcp6Relay
Type string - DHCPv6 relay type.
- Icmp6Send
Redirect string - Enable/disable sending of ICMPv6 redirects.
- Interface
Identifier string - IPv6 interface identifier.
- Ip6Address string
- Primary IPv6 address prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx
- Ip6Allowaccess string
- Allow management access to the interface.
- Ip6Default
Life int - Default life (sec).
- Ip6Delegated
Prefix intIaid - IAID of obtained delegated-prefix from the upstream interface.
- Ip6Delegated
Prefix []GetLists Interface Ipv6Ip6Delegated Prefix List - Advertised IPv6 delegated prefix list. The structure of
ip6_delegated_prefix_list
block is documented below. - Ip6Dns
Server stringOverride - Enable/disable using the DNS server acquired by DHCP.
- Ip6Extra
Addrs []GetInterface Ipv6Ip6Extra Addr - Extra IPv6 address prefixes of interface. The structure of
ip6_extra_addr
block is documented below. - Ip6Hop
Limit int - Hop limit (0 means unspecified).
- Ip6Link
Mtu int - IPv6 link MTU.
- Ip6Manage
Flag string - Enable/disable the managed flag.
- Ip6Max
Interval int - IPv6 maximum interval (4 to 1800 sec).
- Ip6Min
Interval int - IPv6 minimum interval (3 to 1350 sec).
- Ip6Mode string
- Addressing mode (static, DHCP, delegated).
- Ip6Other
Flag string - Enable/disable the other IPv6 flag.
- Ip6Prefix
Lists []GetInterface Ipv6Ip6Prefix List - Advertised prefix list. The structure of
ip6_prefix_list
block is documented below. - Ip6Prefix
Mode string - Assigning a prefix from DHCP or RA.
- Ip6Reachable
Time int - IPv6 reachable time (milliseconds; 0 means unspecified).
- Ip6Retrans
Time int - IPv6 retransmit time (milliseconds; 0 means unspecified).
- Ip6Send
Adv string - Enable/disable sending advertisements about the interface.
- Ip6Subnet string
- Subnet to routing prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx
- Ip6Upstream
Interface string - Interface name providing delegated information.
- Nd
Cert string - Neighbor discovery certificate.
- Nd
Cga stringModifier - Neighbor discovery CGA modifier.
- Nd
Mode string - Neighbor discovery mode.
- Nd
Security intLevel - Neighbor discovery security level (0 - 7; 0 = least secure, default = 0).
- Nd
Timestamp intDelta - Neighbor discovery timestamp delta value (1 - 3600 sec; default = 300).
- Nd
Timestamp intFuzz - Neighbor discovery timestamp fuzz factor (1 - 60 sec; default = 1).
- Ra
Send stringMtu - Enable/disable sending link MTU in RA packet.
- Unique
Autoconf stringAddr - Enable/disable unique auto config address.
- Vrip6Link
Local string - Link-local IPv6 address of virtual router.
- Vrrp6s
[]Get
Interface Ipv6Vrrp6 - IPv6 VRRP configuration. The structure of
vrrp6
block is documented below. - Vrrp
Virtual stringMac6 - Enable/disable virtual MAC for VRRP.
- autoconf String
- Enable/disable address auto config.
- cli
Conn6Status Integer - CLI IPv6 connection status.
- dhcp6Client
Options String - DHCPv6 client options.
- dhcp6Iapd
Lists List<GetInterface Ipv6Dhcp6Iapd List> - DHCPv6 IA-PD list The structure of
dhcp6_iapd_list
block is documented below. - dhcp6Information
Request String - Enable/disable DHCPv6 information request.
- dhcp6Prefix
Delegation String - Enable/disable DHCPv6 prefix delegation.
- dhcp6Prefix
Hint String - DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server.
- dhcp6Prefix
Hint IntegerPlt - DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time.
- dhcp6Prefix
Hint IntegerVlt - DHCPv6 prefix hint valid life time (sec).
- dhcp6Relay
Interface StringId - DHCP6 relay interface ID.
- dhcp6Relay
Ip String - DHCPv6 relay IP address.
- dhcp6Relay
Service String - Enable/disable DHCPv6 relay.
- dhcp6Relay
Source StringInterface - Enable/disable use of address on this interface as the source address of the relay message.
- dhcp6Relay
Source StringIp - IPv6 address used by the DHCP6 relay as its source IP.
- dhcp6Relay
Type String - DHCPv6 relay type.
- icmp6Send
Redirect String - Enable/disable sending of ICMPv6 redirects.
- interface
Identifier String - IPv6 interface identifier.
- ip6Address String
- Primary IPv6 address prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx
- ip6Allowaccess String
- Allow management access to the interface.
- ip6Default
Life Integer - Default life (sec).
- ip6Delegated
Prefix IntegerIaid - IAID of obtained delegated-prefix from the upstream interface.
- ip6Delegated
Prefix List<GetLists Interface Ipv6Ip6Delegated Prefix List> - Advertised IPv6 delegated prefix list. The structure of
ip6_delegated_prefix_list
block is documented below. - ip6Dns
Server StringOverride - Enable/disable using the DNS server acquired by DHCP.
- ip6Extra
Addrs List<GetInterface Ipv6Ip6Extra Addr> - Extra IPv6 address prefixes of interface. The structure of
ip6_extra_addr
block is documented below. - ip6Hop
Limit Integer - Hop limit (0 means unspecified).
- ip6Link
Mtu Integer - IPv6 link MTU.
- ip6Manage
Flag String - Enable/disable the managed flag.
- ip6Max
Interval Integer - IPv6 maximum interval (4 to 1800 sec).
- ip6Min
Interval Integer - IPv6 minimum interval (3 to 1350 sec).
- ip6Mode String
- Addressing mode (static, DHCP, delegated).
- ip6Other
Flag String - Enable/disable the other IPv6 flag.
- ip6Prefix
Lists List<GetInterface Ipv6Ip6Prefix List> - Advertised prefix list. The structure of
ip6_prefix_list
block is documented below. - ip6Prefix
Mode String - Assigning a prefix from DHCP or RA.
- ip6Reachable
Time Integer - IPv6 reachable time (milliseconds; 0 means unspecified).
- ip6Retrans
Time Integer - IPv6 retransmit time (milliseconds; 0 means unspecified).
- ip6Send
Adv String - Enable/disable sending advertisements about the interface.
- ip6Subnet String
- Subnet to routing prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx
- ip6Upstream
Interface String - Interface name providing delegated information.
- nd
Cert String - Neighbor discovery certificate.
- nd
Cga StringModifier - Neighbor discovery CGA modifier.
- nd
Mode String - Neighbor discovery mode.
- nd
Security IntegerLevel - Neighbor discovery security level (0 - 7; 0 = least secure, default = 0).
- nd
Timestamp IntegerDelta - Neighbor discovery timestamp delta value (1 - 3600 sec; default = 300).
- nd
Timestamp IntegerFuzz - Neighbor discovery timestamp fuzz factor (1 - 60 sec; default = 1).
- ra
Send StringMtu - Enable/disable sending link MTU in RA packet.
- unique
Autoconf StringAddr - Enable/disable unique auto config address.
- vrip6Link
Local String - Link-local IPv6 address of virtual router.
- vrrp6s
List<Get
Interface Ipv6Vrrp6> - IPv6 VRRP configuration. The structure of
vrrp6
block is documented below. - vrrp
Virtual StringMac6 - Enable/disable virtual MAC for VRRP.
- autoconf string
- Enable/disable address auto config.
- cli
Conn6Status number - CLI IPv6 connection status.
- dhcp6Client
Options string - DHCPv6 client options.
- dhcp6Iapd
Lists GetInterface Ipv6Dhcp6Iapd List[] - DHCPv6 IA-PD list The structure of
dhcp6_iapd_list
block is documented below. - dhcp6Information
Request string - Enable/disable DHCPv6 information request.
- dhcp6Prefix
Delegation string - Enable/disable DHCPv6 prefix delegation.
- dhcp6Prefix
Hint string - DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server.
- dhcp6Prefix
Hint numberPlt - DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time.
- dhcp6Prefix
Hint numberVlt - DHCPv6 prefix hint valid life time (sec).
- dhcp6Relay
Interface stringId - DHCP6 relay interface ID.
- dhcp6Relay
Ip string - DHCPv6 relay IP address.
- dhcp6Relay
Service string - Enable/disable DHCPv6 relay.
- dhcp6Relay
Source stringInterface - Enable/disable use of address on this interface as the source address of the relay message.
- dhcp6Relay
Source stringIp - IPv6 address used by the DHCP6 relay as its source IP.
- dhcp6Relay
Type string - DHCPv6 relay type.
- icmp6Send
Redirect string - Enable/disable sending of ICMPv6 redirects.
- interface
Identifier string - IPv6 interface identifier.
- ip6Address string
- Primary IPv6 address prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx
- ip6Allowaccess string
- Allow management access to the interface.
- ip6Default
Life number - Default life (sec).
- ip6Delegated
Prefix numberIaid - IAID of obtained delegated-prefix from the upstream interface.
- ip6Delegated
Prefix GetLists Interface Ipv6Ip6Delegated Prefix List[] - Advertised IPv6 delegated prefix list. The structure of
ip6_delegated_prefix_list
block is documented below. - ip6Dns
Server stringOverride - Enable/disable using the DNS server acquired by DHCP.
- ip6Extra
Addrs GetInterface Ipv6Ip6Extra Addr[] - Extra IPv6 address prefixes of interface. The structure of
ip6_extra_addr
block is documented below. - ip6Hop
Limit number - Hop limit (0 means unspecified).
- ip6Link
Mtu number - IPv6 link MTU.
- ip6Manage
Flag string - Enable/disable the managed flag.
- ip6Max
Interval number - IPv6 maximum interval (4 to 1800 sec).
- ip6Min
Interval number - IPv6 minimum interval (3 to 1350 sec).
- ip6Mode string
- Addressing mode (static, DHCP, delegated).
- ip6Other
Flag string - Enable/disable the other IPv6 flag.
- ip6Prefix
Lists GetInterface Ipv6Ip6Prefix List[] - Advertised prefix list. The structure of
ip6_prefix_list
block is documented below. - ip6Prefix
Mode string - Assigning a prefix from DHCP or RA.
- ip6Reachable
Time number - IPv6 reachable time (milliseconds; 0 means unspecified).
- ip6Retrans
Time number - IPv6 retransmit time (milliseconds; 0 means unspecified).
- ip6Send
Adv string - Enable/disable sending advertisements about the interface.
- ip6Subnet string
- Subnet to routing prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx
- ip6Upstream
Interface string - Interface name providing delegated information.
- nd
Cert string - Neighbor discovery certificate.
- nd
Cga stringModifier - Neighbor discovery CGA modifier.
- nd
Mode string - Neighbor discovery mode.
- nd
Security numberLevel - Neighbor discovery security level (0 - 7; 0 = least secure, default = 0).
- nd
Timestamp numberDelta - Neighbor discovery timestamp delta value (1 - 3600 sec; default = 300).
- nd
Timestamp numberFuzz - Neighbor discovery timestamp fuzz factor (1 - 60 sec; default = 1).
- ra
Send stringMtu - Enable/disable sending link MTU in RA packet.
- unique
Autoconf stringAddr - Enable/disable unique auto config address.
- vrip6Link
Local string - Link-local IPv6 address of virtual router.
- vrrp6s
Get
Interface Ipv6Vrrp6[] - IPv6 VRRP configuration. The structure of
vrrp6
block is documented below. - vrrp
Virtual stringMac6 - Enable/disable virtual MAC for VRRP.
- autoconf str
- Enable/disable address auto config.
- cli_
conn6_ intstatus - CLI IPv6 connection status.
- dhcp6_
client_ stroptions - DHCPv6 client options.
- dhcp6_
iapd_ Sequence[Getlists Interface Ipv6Dhcp6Iapd List] - DHCPv6 IA-PD list The structure of
dhcp6_iapd_list
block is documented below. - dhcp6_
information_ strrequest - Enable/disable DHCPv6 information request.
- dhcp6_
prefix_ strdelegation - Enable/disable DHCPv6 prefix delegation.
- dhcp6_
prefix_ strhint - DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server.
- dhcp6_
prefix_ inthint_ plt - DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time.
- dhcp6_
prefix_ inthint_ vlt - DHCPv6 prefix hint valid life time (sec).
- dhcp6_
relay_ strinterface_ id - DHCP6 relay interface ID.
- dhcp6_
relay_ strip - DHCPv6 relay IP address.
- dhcp6_
relay_ strservice - Enable/disable DHCPv6 relay.
- dhcp6_
relay_ strsource_ interface - Enable/disable use of address on this interface as the source address of the relay message.
- dhcp6_
relay_ strsource_ ip - IPv6 address used by the DHCP6 relay as its source IP.
- dhcp6_
relay_ strtype - DHCPv6 relay type.
- icmp6_
send_ strredirect - Enable/disable sending of ICMPv6 redirects.
- interface_
identifier str - IPv6 interface identifier.
- ip6_
address str - Primary IPv6 address prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx
- ip6_
allowaccess str - Allow management access to the interface.
- ip6_
default_ intlife - Default life (sec).
- ip6_
delegated_ intprefix_ iaid - IAID of obtained delegated-prefix from the upstream interface.
- ip6_
delegated_ Sequence[Getprefix_ lists Interface Ipv6Ip6Delegated Prefix List] - Advertised IPv6 delegated prefix list. The structure of
ip6_delegated_prefix_list
block is documented below. - ip6_
dns_ strserver_ override - Enable/disable using the DNS server acquired by DHCP.
- ip6_
extra_ Sequence[Getaddrs Interface Ipv6Ip6Extra Addr] - Extra IPv6 address prefixes of interface. The structure of
ip6_extra_addr
block is documented below. - ip6_
hop_ intlimit - Hop limit (0 means unspecified).
- ip6_
link_ intmtu - IPv6 link MTU.
- ip6_
manage_ strflag - Enable/disable the managed flag.
- ip6_
max_ intinterval - IPv6 maximum interval (4 to 1800 sec).
- ip6_
min_ intinterval - IPv6 minimum interval (3 to 1350 sec).
- ip6_
mode str - Addressing mode (static, DHCP, delegated).
- ip6_
other_ strflag - Enable/disable the other IPv6 flag.
- ip6_
prefix_ Sequence[Getlists Interface Ipv6Ip6Prefix List] - Advertised prefix list. The structure of
ip6_prefix_list
block is documented below. - ip6_
prefix_ strmode - Assigning a prefix from DHCP or RA.
- ip6_
reachable_ inttime - IPv6 reachable time (milliseconds; 0 means unspecified).
- ip6_
retrans_ inttime - IPv6 retransmit time (milliseconds; 0 means unspecified).
- ip6_
send_ stradv - Enable/disable sending advertisements about the interface.
- ip6_
subnet str - Subnet to routing prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx
- ip6_
upstream_ strinterface - Interface name providing delegated information.
- nd_
cert str - Neighbor discovery certificate.
- nd_
cga_ strmodifier - Neighbor discovery CGA modifier.
- nd_
mode str - Neighbor discovery mode.
- nd_
security_ intlevel - Neighbor discovery security level (0 - 7; 0 = least secure, default = 0).
- nd_
timestamp_ intdelta - Neighbor discovery timestamp delta value (1 - 3600 sec; default = 300).
- nd_
timestamp_ intfuzz - Neighbor discovery timestamp fuzz factor (1 - 60 sec; default = 1).
- ra_
send_ strmtu - Enable/disable sending link MTU in RA packet.
- unique_
autoconf_ straddr - Enable/disable unique auto config address.
- vrip6_
link_ strlocal - Link-local IPv6 address of virtual router.
- vrrp6s
Sequence[Get
Interface Ipv6Vrrp6] - IPv6 VRRP configuration. The structure of
vrrp6
block is documented below. - vrrp_
virtual_ strmac6 - Enable/disable virtual MAC for VRRP.
- autoconf String
- Enable/disable address auto config.
- cli
Conn6Status Number - CLI IPv6 connection status.
- dhcp6Client
Options String - DHCPv6 client options.
- dhcp6Iapd
Lists List<Property Map> - DHCPv6 IA-PD list The structure of
dhcp6_iapd_list
block is documented below. - dhcp6Information
Request String - Enable/disable DHCPv6 information request.
- dhcp6Prefix
Delegation String - Enable/disable DHCPv6 prefix delegation.
- dhcp6Prefix
Hint String - DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server.
- dhcp6Prefix
Hint NumberPlt - DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time.
- dhcp6Prefix
Hint NumberVlt - DHCPv6 prefix hint valid life time (sec).
- dhcp6Relay
Interface StringId - DHCP6 relay interface ID.
- dhcp6Relay
Ip String - DHCPv6 relay IP address.
- dhcp6Relay
Service String - Enable/disable DHCPv6 relay.
- dhcp6Relay
Source StringInterface - Enable/disable use of address on this interface as the source address of the relay message.
- dhcp6Relay
Source StringIp - IPv6 address used by the DHCP6 relay as its source IP.
- dhcp6Relay
Type String - DHCPv6 relay type.
- icmp6Send
Redirect String - Enable/disable sending of ICMPv6 redirects.
- interface
Identifier String - IPv6 interface identifier.
- ip6Address String
- Primary IPv6 address prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx
- ip6Allowaccess String
- Allow management access to the interface.
- ip6Default
Life Number - Default life (sec).
- ip6Delegated
Prefix NumberIaid - IAID of obtained delegated-prefix from the upstream interface.
- ip6Delegated
Prefix List<Property Map>Lists - Advertised IPv6 delegated prefix list. The structure of
ip6_delegated_prefix_list
block is documented below. - ip6Dns
Server StringOverride - Enable/disable using the DNS server acquired by DHCP.
- ip6Extra
Addrs List<Property Map> - Extra IPv6 address prefixes of interface. The structure of
ip6_extra_addr
block is documented below. - ip6Hop
Limit Number - Hop limit (0 means unspecified).
- ip6Link
Mtu Number - IPv6 link MTU.
- ip6Manage
Flag String - Enable/disable the managed flag.
- ip6Max
Interval Number - IPv6 maximum interval (4 to 1800 sec).
- ip6Min
Interval Number - IPv6 minimum interval (3 to 1350 sec).
- ip6Mode String
- Addressing mode (static, DHCP, delegated).
- ip6Other
Flag String - Enable/disable the other IPv6 flag.
- ip6Prefix
Lists List<Property Map> - Advertised prefix list. The structure of
ip6_prefix_list
block is documented below. - ip6Prefix
Mode String - Assigning a prefix from DHCP or RA.
- ip6Reachable
Time Number - IPv6 reachable time (milliseconds; 0 means unspecified).
- ip6Retrans
Time Number - IPv6 retransmit time (milliseconds; 0 means unspecified).
- ip6Send
Adv String - Enable/disable sending advertisements about the interface.
- ip6Subnet String
- Subnet to routing prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx
- ip6Upstream
Interface String - Interface name providing delegated information.
- nd
Cert String - Neighbor discovery certificate.
- nd
Cga StringModifier - Neighbor discovery CGA modifier.
- nd
Mode String - Neighbor discovery mode.
- nd
Security NumberLevel - Neighbor discovery security level (0 - 7; 0 = least secure, default = 0).
- nd
Timestamp NumberDelta - Neighbor discovery timestamp delta value (1 - 3600 sec; default = 300).
- nd
Timestamp NumberFuzz - Neighbor discovery timestamp fuzz factor (1 - 60 sec; default = 1).
- ra
Send StringMtu - Enable/disable sending link MTU in RA packet.
- unique
Autoconf StringAddr - Enable/disable unique auto config address.
- vrip6Link
Local String - Link-local IPv6 address of virtual router.
- vrrp6s List<Property Map>
- IPv6 VRRP configuration. The structure of
vrrp6
block is documented below. - vrrp
Virtual StringMac6 - Enable/disable virtual MAC for VRRP.
GetInterfaceIpv6Dhcp6IapdList
- Iaid int
- Identity association identifier.
- Prefix
Hint string - DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server.
- Prefix
Hint intPlt - DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time.
- Prefix
Hint intVlt - DHCPv6 prefix hint valid life time (sec).
- Iaid int
- Identity association identifier.
- Prefix
Hint string - DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server.
- Prefix
Hint intPlt - DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time.
- Prefix
Hint intVlt - DHCPv6 prefix hint valid life time (sec).
- iaid Integer
- Identity association identifier.
- prefix
Hint String - DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server.
- prefix
Hint IntegerPlt - DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time.
- prefix
Hint IntegerVlt - DHCPv6 prefix hint valid life time (sec).
- iaid number
- Identity association identifier.
- prefix
Hint string - DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server.
- prefix
Hint numberPlt - DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time.
- prefix
Hint numberVlt - DHCPv6 prefix hint valid life time (sec).
- iaid int
- Identity association identifier.
- prefix_
hint str - DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server.
- prefix_
hint_ intplt - DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time.
- prefix_
hint_ intvlt - DHCPv6 prefix hint valid life time (sec).
- iaid Number
- Identity association identifier.
- prefix
Hint String - DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server.
- prefix
Hint NumberPlt - DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time.
- prefix
Hint NumberVlt - DHCPv6 prefix hint valid life time (sec).
GetInterfaceIpv6Ip6DelegatedPrefixList
- Autonomous
Flag string - Enable/disable the autonomous flag.
- Delegated
Prefix intIaid - IAID of obtained delegated-prefix from the upstream interface.
- Onlink
Flag string - Enable/disable the onlink flag.
- Prefix
Id int - Prefix ID.
- Rdnss string
- Recursive DNS server option.
- Rdnss
Service string - Recursive DNS service option.
- Subnet string
- Add subnet ID to routing prefix.
- Upstream
Interface string - Name of the interface that provides delegated information.
- Autonomous
Flag string - Enable/disable the autonomous flag.
- Delegated
Prefix intIaid - IAID of obtained delegated-prefix from the upstream interface.
- Onlink
Flag string - Enable/disable the onlink flag.
- Prefix
Id int - Prefix ID.
- Rdnss string
- Recursive DNS server option.
- Rdnss
Service string - Recursive DNS service option.
- Subnet string
- Add subnet ID to routing prefix.
- Upstream
Interface string - Name of the interface that provides delegated information.
- autonomous
Flag String - Enable/disable the autonomous flag.
- delegated
Prefix IntegerIaid - IAID of obtained delegated-prefix from the upstream interface.
- onlink
Flag String - Enable/disable the onlink flag.
- prefix
Id Integer - Prefix ID.
- rdnss String
- Recursive DNS server option.
- rdnss
Service String - Recursive DNS service option.
- subnet String
- Add subnet ID to routing prefix.
- upstream
Interface String - Name of the interface that provides delegated information.
- autonomous
Flag string - Enable/disable the autonomous flag.
- delegated
Prefix numberIaid - IAID of obtained delegated-prefix from the upstream interface.
- onlink
Flag string - Enable/disable the onlink flag.
- prefix
Id number - Prefix ID.
- rdnss string
- Recursive DNS server option.
- rdnss
Service string - Recursive DNS service option.
- subnet string
- Add subnet ID to routing prefix.
- upstream
Interface string - Name of the interface that provides delegated information.
- autonomous_
flag str - Enable/disable the autonomous flag.
- delegated_
prefix_ intiaid - IAID of obtained delegated-prefix from the upstream interface.
- onlink_
flag str - Enable/disable the onlink flag.
- prefix_
id int - Prefix ID.
- rdnss str
- Recursive DNS server option.
- rdnss_
service str - Recursive DNS service option.
- subnet str
- Add subnet ID to routing prefix.
- upstream_
interface str - Name of the interface that provides delegated information.
- autonomous
Flag String - Enable/disable the autonomous flag.
- delegated
Prefix NumberIaid - IAID of obtained delegated-prefix from the upstream interface.
- onlink
Flag String - Enable/disable the onlink flag.
- prefix
Id Number - Prefix ID.
- rdnss String
- Recursive DNS server option.
- rdnss
Service String - Recursive DNS service option.
- subnet String
- Add subnet ID to routing prefix.
- upstream
Interface String - Name of the interface that provides delegated information.
GetInterfaceIpv6Ip6ExtraAddr
- Prefix string
- IPv6 prefix.
- Prefix string
- IPv6 prefix.
- prefix String
- IPv6 prefix.
- prefix string
- IPv6 prefix.
- prefix str
- IPv6 prefix.
- prefix String
- IPv6 prefix.
GetInterfaceIpv6Ip6PrefixList
- Autonomous
Flag string - Enable/disable the autonomous flag.
- Dnssls
List<Pulumiverse.
Fortios. System. Inputs. Get Interface Ipv6Ip6Prefix List Dnssl> - DNS search list option. The structure of
dnssl
block is documented below. - Onlink
Flag string - Enable/disable the onlink flag.
- Preferred
Life intTime - Preferred life time (sec).
- Prefix string
- IPv6 prefix.
- Rdnss string
- Recursive DNS server option.
- Valid
Life intTime - Valid life time (sec).
- Autonomous
Flag string - Enable/disable the autonomous flag.
- Dnssls
[]Get
Interface Ipv6Ip6Prefix List Dnssl - DNS search list option. The structure of
dnssl
block is documented below. - Onlink
Flag string - Enable/disable the onlink flag.
- Preferred
Life intTime - Preferred life time (sec).
- Prefix string
- IPv6 prefix.
- Rdnss string
- Recursive DNS server option.
- Valid
Life intTime - Valid life time (sec).
- autonomous
Flag String - Enable/disable the autonomous flag.
- dnssls
List<Get
Interface Ipv6Ip6Prefix List Dnssl> - DNS search list option. The structure of
dnssl
block is documented below. - onlink
Flag String - Enable/disable the onlink flag.
- preferred
Life IntegerTime - Preferred life time (sec).
- prefix String
- IPv6 prefix.
- rdnss String
- Recursive DNS server option.
- valid
Life IntegerTime - Valid life time (sec).
- autonomous
Flag string - Enable/disable the autonomous flag.
- dnssls
Get
Interface Ipv6Ip6Prefix List Dnssl[] - DNS search list option. The structure of
dnssl
block is documented below. - onlink
Flag string - Enable/disable the onlink flag.
- preferred
Life numberTime - Preferred life time (sec).
- prefix string
- IPv6 prefix.
- rdnss string
- Recursive DNS server option.
- valid
Life numberTime - Valid life time (sec).
- autonomous_
flag str - Enable/disable the autonomous flag.
- dnssls
Sequence[Get
Interface Ipv6Ip6Prefix List Dnssl] - DNS search list option. The structure of
dnssl
block is documented below. - onlink_
flag str - Enable/disable the onlink flag.
- preferred_
life_ inttime - Preferred life time (sec).
- prefix str
- IPv6 prefix.
- rdnss str
- Recursive DNS server option.
- valid_
life_ inttime - Valid life time (sec).
- autonomous
Flag String - Enable/disable the autonomous flag.
- dnssls List<Property Map>
- DNS search list option. The structure of
dnssl
block is documented below. - onlink
Flag String - Enable/disable the onlink flag.
- preferred
Life NumberTime - Preferred life time (sec).
- prefix String
- IPv6 prefix.
- rdnss String
- Recursive DNS server option.
- valid
Life NumberTime - Valid life time (sec).
GetInterfaceIpv6Ip6PrefixListDnssl
- Domain string
- Domain name.
- Domain string
- Domain name.
- domain String
- Domain name.
- domain string
- Domain name.
- domain str
- Domain name.
- domain String
- Domain name.
GetInterfaceIpv6Vrrp6
- Accept
Mode string - Enable/disable accept mode.
- Adv
Interval int - Advertisement interval (1 - 255 seconds).
- Ignore
Default stringRoute - Enable/disable ignoring of default route when checking destination.
- Preempt string
- Enable/disable preempt mode.
- Priority int
- Priority of the virtual router (1 - 255).
- Start
Time int - Startup time (1 - 255 seconds).
- Status string
- Enable/disable VRRP.
- Vrdst6 string
- Monitor the route to this destination.
- Vrgrp int
- VRRP group ID (1 - 65535).
- Vrid int
- Virtual router identifier (1 - 255).
- Vrip6 string
- IPv6 address of the virtual router.
- Accept
Mode string - Enable/disable accept mode.
- Adv
Interval int - Advertisement interval (1 - 255 seconds).
- Ignore
Default stringRoute - Enable/disable ignoring of default route when checking destination.
- Preempt string
- Enable/disable preempt mode.
- Priority int
- Priority of the virtual router (1 - 255).
- Start
Time int - Startup time (1 - 255 seconds).
- Status string
- Enable/disable VRRP.
- Vrdst6 string
- Monitor the route to this destination.
- Vrgrp int
- VRRP group ID (1 - 65535).
- Vrid int
- Virtual router identifier (1 - 255).
- Vrip6 string
- IPv6 address of the virtual router.
- accept
Mode String - Enable/disable accept mode.
- adv
Interval Integer - Advertisement interval (1 - 255 seconds).
- ignore
Default StringRoute - Enable/disable ignoring of default route when checking destination.
- preempt String
- Enable/disable preempt mode.
- priority Integer
- Priority of the virtual router (1 - 255).
- start
Time Integer - Startup time (1 - 255 seconds).
- status String
- Enable/disable VRRP.
- vrdst6 String
- Monitor the route to this destination.
- vrgrp Integer
- VRRP group ID (1 - 65535).
- vrid Integer
- Virtual router identifier (1 - 255).
- vrip6 String
- IPv6 address of the virtual router.
- accept
Mode string - Enable/disable accept mode.
- adv
Interval number - Advertisement interval (1 - 255 seconds).
- ignore
Default stringRoute - Enable/disable ignoring of default route when checking destination.
- preempt string
- Enable/disable preempt mode.
- priority number
- Priority of the virtual router (1 - 255).
- start
Time number - Startup time (1 - 255 seconds).
- status string
- Enable/disable VRRP.
- vrdst6 string
- Monitor the route to this destination.
- vrgrp number
- VRRP group ID (1 - 65535).
- vrid number
- Virtual router identifier (1 - 255).
- vrip6 string
- IPv6 address of the virtual router.
- accept_
mode str - Enable/disable accept mode.
- adv_
interval int - Advertisement interval (1 - 255 seconds).
- ignore_
default_ strroute - Enable/disable ignoring of default route when checking destination.
- preempt str
- Enable/disable preempt mode.
- priority int
- Priority of the virtual router (1 - 255).
- start_
time int - Startup time (1 - 255 seconds).
- status str
- Enable/disable VRRP.
- vrdst6 str
- Monitor the route to this destination.
- vrgrp int
- VRRP group ID (1 - 65535).
- vrid int
- Virtual router identifier (1 - 255).
- vrip6 str
- IPv6 address of the virtual router.
- accept
Mode String - Enable/disable accept mode.
- adv
Interval Number - Advertisement interval (1 - 255 seconds).
- ignore
Default StringRoute - Enable/disable ignoring of default route when checking destination.
- preempt String
- Enable/disable preempt mode.
- priority Number
- Priority of the virtual router (1 - 255).
- start
Time Number - Startup time (1 - 255 seconds).
- status String
- Enable/disable VRRP.
- vrdst6 String
- Monitor the route to this destination.
- vrgrp Number
- VRRP group ID (1 - 65535).
- vrid Number
- Virtual router identifier (1 - 255).
- vrip6 String
- IPv6 address of the virtual router.
GetInterfaceManagedDevice
- Name string
- Specify the name of the desired system interface.
- Name string
- Specify the name of the desired system interface.
- name String
- Specify the name of the desired system interface.
- name string
- Specify the name of the desired system interface.
- name str
- Specify the name of the desired system interface.
- name String
- Specify the name of the desired system interface.
GetInterfaceMember
- Interface
Name string - Physical interface name.
- Interface
Name string - Physical interface name.
- interface
Name String - Physical interface name.
- interface
Name string - Physical interface name.
- interface_
name str - Physical interface name.
- interface
Name String - Physical interface name.
GetInterfaceSecondaryip
- Allowaccess string
- Management access settings for the secondary IP address.
- Detectprotocol string
- Protocols used to detect the server.
- Detectserver string
- Gateway's ping server for this IP.
- Gwdetect string
- Enable/disable detect gateway alive for first.
- Ha
Priority int - HA election priority for the PING server.
- Id int
- ID.
- Ip string
- Secondary IP address of the interface.
- Ping
Serv intStatus - PING server status.
- Secip
Relay stringIp - DHCP relay IP address.
- Allowaccess string
- Management access settings for the secondary IP address.
- Detectprotocol string
- Protocols used to detect the server.
- Detectserver string
- Gateway's ping server for this IP.
- Gwdetect string
- Enable/disable detect gateway alive for first.
- Ha
Priority int - HA election priority for the PING server.
- Id int
- ID.
- Ip string
- Secondary IP address of the interface.
- Ping
Serv intStatus - PING server status.
- Secip
Relay stringIp - DHCP relay IP address.
- allowaccess String
- Management access settings for the secondary IP address.
- detectprotocol String
- Protocols used to detect the server.
- detectserver String
- Gateway's ping server for this IP.
- gwdetect String
- Enable/disable detect gateway alive for first.
- ha
Priority Integer - HA election priority for the PING server.
- id Integer
- ID.
- ip String
- Secondary IP address of the interface.
- ping
Serv IntegerStatus - PING server status.
- secip
Relay StringIp - DHCP relay IP address.
- allowaccess string
- Management access settings for the secondary IP address.
- detectprotocol string
- Protocols used to detect the server.
- detectserver string
- Gateway's ping server for this IP.
- gwdetect string
- Enable/disable detect gateway alive for first.
- ha
Priority number - HA election priority for the PING server.
- id number
- ID.
- ip string
- Secondary IP address of the interface.
- ping
Serv numberStatus - PING server status.
- secip
Relay stringIp - DHCP relay IP address.
- allowaccess str
- Management access settings for the secondary IP address.
- detectprotocol str
- Protocols used to detect the server.
- detectserver str
- Gateway's ping server for this IP.
- gwdetect str
- Enable/disable detect gateway alive for first.
- ha_
priority int - HA election priority for the PING server.
- id int
- ID.
- ip str
- Secondary IP address of the interface.
- ping_
serv_ intstatus - PING server status.
- secip_
relay_ strip - DHCP relay IP address.
- allowaccess String
- Management access settings for the secondary IP address.
- detectprotocol String
- Protocols used to detect the server.
- detectserver String
- Gateway's ping server for this IP.
- gwdetect String
- Enable/disable detect gateway alive for first.
- ha
Priority Number - HA election priority for the PING server.
- id Number
- ID.
- ip String
- Secondary IP address of the interface.
- ping
Serv NumberStatus - PING server status.
- secip
Relay StringIp - DHCP relay IP address.
GetInterfaceSecurityGroup
- Name string
- Specify the name of the desired system interface.
- Name string
- Specify the name of the desired system interface.
- name String
- Specify the name of the desired system interface.
- name string
- Specify the name of the desired system interface.
- name str
- Specify the name of the desired system interface.
- name String
- Specify the name of the desired system interface.
GetInterfaceTagging
- Category string
- Tag category.
- Name string
- Specify the name of the desired system interface.
- List<Pulumiverse.
Fortios. System. Inputs. Get Interface Tagging Tag> - Tags. The structure of
tags
block is documented below.
- Category string
- Tag category.
- Name string
- Specify the name of the desired system interface.
- []Get
Interface Tagging Tag - Tags. The structure of
tags
block is documented below.
- category String
- Tag category.
- name String
- Specify the name of the desired system interface.
- List<Get
Interface Tagging Tag> - Tags. The structure of
tags
block is documented below.
- category string
- Tag category.
- name string
- Specify the name of the desired system interface.
- Get
Interface Tagging Tag[] - Tags. The structure of
tags
block is documented below.
- category str
- Tag category.
- name str
- Specify the name of the desired system interface.
- Sequence[Get
Interface Tagging Tag] - Tags. The structure of
tags
block is documented below.
- category String
- Tag category.
- name String
- Specify the name of the desired system interface.
- List<Property Map>
- Tags. The structure of
tags
block is documented below.
GetInterfaceTaggingTag
- Name string
- Specify the name of the desired system interface.
- Name string
- Specify the name of the desired system interface.
- name String
- Specify the name of the desired system interface.
- name string
- Specify the name of the desired system interface.
- name str
- Specify the name of the desired system interface.
- name String
- Specify the name of the desired system interface.
GetInterfaceVrrp
- Accept
Mode string - Enable/disable accept mode.
- Adv
Interval int - Advertisement interval (1 - 255 seconds).
- Ignore
Default stringRoute - Enable/disable ignoring of default route when checking destination.
- Preempt string
- Enable/disable preempt mode.
- Priority int
- Priority of the virtual router (1 - 255).
- Proxy
Arps List<Pulumiverse.Fortios. System. Inputs. Get Interface Vrrp Proxy Arp> - VRRP Proxy ARP configuration. The structure of
proxy_arp
block is documented below. - Start
Time int - Startup time (1 - 255 seconds).
- Status string
- Enable/disable VRRP.
- Version string
- VRRP version.
- Vrdst string
- Monitor the route to this destination.
- Vrdst
Priority int - Priority of the virtual router when the virtual router destination becomes unreachable (0 - 254).
- Vrgrp int
- VRRP group ID (1 - 65535).
- Vrid int
- Virtual router identifier (1 - 255).
- Vrip string
- IP address of the virtual router.
- Accept
Mode string - Enable/disable accept mode.
- Adv
Interval int - Advertisement interval (1 - 255 seconds).
- Ignore
Default stringRoute - Enable/disable ignoring of default route when checking destination.
- Preempt string
- Enable/disable preempt mode.
- Priority int
- Priority of the virtual router (1 - 255).
- Proxy
Arps []GetInterface Vrrp Proxy Arp - VRRP Proxy ARP configuration. The structure of
proxy_arp
block is documented below. - Start
Time int - Startup time (1 - 255 seconds).
- Status string
- Enable/disable VRRP.
- Version string
- VRRP version.
- Vrdst string
- Monitor the route to this destination.
- Vrdst
Priority int - Priority of the virtual router when the virtual router destination becomes unreachable (0 - 254).
- Vrgrp int
- VRRP group ID (1 - 65535).
- Vrid int
- Virtual router identifier (1 - 255).
- Vrip string
- IP address of the virtual router.
- accept
Mode String - Enable/disable accept mode.
- adv
Interval Integer - Advertisement interval (1 - 255 seconds).
- ignore
Default StringRoute - Enable/disable ignoring of default route when checking destination.
- preempt String
- Enable/disable preempt mode.
- priority Integer
- Priority of the virtual router (1 - 255).
- proxy
Arps List<GetInterface Vrrp Proxy Arp> - VRRP Proxy ARP configuration. The structure of
proxy_arp
block is documented below. - start
Time Integer - Startup time (1 - 255 seconds).
- status String
- Enable/disable VRRP.
- version String
- VRRP version.
- vrdst String
- Monitor the route to this destination.
- vrdst
Priority Integer - Priority of the virtual router when the virtual router destination becomes unreachable (0 - 254).
- vrgrp Integer
- VRRP group ID (1 - 65535).
- vrid Integer
- Virtual router identifier (1 - 255).
- vrip String
- IP address of the virtual router.
- accept
Mode string - Enable/disable accept mode.
- adv
Interval number - Advertisement interval (1 - 255 seconds).
- ignore
Default stringRoute - Enable/disable ignoring of default route when checking destination.
- preempt string
- Enable/disable preempt mode.
- priority number
- Priority of the virtual router (1 - 255).
- proxy
Arps GetInterface Vrrp Proxy Arp[] - VRRP Proxy ARP configuration. The structure of
proxy_arp
block is documented below. - start
Time number - Startup time (1 - 255 seconds).
- status string
- Enable/disable VRRP.
- version string
- VRRP version.
- vrdst string
- Monitor the route to this destination.
- vrdst
Priority number - Priority of the virtual router when the virtual router destination becomes unreachable (0 - 254).
- vrgrp number
- VRRP group ID (1 - 65535).
- vrid number
- Virtual router identifier (1 - 255).
- vrip string
- IP address of the virtual router.
- accept_
mode str - Enable/disable accept mode.
- adv_
interval int - Advertisement interval (1 - 255 seconds).
- ignore_
default_ strroute - Enable/disable ignoring of default route when checking destination.
- preempt str
- Enable/disable preempt mode.
- priority int
- Priority of the virtual router (1 - 255).
- proxy_
arps Sequence[GetInterface Vrrp Proxy Arp] - VRRP Proxy ARP configuration. The structure of
proxy_arp
block is documented below. - start_
time int - Startup time (1 - 255 seconds).
- status str
- Enable/disable VRRP.
- version str
- VRRP version.
- vrdst str
- Monitor the route to this destination.
- vrdst_
priority int - Priority of the virtual router when the virtual router destination becomes unreachable (0 - 254).
- vrgrp int
- VRRP group ID (1 - 65535).
- vrid int
- Virtual router identifier (1 - 255).
- vrip str
- IP address of the virtual router.
- accept
Mode String - Enable/disable accept mode.
- adv
Interval Number - Advertisement interval (1 - 255 seconds).
- ignore
Default StringRoute - Enable/disable ignoring of default route when checking destination.
- preempt String
- Enable/disable preempt mode.
- priority Number
- Priority of the virtual router (1 - 255).
- proxy
Arps List<Property Map> - VRRP Proxy ARP configuration. The structure of
proxy_arp
block is documented below. - start
Time Number - Startup time (1 - 255 seconds).
- status String
- Enable/disable VRRP.
- version String
- VRRP version.
- vrdst String
- Monitor the route to this destination.
- vrdst
Priority Number - Priority of the virtual router when the virtual router destination becomes unreachable (0 - 254).
- vrgrp Number
- VRRP group ID (1 - 65535).
- vrid Number
- Virtual router identifier (1 - 255).
- vrip String
- IP address of the virtual router.
GetInterfaceVrrpProxyArp
Package Details
- Repository
- fortios pulumiverse/pulumi-fortios
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
fortios
Terraform Provider.