Fortios v0.0.6, Jul 9 24

Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.system.getInterface

Explore with Pulumi AI

Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

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:

AcName string: PPPoE server name.
Aggregate string: Aggregate interface.
AggregateType 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.
ApDiscover string: Enable/disable automatic registration of unknown FortiAP devices.
Arpforward string: Enable/disable ARP forwarding.
AuthCert string: HTTPS server certificate.
AuthPortalAddr string: Address of captive portal.
AuthType string: PPP authentication type to use.
AutoAuthExtensionDevice string: Enable/disable automatic authorization of dedicated Fortinet extension device on this interface.
BandwidthMeasureTime int: Bandwidth measure time
Bfd string: Bidirectional Forwarding Detection (BFD) settings.
BfdDesiredMinTx int: BFD desired minimal transmit interval.
BfdDetectMult int: BFD detection multiplier.
BfdRequiredMinRx int: BFD required minimal receive interval.
BroadcastForticlientDiscovery string: Enable/disable broadcasting FortiClient discovery messages.
BroadcastForward string: Enable/disable broadcast forwarding.
CaptivePortal int: Enable/disable captive portal.
CliConnStatus int: CLI connection status.
ClientOptions List<Pulumiverse.Fortios.System.Outputs.GetInterfaceClientOption>: DHCP client options. The structure of client_options block is documented below.
Color int: Color of icon on the GUI.
Data string: Interface name.
DedicatedTo string: Configure interface for single purpose.
DefaultPurdueLevel string: 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.
DetectedPeerMtu int: MTU of detected peer (0 - 4294967295).
Detectprotocol string: Protocols used to detect the server.
Detectserver string: Gateway's ping server for this IP.
DeviceAccessList string: Device access list.
DeviceIdentification string: Enable/disable passively gathering of device identity information about the devices on the network connected to this interface.
DeviceIdentificationActiveScan string: Enable/disable active gathering of device identity information about the devices on the network connected to this interface.
DeviceNetscan string: Enable/disable inclusion of devices detected on this interface in network vulnerability scans.
DeviceUserIdentification string: Enable/disable passive gathering of user identity information about users on this interface.
Devindex int: Device Index.
DhcpBroadcastFlag string: Enable/disable setting of the broadcast flag in messages sent by the DHCP client (default = enable).
DhcpClasslessRouteAddition string: Enable/disable addition of classless static routes retrieved from DHCP server.
DhcpClientIdentifier string: DHCP client identifier.
DhcpRelayAgentOption string: Enable/disable DHCP relay agent option.
DhcpRelayAllowNoEndOption string: Enable/disable relaying DHCP messages with no end option.
DhcpRelayCircuitId string: DHCP relay circuit ID.
DhcpRelayInterface string: Specify outgoing interface to reach server.
DhcpRelayInterfaceSelectMethod string: Specify how to select outgoing interface to reach server.
DhcpRelayIp string: DHCP relay IP address.
DhcpRelayLinkSelection string: DHCP relay link selection.
DhcpRelayRequestAllServer string: Enable/disable sending DHCP request to all servers.
DhcpRelayService string: Enable/disable allowing this interface to act as a DHCP relay.
DhcpRelaySourceIp string: IP address used by the DHCP relay as its source IP.
DhcpRelayType string: DHCP relay type (regular or IPsec).
DhcpRenewTime int: DHCP renew time in seconds (300-604800), 0 means use the renew time provided by the server.
DhcpSmartRelay string: Enable/disable DHCP smart relay.
DhcpSnoopingServerLists List<Pulumiverse.Fortios.System.Outputs.GetInterfaceDhcpSnoopingServerList>: Configure DHCP server access list. The structure of dhcp_snooping_server_list block is documented below.
DiscRetryTimeout int: Time in seconds to wait before retrying to start a PPPoE discovery, 0 means no timeout.
DisconnectThreshold 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.
DnsServerOverride string: Enable/disable use DNS acquired by DHCP or PPPoE.
DnsServerProtocol string: DNS transport protocols.
DropFragment string: Enable/disable drop fragment packets.
DropOverlappedFragment string: Enable/disable drop overlapped fragment packets.
EapCaCert string: EAP CA certificate name.
EapIdentity string: EAP identity.
EapMethod string: EAP method.
EapPassword string: EAP password.
EapSupplicant string: Enable/disable EAP-Supplicant.
EapUserCert string: EAP user certificate name.
EgressShapingProfile string: Outgoing traffic shaping profile.
EndpointCompliance string: Enable/disable endpoint compliance enforcement.
EstimatedDownstreamBandwidth int: Estimated maximum downstream bandwidth (kbps). Used to estimate link utilization.
EstimatedUpstreamBandwidth int: Estimated maximum upstream bandwidth (kbps). Used to estimate link utilization.
ExplicitFtpProxy string: Enable/disable the explicit FTP proxy on this interface.
ExplicitWebProxy string: 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).
FailActionOnExtender string: Action on extender when interface fail .
FailAlertInterfaces List<Pulumiverse.Fortios.System.Outputs.GetInterfaceFailAlertInterface>: 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.
FailAlertMethod string: Select link-failed-signal or link-down method to alert about a failed link.
FailDetect string: Enable/disable fail detection features for this interface.
FailDetectOption string: 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.
FortilinkBackupLink int: fortilink split interface backup link.
FortilinkNeighborDetect string: Protocol for FortiGate neighbor discovery.
FortilinkSplitInterface string: Enable/disable FortiLink split interface to connect member link to different FortiSwitch in stack for uplink redundancy.
FortilinkStacking string: Enable/disable FortiLink switch-stacking on this interface.
ForwardDomain int: Transparent mode forward domain.
ForwardErrorCorrection string: Configure forward error correction (FEC).
Gwdetect string: Enable/disable detect gateway alive for first.
HaPriority int: HA election priority for the PING server.
IcmpAcceptRedirect string: Enable/disable ICMP accept redirect.
IcmpSendRedirect string: Enable/disable ICMP send redirect.
Id string: The provider-assigned unique ID for this managed resource.
IdentAccept string: Enable/disable authentication for this interface.
IdleTimeout int: PPPoE auto disconnect after idle timeout seconds, 0 means no timeout.
IkeSamlServer string: Configure IKE authentication SAML server.
Inbandwidth int: Bandwidth limit for incoming traffic (0 - 16776000 kbps), 0 means unlimited.
IngressShapingProfile string: Incoming traffic shaping profile.
IngressSpilloverThreshold int: Ingress Spillover threshold (0 - 16776000 kbps).
Internal int: Implicitly created.
Ip string: Secondary IP address of the interface.
IpManagedByFortiipam string: Enable/disable automatic IP address assignment of this interface by FortiIPAM.
Ipmac string: Enable/disable IP/MAC binding.
IpsSnifferMode string: 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.GetInterfaceIpv6>: IPv6 of interface. The structure of ipv6 block is documented below.
L2forward string: Enable/disable l2 forwarding.
LacpHaSecondary string: LACP HA secondary member.
LacpHaSlave string: LACP HA slave.
LacpMode string: LACP mode.
LacpSpeed string: How often the interface sends LACP messages.
LcpEchoInterval int: Time in seconds between PPPoE Link Control Protocol (LCP) echo requests.
LcpMaxEchoFails int: Maximum missed LCP echo messages before disconnect.
LinkUpDelay int: Number of milliseconds to wait before considering a link is up.
LldpNetworkPolicy string: LLDP-MED network policy profile.
LldpReception string: Enable/disable Link Layer Discovery Protocol (LLDP) reception.
LldpTransmission string: Enable/disable Link Layer Discovery Protocol (LLDP) transmission.
Macaddr string: Change the interface's MAC address.
ManagedDevices List<Pulumiverse.Fortios.System.Outputs.GetInterfaceManagedDevice>: Available when FortiLink is enabled, used for managed devices through FortiLink interface. The structure of managed_device block is documented below.
ManagedSubnetworkSize string: Number of IP addresses to be allocated by FortiIPAM and used by this FortiGate unit's DHCP server settings.
ManagementIp string: High Availability in-band management IP address of this interface.
MeasuredDownstreamBandwidth int: Measured downstream bandwidth (kbps).
MeasuredUpstreamBandwidth int: Measured upstream bandwidth (kbps).
Mediatype string: Select SFP media interface type
Members List<Pulumiverse.Fortios.System.Outputs.GetInterfaceMember>: Physical interfaces that belong to the aggregate or redundant interface. The structure of member block is documented below.
MinLinks int: Minimum number of aggregated ports that must be up.
MinLinksDown string: Action to take when less than the configured minimum number of links are active.
Mode string: Addressing mode (static, DHCP, PPPoE).
MonitorBandwidth string: Enable monitoring bandwidth on this interface.
Mtu int: MTU value for this interface.
MtuOverride string: Enable to set a custom MTU for this interface.
Name string: Tag name.
Ndiscforward string: Enable/disable NDISC forwarding.
NetbiosForward string: Enable/disable NETBIOS forwarding.
NetflowSampler 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).
PadtRetryTimeout int: PPPoE Active Discovery Terminate (PADT) used to terminate sessions after an idle time.
Password string: PPPoE account's password.
PingServStatus int: PING server status.
PollingInterval int: sFlow polling interval (1 - 255 sec).
PppoeUnnumberedNegotiate string: Enable/disable PPPoE unnumbered negotiation.
PptpAuthType string: PPTP authentication type.
PptpClient string: Enable/disable PPTP client.
PptpPassword string: PPTP password.
PptpServerIp string: PPTP server IP address.
PptpTimeout int: Idle timer in minutes (0 for disabled).
PptpUser string: PPTP user name.
PreserveSessionRoute string: Enable/disable preservation of session route when dirty.
Priority int: Priority of the virtual router (1 - 255).
PriorityOverride string: Enable/disable fail back to higher priority port once recovered.
ProxyCaptivePortal string: Enable/disable proxy captive portal on this interface.
ReachableTime int: IPv4 reachable time in milliseconds (30000 - 3600000, default = 30000).
RedundantInterface string: Redundant interface.
RemoteIp string: Remote IP address of tunnel.
ReplacemsgOverrideGroup string: Replacement message override group.
RingRx int: RX ring size.
RingTx int: TX ring size.
Role string: Interface role.
SampleDirection string: Data that NetFlow collects (rx, tx, or both).
SampleRate int: sFlow sample rate (10 - 99999).
ScanBotnetConnections string: Enable monitoring or blocking connections to Botnet servers through this interface.
SecondaryIp string: Enable/disable adding a secondary IP to this interface.
Secondaryips List<Pulumiverse.Fortios.System.Outputs.GetInterfaceSecondaryip>: Second IP address of interface. The structure of secondaryip block is documented below.
SecurityExemptList string: Name of security-exempt-list.
SecurityExternalLogout string: URL of external authentication logout server.
SecurityExternalWeb string: URL of external authentication web server.
SecurityGroups List<Pulumiverse.Fortios.System.Outputs.GetInterfaceSecurityGroup>: User groups that can authenticate with the captive portal. The structure of security_groups block is documented below.
SecurityMacAuthBypass string: Enable/disable MAC authentication bypass.
SecurityMode string: Turn on captive portal authentication for this interface.
SecurityRedirectUrl string: URL redirection after disclaimer/authentication.
ServiceName string: PPPoE service name.
SflowSampler string: Enable/disable sFlow on this interface.
SnmpIndex int: Permanent SNMP Index of the interface.
Speed string: Interface speed. The default setting and the options available depend on the interface hardware.
SpilloverThreshold int: Egress Spillover threshold (0 - 16776000 kbps), 0 means unlimited.
SrcCheck string: Enable/disable source IP check.
Status string: Enable/disable VRRP.
Stp string: Enable/disable STP.
StpHaSecondary string: Control STP behaviour on HA secondary.
Stpforward string: Enable/disable STP forwarding.
StpforwardMode string: Configure STP forwarding mode.
Subst string: Enable to always send packets from this interface to a destination MAC address.
SubstituteDstMac string: Destination MAC address that all packets are sent to from this interface.
SwcFirstCreate int: Initial create for switch-controller VLANs.
SwcVlan int: Creation status for switch-controller VLANs.
Switch string: Contained in switch.
SwitchControllerAccessVlan string: Block FortiSwitch port-to-port traffic.
SwitchControllerArpInspection string: Enable/disable FortiSwitch ARP inspection.
SwitchControllerDhcpSnooping string: Switch controller DHCP snooping.
SwitchControllerDhcpSnoopingOption82 string: Switch controller DHCP snooping option82.
SwitchControllerDhcpSnoopingVerifyMac string: Switch controller DHCP snooping verify MAC.
SwitchControllerDynamic string: Integrated FortiLink settings for managed FortiSwitch.
SwitchControllerFeature string: Interface's purpose when assigning traffic (read only).
SwitchControllerIgmpSnooping string: Switch controller IGMP snooping.
SwitchControllerIgmpSnoopingFastLeave string: Switch controller IGMP snooping fast-leave.
SwitchControllerIgmpSnoopingProxy string: Switch controller IGMP snooping proxy.
SwitchControllerIotScanning string: Enable/disable managed FortiSwitch IoT scanning.
SwitchControllerLearningLimit int: Limit the number of dynamic MAC addresses on this VLAN (1 - 128, 0 = no limit, default).
SwitchControllerMgmtVlan int: VLAN to use for FortiLink management purposes.
SwitchControllerNac string: Integrated NAC settings for managed FortiSwitch.
SwitchControllerNetflowCollect string: NetFlow collection and processing.
SwitchControllerOffload string: Enable/disable managed FortiSwitch routing offload.
SwitchControllerOffloadGw string: Enable/disable managed FortiSwitch routing offload gateway.
SwitchControllerOffloadIp string: IP for routing offload on FortiSwitch.
SwitchControllerRspanMode string: Stop Layer2 MAC learning and interception of BPDUs and other packets on this interface.
SwitchControllerSourceIp string: Source IP address used in FortiLink over L3 connections.
SwitchControllerTrafficPolicy string: Switch controller traffic policy for the VLAN.
SystemId string: Define a system ID for the aggregate interface.
SystemIdType string: Method in which system ID is generated.
Taggings List<Pulumiverse.Fortios.System.Outputs.GetInterfaceTagging>: Config object tagging. The structure of tagging block is documented below.
TcpMss int: TCP maximum segment size. 0 means do not change segment size.
Trunk string: Enable/disable VLAN trunk.
TrustIp1 string: Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
TrustIp2 string: Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
TrustIp3 string: Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
TrustIp61 string: Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
TrustIp62 string: Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
TrustIp63 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.
VlanProtocol 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.
VrrpVirtualMac string: Enable/disable use of virtual MAC for VRRP.
Vrrps List<Pulumiverse.Fortios.System.Outputs.GetInterfaceVrrp>: 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).
WinsIp string: WINS server IP.
Vdomparam string

AcName string: PPPoE server name.
Aggregate string: Aggregate interface.
AggregateType 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.
ApDiscover string: Enable/disable automatic registration of unknown FortiAP devices.
Arpforward string: Enable/disable ARP forwarding.
AuthCert string: HTTPS server certificate.
AuthPortalAddr string: Address of captive portal.
AuthType string: PPP authentication type to use.
AutoAuthExtensionDevice string: Enable/disable automatic authorization of dedicated Fortinet extension device on this interface.
BandwidthMeasureTime int: Bandwidth measure time
Bfd string: Bidirectional Forwarding Detection (BFD) settings.
BfdDesiredMinTx int: BFD desired minimal transmit interval.
BfdDetectMult int: BFD detection multiplier.
BfdRequiredMinRx int: BFD required minimal receive interval.
BroadcastForticlientDiscovery string: Enable/disable broadcasting FortiClient discovery messages.
BroadcastForward string: Enable/disable broadcast forwarding.
CaptivePortal int: Enable/disable captive portal.
CliConnStatus int: CLI connection status.
ClientOptions []GetInterfaceClientOption: DHCP client options. The structure of client_options block is documented below.
Color int: Color of icon on the GUI.
DedicatedTo string: Configure interface for single purpose.
DefaultPurdueLevel string: 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.
DetectedPeerMtu int: MTU of detected peer (0 - 4294967295).
Detectprotocol string: Protocols used to detect the server.
Detectserver string: Gateway's ping server for this IP.
DeviceAccessList string: Device access list.
DeviceIdentification string: Enable/disable passively gathering of device identity information about the devices on the network connected to this interface.
DeviceIdentificationActiveScan string: Enable/disable active gathering of device identity information about the devices on the network connected to this interface.
DeviceNetscan string: Enable/disable inclusion of devices detected on this interface in network vulnerability scans.
DeviceUserIdentification string: Enable/disable passive gathering of user identity information about users on this interface.
Devindex int: Device Index.
DhcpBroadcastFlag string: Enable/disable setting of the broadcast flag in messages sent by the DHCP client (default = enable).
DhcpClasslessRouteAddition string: Enable/disable addition of classless static routes retrieved from DHCP server.
DhcpClientIdentifier string: DHCP client identifier.
DhcpRelayAgentOption string: Enable/disable DHCP relay agent option.
DhcpRelayAllowNoEndOption string: Enable/disable relaying DHCP messages with no end option.
DhcpRelayCircuitId string: DHCP relay circuit ID.
DhcpRelayInterface string: Specify outgoing interface to reach server.
DhcpRelayInterfaceSelectMethod string: Specify how to select outgoing interface to reach server.
DhcpRelayIp string: DHCP relay IP address.
DhcpRelayLinkSelection string: DHCP relay link selection.
DhcpRelayRequestAllServer string: Enable/disable sending DHCP request to all servers.
DhcpRelayService string: Enable/disable allowing this interface to act as a DHCP relay.
DhcpRelaySourceIp string: IP address used by the DHCP relay as its source IP.
DhcpRelayType string: DHCP relay type (regular or IPsec).
DhcpRenewTime int: DHCP renew time in seconds (300-604800), 0 means use the renew time provided by the server.
DhcpSmartRelay string: Enable/disable DHCP smart relay.
DhcpSnoopingServerLists []GetInterfaceDhcpSnoopingServerList: Configure DHCP server access list. The structure of dhcp_snooping_server_list block is documented below.
DiscRetryTimeout int: Time in seconds to wait before retrying to start a PPPoE discovery, 0 means no timeout.
DisconnectThreshold 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.
DnsServerOverride string: Enable/disable use DNS acquired by DHCP or PPPoE.
DnsServerProtocol string: DNS transport protocols.
DropFragment string: Enable/disable drop fragment packets.
DropOverlappedFragment string: Enable/disable drop overlapped fragment packets.
EapCaCert string: EAP CA certificate name.
EapIdentity string: EAP identity.
EapMethod string: EAP method.
EapPassword string: EAP password.
EapSupplicant string: Enable/disable EAP-Supplicant.
EapUserCert string: EAP user certificate name.
EgressShapingProfile string: Outgoing traffic shaping profile.
EndpointCompliance string: Enable/disable endpoint compliance enforcement.
EstimatedDownstreamBandwidth int: Estimated maximum downstream bandwidth (kbps). Used to estimate link utilization.
EstimatedUpstreamBandwidth int: Estimated maximum upstream bandwidth (kbps). Used to estimate link utilization.
ExplicitFtpProxy string: Enable/disable the explicit FTP proxy on this interface.
ExplicitWebProxy string: 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).
FailActionOnExtender string: Action on extender when interface fail .
FailAlertInterfaces []GetInterfaceFailAlertInterface: 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.
FailAlertMethod string: Select link-failed-signal or link-down method to alert about a failed link.
FailDetect string: Enable/disable fail detection features for this interface.
FailDetectOption string: 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.
FortilinkBackupLink int: fortilink split interface backup link.
FortilinkNeighborDetect string: Protocol for FortiGate neighbor discovery.
FortilinkSplitInterface string: Enable/disable FortiLink split interface to connect member link to different FortiSwitch in stack for uplink redundancy.
FortilinkStacking string: Enable/disable FortiLink switch-stacking on this interface.
ForwardDomain int: Transparent mode forward domain.
ForwardErrorCorrection string: Configure forward error correction (FEC).
Gwdetect string: Enable/disable detect gateway alive for first.
HaPriority int: HA election priority for the PING server.
IcmpAcceptRedirect string: Enable/disable ICMP accept redirect.
IcmpSendRedirect string: Enable/disable ICMP send redirect.
Id string: The provider-assigned unique ID for this managed resource.
IdentAccept string: Enable/disable authentication for this interface.
IdleTimeout int: PPPoE auto disconnect after idle timeout seconds, 0 means no timeout.
IkeSamlServer string: Configure IKE authentication SAML server.
Inbandwidth int: Bandwidth limit for incoming traffic (0 - 16776000 kbps), 0 means unlimited.
IngressShapingProfile string: Incoming traffic shaping profile.
IngressSpilloverThreshold int: Ingress Spillover threshold (0 - 16776000 kbps).
Interface string: Interface name.
Internal int: Implicitly created.
Ip string: Secondary IP address of the interface.
IpManagedByFortiipam string: Enable/disable automatic IP address assignment of this interface by FortiIPAM.
Ipmac string: Enable/disable IP/MAC binding.
IpsSnifferMode string: 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 []GetInterfaceIpv6: IPv6 of interface. The structure of ipv6 block is documented below.
L2forward string: Enable/disable l2 forwarding.
LacpHaSecondary string: LACP HA secondary member.
LacpHaSlave string: LACP HA slave.
LacpMode string: LACP mode.
LacpSpeed string: How often the interface sends LACP messages.
LcpEchoInterval int: Time in seconds between PPPoE Link Control Protocol (LCP) echo requests.
LcpMaxEchoFails int: Maximum missed LCP echo messages before disconnect.
LinkUpDelay int: Number of milliseconds to wait before considering a link is up.
LldpNetworkPolicy string: LLDP-MED network policy profile.
LldpReception string: Enable/disable Link Layer Discovery Protocol (LLDP) reception.
LldpTransmission string: Enable/disable Link Layer Discovery Protocol (LLDP) transmission.
Macaddr string: Change the interface's MAC address.
ManagedDevices []GetInterfaceManagedDevice: Available when FortiLink is enabled, used for managed devices through FortiLink interface. The structure of managed_device block is documented below.
ManagedSubnetworkSize string: Number of IP addresses to be allocated by FortiIPAM and used by this FortiGate unit's DHCP server settings.
ManagementIp string: High Availability in-band management IP address of this interface.
MeasuredDownstreamBandwidth int: Measured downstream bandwidth (kbps).
MeasuredUpstreamBandwidth int: Measured upstream bandwidth (kbps).
Mediatype string: Select SFP media interface type
Members []GetInterfaceMember: Physical interfaces that belong to the aggregate or redundant interface. The structure of member block is documented below.
MinLinks int: Minimum number of aggregated ports that must be up.
MinLinksDown string: Action to take when less than the configured minimum number of links are active.
Mode string: Addressing mode (static, DHCP, PPPoE).
MonitorBandwidth string: Enable monitoring bandwidth on this interface.
Mtu int: MTU value for this interface.
MtuOverride string: Enable to set a custom MTU for this interface.
Name string: Tag name.
Ndiscforward string: Enable/disable NDISC forwarding.
NetbiosForward string: Enable/disable NETBIOS forwarding.
NetflowSampler 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).
PadtRetryTimeout int: PPPoE Active Discovery Terminate (PADT) used to terminate sessions after an idle time.
Password string: PPPoE account's password.
PingServStatus int: PING server status.
PollingInterval int: sFlow polling interval (1 - 255 sec).
PppoeUnnumberedNegotiate string: Enable/disable PPPoE unnumbered negotiation.
PptpAuthType string: PPTP authentication type.
PptpClient string: Enable/disable PPTP client.
PptpPassword string: PPTP password.
PptpServerIp string: PPTP server IP address.
PptpTimeout int: Idle timer in minutes (0 for disabled).
PptpUser string: PPTP user name.
PreserveSessionRoute string: Enable/disable preservation of session route when dirty.
Priority int: Priority of the virtual router (1 - 255).
PriorityOverride string: Enable/disable fail back to higher priority port once recovered.
ProxyCaptivePortal string: Enable/disable proxy captive portal on this interface.
ReachableTime int: IPv4 reachable time in milliseconds (30000 - 3600000, default = 30000).
RedundantInterface string: Redundant interface.
RemoteIp string: Remote IP address of tunnel.
ReplacemsgOverrideGroup string: Replacement message override group.
RingRx int: RX ring size.
RingTx int: TX ring size.
Role string: Interface role.
SampleDirection string: Data that NetFlow collects (rx, tx, or both).
SampleRate int: sFlow sample rate (10 - 99999).
ScanBotnetConnections string: Enable monitoring or blocking connections to Botnet servers through this interface.
SecondaryIp string: Enable/disable adding a secondary IP to this interface.
Secondaryips []GetInterfaceSecondaryip: Second IP address of interface. The structure of secondaryip block is documented below.
SecurityExemptList string: Name of security-exempt-list.
SecurityExternalLogout string: URL of external authentication logout server.
SecurityExternalWeb string: URL of external authentication web server.
SecurityGroups []GetInterfaceSecurityGroup: User groups that can authenticate with the captive portal. The structure of security_groups block is documented below.
SecurityMacAuthBypass string: Enable/disable MAC authentication bypass.
SecurityMode string: Turn on captive portal authentication for this interface.
SecurityRedirectUrl string: URL redirection after disclaimer/authentication.
ServiceName string: PPPoE service name.
SflowSampler string: Enable/disable sFlow on this interface.
SnmpIndex int: Permanent SNMP Index of the interface.
Speed string: Interface speed. The default setting and the options available depend on the interface hardware.
SpilloverThreshold int: Egress Spillover threshold (0 - 16776000 kbps), 0 means unlimited.
SrcCheck string: Enable/disable source IP check.
Status string: Enable/disable VRRP.
Stp string: Enable/disable STP.
StpHaSecondary string: Control STP behaviour on HA secondary.
Stpforward string: Enable/disable STP forwarding.
StpforwardMode string: Configure STP forwarding mode.
Subst string: Enable to always send packets from this interface to a destination MAC address.
SubstituteDstMac string: Destination MAC address that all packets are sent to from this interface.
SwcFirstCreate int: Initial create for switch-controller VLANs.
SwcVlan int: Creation status for switch-controller VLANs.
Switch string: Contained in switch.
SwitchControllerAccessVlan string: Block FortiSwitch port-to-port traffic.
SwitchControllerArpInspection string: Enable/disable FortiSwitch ARP inspection.
SwitchControllerDhcpSnooping string: Switch controller DHCP snooping.
SwitchControllerDhcpSnoopingOption82 string: Switch controller DHCP snooping option82.
SwitchControllerDhcpSnoopingVerifyMac string: Switch controller DHCP snooping verify MAC.
SwitchControllerDynamic string: Integrated FortiLink settings for managed FortiSwitch.
SwitchControllerFeature string: Interface's purpose when assigning traffic (read only).
SwitchControllerIgmpSnooping string: Switch controller IGMP snooping.
SwitchControllerIgmpSnoopingFastLeave string: Switch controller IGMP snooping fast-leave.
SwitchControllerIgmpSnoopingProxy string: Switch controller IGMP snooping proxy.
SwitchControllerIotScanning string: Enable/disable managed FortiSwitch IoT scanning.
SwitchControllerLearningLimit int: Limit the number of dynamic MAC addresses on this VLAN (1 - 128, 0 = no limit, default).
SwitchControllerMgmtVlan int: VLAN to use for FortiLink management purposes.
SwitchControllerNac string: Integrated NAC settings for managed FortiSwitch.
SwitchControllerNetflowCollect string: NetFlow collection and processing.
SwitchControllerOffload string: Enable/disable managed FortiSwitch routing offload.
SwitchControllerOffloadGw string: Enable/disable managed FortiSwitch routing offload gateway.
SwitchControllerOffloadIp string: IP for routing offload on FortiSwitch.
SwitchControllerRspanMode string: Stop Layer2 MAC learning and interception of BPDUs and other packets on this interface.
SwitchControllerSourceIp string: Source IP address used in FortiLink over L3 connections.
SwitchControllerTrafficPolicy string: Switch controller traffic policy for the VLAN.
SystemId string: Define a system ID for the aggregate interface.
SystemIdType string: Method in which system ID is generated.
Taggings []GetInterfaceTagging: Config object tagging. The structure of tagging block is documented below.
TcpMss int: TCP maximum segment size. 0 means do not change segment size.
Trunk string: Enable/disable VLAN trunk.
TrustIp1 string: Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
TrustIp2 string: Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
TrustIp3 string: Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
TrustIp61 string: Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
TrustIp62 string: Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
TrustIp63 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.
VlanProtocol 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.
VrrpVirtualMac string: Enable/disable use of virtual MAC for VRRP.
Vrrps []GetInterfaceVrrp: 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).
WinsIp string: WINS server IP.
Vdomparam string

acName String: PPPoE server name.
aggregate String: Aggregate interface.
aggregateType 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.
apDiscover String: Enable/disable automatic registration of unknown FortiAP devices.
arpforward String: Enable/disable ARP forwarding.
authCert String: HTTPS server certificate.
authPortalAddr String: Address of captive portal.
authType String: PPP authentication type to use.
autoAuthExtensionDevice String: Enable/disable automatic authorization of dedicated Fortinet extension device on this interface.
bandwidthMeasureTime Integer: Bandwidth measure time
bfd String: Bidirectional Forwarding Detection (BFD) settings.
bfdDesiredMinTx Integer: BFD desired minimal transmit interval.
bfdDetectMult Integer: BFD detection multiplier.
bfdRequiredMinRx Integer: BFD required minimal receive interval.
broadcastForticlientDiscovery String: Enable/disable broadcasting FortiClient discovery messages.
broadcastForward String: Enable/disable broadcast forwarding.
captivePortal Integer: Enable/disable captive portal.
cliConnStatus Integer: CLI connection status.
clientOptions List<GetInterfaceClientOption>: DHCP client options. The structure of client_options block is documented below.
color Integer: Color of icon on the GUI.
dedicatedTo String: Configure interface for single purpose.
defaultPurdueLevel String: 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.
detectedPeerMtu Integer: MTU of detected peer (0 - 4294967295).
detectprotocol String: Protocols used to detect the server.
detectserver String: Gateway's ping server for this IP.
deviceAccessList String: Device access list.
deviceIdentification String: Enable/disable passively gathering of device identity information about the devices on the network connected to this interface.
deviceIdentificationActiveScan String: Enable/disable active gathering of device identity information about the devices on the network connected to this interface.
deviceNetscan String: Enable/disable inclusion of devices detected on this interface in network vulnerability scans.
deviceUserIdentification String: Enable/disable passive gathering of user identity information about users on this interface.
devindex Integer: Device Index.
dhcpBroadcastFlag String: Enable/disable setting of the broadcast flag in messages sent by the DHCP client (default = enable).
dhcpClasslessRouteAddition String: Enable/disable addition of classless static routes retrieved from DHCP server.
dhcpClientIdentifier String: DHCP client identifier.
dhcpRelayAgentOption String: Enable/disable DHCP relay agent option.
dhcpRelayAllowNoEndOption String: Enable/disable relaying DHCP messages with no end option.
dhcpRelayCircuitId String: DHCP relay circuit ID.
dhcpRelayInterface String: Specify outgoing interface to reach server.
dhcpRelayInterfaceSelectMethod String: Specify how to select outgoing interface to reach server.
dhcpRelayIp String: DHCP relay IP address.
dhcpRelayLinkSelection String: DHCP relay link selection.
dhcpRelayRequestAllServer String: Enable/disable sending DHCP request to all servers.
dhcpRelayService String: Enable/disable allowing this interface to act as a DHCP relay.
dhcpRelaySourceIp String: IP address used by the DHCP relay as its source IP.
dhcpRelayType String: DHCP relay type (regular or IPsec).
dhcpRenewTime Integer: DHCP renew time in seconds (300-604800), 0 means use the renew time provided by the server.
dhcpSmartRelay String: Enable/disable DHCP smart relay.
dhcpSnoopingServerLists List<GetInterfaceDhcpSnoopingServerList>: Configure DHCP server access list. The structure of dhcp_snooping_server_list block is documented below.
discRetryTimeout Integer: Time in seconds to wait before retrying to start a PPPoE discovery, 0 means no timeout.
disconnectThreshold 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.
dnsServerOverride String: Enable/disable use DNS acquired by DHCP or PPPoE.
dnsServerProtocol String: DNS transport protocols.
dropFragment String: Enable/disable drop fragment packets.
dropOverlappedFragment String: Enable/disable drop overlapped fragment packets.
eapCaCert String: EAP CA certificate name.
eapIdentity String: EAP identity.
eapMethod String: EAP method.
eapPassword String: EAP password.
eapSupplicant String: Enable/disable EAP-Supplicant.
eapUserCert String: EAP user certificate name.
egressShapingProfile String: Outgoing traffic shaping profile.
endpointCompliance String: Enable/disable endpoint compliance enforcement.
estimatedDownstreamBandwidth Integer: Estimated maximum downstream bandwidth (kbps). Used to estimate link utilization.
estimatedUpstreamBandwidth Integer: Estimated maximum upstream bandwidth (kbps). Used to estimate link utilization.
explicitFtpProxy String: Enable/disable the explicit FTP proxy on this interface.
explicitWebProxy String: 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).
failActionOnExtender String: Action on extender when interface fail .
failAlertInterfaces List<GetInterfaceFailAlertInterface>: 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.
failAlertMethod String: Select link-failed-signal or link-down method to alert about a failed link.
failDetect String: Enable/disable fail detection features for this interface.
failDetectOption String: 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.
fortilinkBackupLink Integer: fortilink split interface backup link.
fortilinkNeighborDetect String: Protocol for FortiGate neighbor discovery.
fortilinkSplitInterface String: Enable/disable FortiLink split interface to connect member link to different FortiSwitch in stack for uplink redundancy.
fortilinkStacking String: Enable/disable FortiLink switch-stacking on this interface.
forwardDomain Integer: Transparent mode forward domain.
forwardErrorCorrection String: Configure forward error correction (FEC).
gwdetect String: Enable/disable detect gateway alive for first.
haPriority Integer: HA election priority for the PING server.
icmpAcceptRedirect String: Enable/disable ICMP accept redirect.
icmpSendRedirect String: Enable/disable ICMP send redirect.
id String: The provider-assigned unique ID for this managed resource.
identAccept String: Enable/disable authentication for this interface.
idleTimeout Integer: PPPoE auto disconnect after idle timeout seconds, 0 means no timeout.
ikeSamlServer String: Configure IKE authentication SAML server.
inbandwidth Integer: Bandwidth limit for incoming traffic (0 - 16776000 kbps), 0 means unlimited.
ingressShapingProfile String: Incoming traffic shaping profile.
ingressSpilloverThreshold Integer: Ingress Spillover threshold (0 - 16776000 kbps).
interface_ String: Interface name.
internal Integer: Implicitly created.
ip String: Secondary IP address of the interface.
ipManagedByFortiipam String: Enable/disable automatic IP address assignment of this interface by FortiIPAM.
ipmac String: Enable/disable IP/MAC binding.
ipsSnifferMode String: 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<GetInterfaceIpv6>: IPv6 of interface. The structure of ipv6 block is documented below.
l2forward String: Enable/disable l2 forwarding.
lacpHaSecondary String: LACP HA secondary member.
lacpHaSlave String: LACP HA slave.
lacpMode String: LACP mode.
lacpSpeed String: How often the interface sends LACP messages.
lcpEchoInterval Integer: Time in seconds between PPPoE Link Control Protocol (LCP) echo requests.
lcpMaxEchoFails Integer: Maximum missed LCP echo messages before disconnect.
linkUpDelay Integer: Number of milliseconds to wait before considering a link is up.
lldpNetworkPolicy String: LLDP-MED network policy profile.
lldpReception String: Enable/disable Link Layer Discovery Protocol (LLDP) reception.
lldpTransmission String: Enable/disable Link Layer Discovery Protocol (LLDP) transmission.
macaddr String: Change the interface's MAC address.
managedDevices List<GetInterfaceManagedDevice>: Available when FortiLink is enabled, used for managed devices through FortiLink interface. The structure of managed_device block is documented below.
managedSubnetworkSize String: Number of IP addresses to be allocated by FortiIPAM and used by this FortiGate unit's DHCP server settings.
managementIp String: High Availability in-band management IP address of this interface.
measuredDownstreamBandwidth Integer: Measured downstream bandwidth (kbps).
measuredUpstreamBandwidth Integer: Measured upstream bandwidth (kbps).
mediatype String: Select SFP media interface type
members List<GetInterfaceMember>: Physical interfaces that belong to the aggregate or redundant interface. The structure of member block is documented below.
minLinks Integer: Minimum number of aggregated ports that must be up.
minLinksDown String: Action to take when less than the configured minimum number of links are active.
mode String: Addressing mode (static, DHCP, PPPoE).
monitorBandwidth String: Enable monitoring bandwidth on this interface.
mtu Integer: MTU value for this interface.
mtuOverride String: Enable to set a custom MTU for this interface.
name String: Tag name.
ndiscforward String: Enable/disable NDISC forwarding.
netbiosForward String: Enable/disable NETBIOS forwarding.
netflowSampler 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).
padtRetryTimeout Integer: PPPoE Active Discovery Terminate (PADT) used to terminate sessions after an idle time.
password String: PPPoE account's password.
pingServStatus Integer: PING server status.
pollingInterval Integer: sFlow polling interval (1 - 255 sec).
pppoeUnnumberedNegotiate String: Enable/disable PPPoE unnumbered negotiation.
pptpAuthType String: PPTP authentication type.
pptpClient String: Enable/disable PPTP client.
pptpPassword String: PPTP password.
pptpServerIp String: PPTP server IP address.
pptpTimeout Integer: Idle timer in minutes (0 for disabled).
pptpUser String: PPTP user name.
preserveSessionRoute String: Enable/disable preservation of session route when dirty.
priority Integer: Priority of the virtual router (1 - 255).
priorityOverride String: Enable/disable fail back to higher priority port once recovered.
proxyCaptivePortal String: Enable/disable proxy captive portal on this interface.
reachableTime Integer: IPv4 reachable time in milliseconds (30000 - 3600000, default = 30000).
redundantInterface String: Redundant interface.
remoteIp String: Remote IP address of tunnel.
replacemsgOverrideGroup String: Replacement message override group.
ringRx Integer: RX ring size.
ringTx Integer: TX ring size.
role String: Interface role.
sampleDirection String: Data that NetFlow collects (rx, tx, or both).
sampleRate Integer: sFlow sample rate (10 - 99999).
scanBotnetConnections String: Enable monitoring or blocking connections to Botnet servers through this interface.
secondaryIp String: Enable/disable adding a secondary IP to this interface.
secondaryips List<GetInterfaceSecondaryip>: Second IP address of interface. The structure of secondaryip block is documented below.
securityExemptList String: Name of security-exempt-list.
securityExternalLogout String: URL of external authentication logout server.
securityExternalWeb String: URL of external authentication web server.
securityGroups List<GetInterfaceSecurityGroup>: User groups that can authenticate with the captive portal. The structure of security_groups block is documented below.
securityMacAuthBypass String: Enable/disable MAC authentication bypass.
securityMode String: Turn on captive portal authentication for this interface.
securityRedirectUrl String: URL redirection after disclaimer/authentication.
serviceName String: PPPoE service name.
sflowSampler String: Enable/disable sFlow on this interface.
snmpIndex Integer: Permanent SNMP Index of the interface.
speed String: Interface speed. The default setting and the options available depend on the interface hardware.
spilloverThreshold Integer: Egress Spillover threshold (0 - 16776000 kbps), 0 means unlimited.
srcCheck String: Enable/disable source IP check.
status String: Enable/disable VRRP.
stp String: Enable/disable STP.
stpHaSecondary String: Control STP behaviour on HA secondary.
stpforward String: Enable/disable STP forwarding.
stpforwardMode String: Configure STP forwarding mode.
subst String: Enable to always send packets from this interface to a destination MAC address.
substituteDstMac String: Destination MAC address that all packets are sent to from this interface.
swcFirstCreate Integer: Initial create for switch-controller VLANs.
swcVlan Integer: Creation status for switch-controller VLANs.
switchControllerAccessVlan String: Block FortiSwitch port-to-port traffic.
switchControllerArpInspection String: Enable/disable FortiSwitch ARP inspection.
switchControllerDhcpSnooping String: Switch controller DHCP snooping.
switchControllerDhcpSnoopingOption82 String: Switch controller DHCP snooping option82.
switchControllerDhcpSnoopingVerifyMac String: Switch controller DHCP snooping verify MAC.
switchControllerDynamic String: Integrated FortiLink settings for managed FortiSwitch.
switchControllerFeature String: Interface's purpose when assigning traffic (read only).
switchControllerIgmpSnooping String: Switch controller IGMP snooping.
switchControllerIgmpSnoopingFastLeave String: Switch controller IGMP snooping fast-leave.
switchControllerIgmpSnoopingProxy String: Switch controller IGMP snooping proxy.
switchControllerIotScanning String: Enable/disable managed FortiSwitch IoT scanning.
switchControllerLearningLimit Integer: Limit the number of dynamic MAC addresses on this VLAN (1 - 128, 0 = no limit, default).
switchControllerMgmtVlan Integer: VLAN to use for FortiLink management purposes.
switchControllerNac String: Integrated NAC settings for managed FortiSwitch.
switchControllerNetflowCollect String: NetFlow collection and processing.
switchControllerOffload String: Enable/disable managed FortiSwitch routing offload.
switchControllerOffloadGw String: Enable/disable managed FortiSwitch routing offload gateway.
switchControllerOffloadIp String: IP for routing offload on FortiSwitch.
switchControllerRspanMode String: Stop Layer2 MAC learning and interception of BPDUs and other packets on this interface.
switchControllerSourceIp String: Source IP address used in FortiLink over L3 connections.
switchControllerTrafficPolicy String: Switch controller traffic policy for the VLAN.
switch_ String: Contained in switch.
systemId String: Define a system ID for the aggregate interface.
systemIdType String: Method in which system ID is generated.
taggings List<GetInterfaceTagging>: Config object tagging. The structure of tagging block is documented below.
tcpMss Integer: TCP maximum segment size. 0 means do not change segment size.
trunk String: Enable/disable VLAN trunk.
trustIp1 String: Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
trustIp2 String: Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
trustIp3 String: Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
trustIp61 String: Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
trustIp62 String: Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
trustIp63 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.
vlanProtocol 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.
vrrpVirtualMac String: Enable/disable use of virtual MAC for VRRP.
vrrps List<GetInterfaceVrrp>: 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).
winsIp String: WINS server IP.
vdomparam String

acName string: PPPoE server name.
aggregate string: Aggregate interface.
aggregateType 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.
apDiscover string: Enable/disable automatic registration of unknown FortiAP devices.
arpforward string: Enable/disable ARP forwarding.
authCert string: HTTPS server certificate.
authPortalAddr string: Address of captive portal.
authType string: PPP authentication type to use.
autoAuthExtensionDevice string: Enable/disable automatic authorization of dedicated Fortinet extension device on this interface.
bandwidthMeasureTime number: Bandwidth measure time
bfd string: Bidirectional Forwarding Detection (BFD) settings.
bfdDesiredMinTx number: BFD desired minimal transmit interval.
bfdDetectMult number: BFD detection multiplier.
bfdRequiredMinRx number: BFD required minimal receive interval.
broadcastForticlientDiscovery string: Enable/disable broadcasting FortiClient discovery messages.
broadcastForward string: Enable/disable broadcast forwarding.
captivePortal number: Enable/disable captive portal.
cliConnStatus number: CLI connection status.
clientOptions GetInterfaceClientOption[]: DHCP client options. The structure of client_options block is documented below.
color number: Color of icon on the GUI.
dedicatedTo string: Configure interface for single purpose.
defaultPurdueLevel string: 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.
detectedPeerMtu number: MTU of detected peer (0 - 4294967295).
detectprotocol string: Protocols used to detect the server.
detectserver string: Gateway's ping server for this IP.
deviceAccessList string: Device access list.
deviceIdentification string: Enable/disable passively gathering of device identity information about the devices on the network connected to this interface.
deviceIdentificationActiveScan string: Enable/disable active gathering of device identity information about the devices on the network connected to this interface.
deviceNetscan string: Enable/disable inclusion of devices detected on this interface in network vulnerability scans.
deviceUserIdentification string: Enable/disable passive gathering of user identity information about users on this interface.
devindex number: Device Index.
dhcpBroadcastFlag string: Enable/disable setting of the broadcast flag in messages sent by the DHCP client (default = enable).
dhcpClasslessRouteAddition string: Enable/disable addition of classless static routes retrieved from DHCP server.
dhcpClientIdentifier string: DHCP client identifier.
dhcpRelayAgentOption string: Enable/disable DHCP relay agent option.
dhcpRelayAllowNoEndOption string: Enable/disable relaying DHCP messages with no end option.
dhcpRelayCircuitId string: DHCP relay circuit ID.
dhcpRelayInterface string: Specify outgoing interface to reach server.
dhcpRelayInterfaceSelectMethod string: Specify how to select outgoing interface to reach server.
dhcpRelayIp string: DHCP relay IP address.
dhcpRelayLinkSelection string: DHCP relay link selection.
dhcpRelayRequestAllServer string: Enable/disable sending DHCP request to all servers.
dhcpRelayService string: Enable/disable allowing this interface to act as a DHCP relay.
dhcpRelaySourceIp string: IP address used by the DHCP relay as its source IP.
dhcpRelayType string: DHCP relay type (regular or IPsec).
dhcpRenewTime number: DHCP renew time in seconds (300-604800), 0 means use the renew time provided by the server.
dhcpSmartRelay string: Enable/disable DHCP smart relay.
dhcpSnoopingServerLists GetInterfaceDhcpSnoopingServerList[]: Configure DHCP server access list. The structure of dhcp_snooping_server_list block is documented below.
discRetryTimeout number: Time in seconds to wait before retrying to start a PPPoE discovery, 0 means no timeout.
disconnectThreshold 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.
dnsServerOverride string: Enable/disable use DNS acquired by DHCP or PPPoE.
dnsServerProtocol string: DNS transport protocols.
dropFragment string: Enable/disable drop fragment packets.
dropOverlappedFragment string: Enable/disable drop overlapped fragment packets.
eapCaCert string: EAP CA certificate name.
eapIdentity string: EAP identity.
eapMethod string: EAP method.
eapPassword string: EAP password.
eapSupplicant string: Enable/disable EAP-Supplicant.
eapUserCert string: EAP user certificate name.
egressShapingProfile string: Outgoing traffic shaping profile.
endpointCompliance string: Enable/disable endpoint compliance enforcement.
estimatedDownstreamBandwidth number: Estimated maximum downstream bandwidth (kbps). Used to estimate link utilization.
estimatedUpstreamBandwidth number: Estimated maximum upstream bandwidth (kbps). Used to estimate link utilization.
explicitFtpProxy string: Enable/disable the explicit FTP proxy on this interface.
explicitWebProxy string: 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).
failActionOnExtender string: Action on extender when interface fail .
failAlertInterfaces GetInterfaceFailAlertInterface[]: 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.
failAlertMethod string: Select link-failed-signal or link-down method to alert about a failed link.
failDetect string: Enable/disable fail detection features for this interface.
failDetectOption string: 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.
fortilinkBackupLink number: fortilink split interface backup link.
fortilinkNeighborDetect string: Protocol for FortiGate neighbor discovery.
fortilinkSplitInterface string: Enable/disable FortiLink split interface to connect member link to different FortiSwitch in stack for uplink redundancy.
fortilinkStacking string: Enable/disable FortiLink switch-stacking on this interface.
forwardDomain number: Transparent mode forward domain.
forwardErrorCorrection string: Configure forward error correction (FEC).
gwdetect string: Enable/disable detect gateway alive for first.
haPriority number: HA election priority for the PING server.
icmpAcceptRedirect string: Enable/disable ICMP accept redirect.
icmpSendRedirect string: Enable/disable ICMP send redirect.
id string: The provider-assigned unique ID for this managed resource.
identAccept string: Enable/disable authentication for this interface.
idleTimeout number: PPPoE auto disconnect after idle timeout seconds, 0 means no timeout.
ikeSamlServer string: Configure IKE authentication SAML server.
inbandwidth number: Bandwidth limit for incoming traffic (0 - 16776000 kbps), 0 means unlimited.
ingressShapingProfile string: Incoming traffic shaping profile.
ingressSpilloverThreshold number: Ingress Spillover threshold (0 - 16776000 kbps).
interface string: Interface name.
internal number: Implicitly created.
ip string: Secondary IP address of the interface.
ipManagedByFortiipam string: Enable/disable automatic IP address assignment of this interface by FortiIPAM.
ipmac string: Enable/disable IP/MAC binding.
ipsSnifferMode string: 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 GetInterfaceIpv6[]: IPv6 of interface. The structure of ipv6 block is documented below.
l2forward string: Enable/disable l2 forwarding.
lacpHaSecondary string: LACP HA secondary member.
lacpHaSlave string: LACP HA slave.
lacpMode string: LACP mode.
lacpSpeed string: How often the interface sends LACP messages.
lcpEchoInterval number: Time in seconds between PPPoE Link Control Protocol (LCP) echo requests.
lcpMaxEchoFails number: Maximum missed LCP echo messages before disconnect.
linkUpDelay number: Number of milliseconds to wait before considering a link is up.
lldpNetworkPolicy string: LLDP-MED network policy profile.
lldpReception string: Enable/disable Link Layer Discovery Protocol (LLDP) reception.
lldpTransmission string: Enable/disable Link Layer Discovery Protocol (LLDP) transmission.
macaddr string: Change the interface's MAC address.
managedDevices GetInterfaceManagedDevice[]: Available when FortiLink is enabled, used for managed devices through FortiLink interface. The structure of managed_device block is documented below.
managedSubnetworkSize string: Number of IP addresses to be allocated by FortiIPAM and used by this FortiGate unit's DHCP server settings.
managementIp string: High Availability in-band management IP address of this interface.
measuredDownstreamBandwidth number: Measured downstream bandwidth (kbps).
measuredUpstreamBandwidth number: Measured upstream bandwidth (kbps).
mediatype string: Select SFP media interface type
members GetInterfaceMember[]: Physical interfaces that belong to the aggregate or redundant interface. The structure of member block is documented below.
minLinks number: Minimum number of aggregated ports that must be up.
minLinksDown string: Action to take when less than the configured minimum number of links are active.
mode string: Addressing mode (static, DHCP, PPPoE).
monitorBandwidth string: Enable monitoring bandwidth on this interface.
mtu number: MTU value for this interface.
mtuOverride string: Enable to set a custom MTU for this interface.
name string: Tag name.
ndiscforward string: Enable/disable NDISC forwarding.
netbiosForward string: Enable/disable NETBIOS forwarding.
netflowSampler 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).
padtRetryTimeout number: PPPoE Active Discovery Terminate (PADT) used to terminate sessions after an idle time.
password string: PPPoE account's password.
pingServStatus number: PING server status.
pollingInterval number: sFlow polling interval (1 - 255 sec).
pppoeUnnumberedNegotiate string: Enable/disable PPPoE unnumbered negotiation.
pptpAuthType string: PPTP authentication type.
pptpClient string: Enable/disable PPTP client.
pptpPassword string: PPTP password.
pptpServerIp string: PPTP server IP address.
pptpTimeout number: Idle timer in minutes (0 for disabled).
pptpUser string: PPTP user name.
preserveSessionRoute string: Enable/disable preservation of session route when dirty.
priority number: Priority of the virtual router (1 - 255).
priorityOverride string: Enable/disable fail back to higher priority port once recovered.
proxyCaptivePortal string: Enable/disable proxy captive portal on this interface.
reachableTime number: IPv4 reachable time in milliseconds (30000 - 3600000, default = 30000).
redundantInterface string: Redundant interface.
remoteIp string: Remote IP address of tunnel.
replacemsgOverrideGroup string: Replacement message override group.
ringRx number: RX ring size.
ringTx number: TX ring size.
role string: Interface role.
sampleDirection string: Data that NetFlow collects (rx, tx, or both).
sampleRate number: sFlow sample rate (10 - 99999).
scanBotnetConnections string: Enable monitoring or blocking connections to Botnet servers through this interface.
secondaryIp string: Enable/disable adding a secondary IP to this interface.
secondaryips GetInterfaceSecondaryip[]: Second IP address of interface. The structure of secondaryip block is documented below.
securityExemptList string: Name of security-exempt-list.
securityExternalLogout string: URL of external authentication logout server.
securityExternalWeb string: URL of external authentication web server.
securityGroups GetInterfaceSecurityGroup[]: User groups that can authenticate with the captive portal. The structure of security_groups block is documented below.
securityMacAuthBypass string: Enable/disable MAC authentication bypass.
securityMode string: Turn on captive portal authentication for this interface.
securityRedirectUrl string: URL redirection after disclaimer/authentication.
serviceName string: PPPoE service name.
sflowSampler string: Enable/disable sFlow on this interface.
snmpIndex number: Permanent SNMP Index of the interface.
speed string: Interface speed. The default setting and the options available depend on the interface hardware.
spilloverThreshold number: Egress Spillover threshold (0 - 16776000 kbps), 0 means unlimited.
srcCheck string: Enable/disable source IP check.
status string: Enable/disable VRRP.
stp string: Enable/disable STP.
stpHaSecondary string: Control STP behaviour on HA secondary.
stpforward string: Enable/disable STP forwarding.
stpforwardMode string: Configure STP forwarding mode.
subst string: Enable to always send packets from this interface to a destination MAC address.
substituteDstMac string: Destination MAC address that all packets are sent to from this interface.
swcFirstCreate number: Initial create for switch-controller VLANs.
swcVlan number: Creation status for switch-controller VLANs.
switch string: Contained in switch.
switchControllerAccessVlan string: Block FortiSwitch port-to-port traffic.
switchControllerArpInspection string: Enable/disable FortiSwitch ARP inspection.
switchControllerDhcpSnooping string: Switch controller DHCP snooping.
switchControllerDhcpSnoopingOption82 string: Switch controller DHCP snooping option82.
switchControllerDhcpSnoopingVerifyMac string: Switch controller DHCP snooping verify MAC.
switchControllerDynamic string: Integrated FortiLink settings for managed FortiSwitch.
switchControllerFeature string: Interface's purpose when assigning traffic (read only).
switchControllerIgmpSnooping string: Switch controller IGMP snooping.
switchControllerIgmpSnoopingFastLeave string: Switch controller IGMP snooping fast-leave.
switchControllerIgmpSnoopingProxy string: Switch controller IGMP snooping proxy.
switchControllerIotScanning string: Enable/disable managed FortiSwitch IoT scanning.
switchControllerLearningLimit number: Limit the number of dynamic MAC addresses on this VLAN (1 - 128, 0 = no limit, default).
switchControllerMgmtVlan number: VLAN to use for FortiLink management purposes.
switchControllerNac string: Integrated NAC settings for managed FortiSwitch.
switchControllerNetflowCollect string: NetFlow collection and processing.
switchControllerOffload string: Enable/disable managed FortiSwitch routing offload.
switchControllerOffloadGw string: Enable/disable managed FortiSwitch routing offload gateway.
switchControllerOffloadIp string: IP for routing offload on FortiSwitch.
switchControllerRspanMode string: Stop Layer2 MAC learning and interception of BPDUs and other packets on this interface.
switchControllerSourceIp string: Source IP address used in FortiLink over L3 connections.
switchControllerTrafficPolicy string: Switch controller traffic policy for the VLAN.
systemId string: Define a system ID for the aggregate interface.
systemIdType string: Method in which system ID is generated.
taggings GetInterfaceTagging[]: Config object tagging. The structure of tagging block is documented below.
tcpMss number: TCP maximum segment size. 0 means do not change segment size.
trunk string: Enable/disable VLAN trunk.
trustIp1 string: Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
trustIp2 string: Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
trustIp3 string: Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
trustIp61 string: Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
trustIp62 string: Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
trustIp63 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.
vlanProtocol 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.
vrrpVirtualMac string: Enable/disable use of virtual MAC for VRRP.
vrrps GetInterfaceVrrp[]: 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).
winsIp 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_addr str: Address of captive portal.
auth_type str: PPP authentication type to use.
auto_auth_extension_device str: Enable/disable automatic authorization of dedicated Fortinet extension device on this interface.
bandwidth_measure_time int: Bandwidth measure time
bfd str: Bidirectional Forwarding Detection (BFD) settings.
bfd_desired_min_tx int: BFD desired minimal transmit interval.
bfd_detect_mult int: BFD detection multiplier.
bfd_required_min_rx int: BFD required minimal receive interval.
broadcast_forticlient_discovery str: Enable/disable broadcasting FortiClient discovery messages.
broadcast_forward str: Enable/disable broadcast forwarding.
captive_portal int: Enable/disable captive portal.
cli_conn_status int: CLI connection status.
client_options Sequence[GetInterfaceClientOption]: 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_level str: 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_mtu int: 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_list str: 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_active_scan str: 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_identification str: Enable/disable passive gathering of user identity information about users on this interface.
devindex int: Device Index.
dhcp_broadcast_flag str: Enable/disable setting of the broadcast flag in messages sent by the DHCP client (default = enable).
dhcp_classless_route_addition str: Enable/disable addition of classless static routes retrieved from DHCP server.
dhcp_client_identifier str: DHCP client identifier.
dhcp_relay_agent_option str: Enable/disable DHCP relay agent option.
dhcp_relay_allow_no_end_option str: Enable/disable relaying DHCP messages with no end option.
dhcp_relay_circuit_id str: DHCP relay circuit ID.
dhcp_relay_interface str: Specify outgoing interface to reach server.
dhcp_relay_interface_select_method str: Specify how to select outgoing interface to reach server.
dhcp_relay_ip str: DHCP relay IP address.
dhcp_relay_link_selection str: DHCP relay link selection.
dhcp_relay_request_all_server str: Enable/disable sending DHCP request to all servers.
dhcp_relay_service str: Enable/disable allowing this interface to act as a DHCP relay.
dhcp_relay_source_ip str: IP address used by the DHCP relay as its source IP.
dhcp_relay_type str: DHCP relay type (regular or IPsec).
dhcp_renew_time int: DHCP renew time in seconds (300-604800), 0 means use the renew time provided by the server.
dhcp_smart_relay str: Enable/disable DHCP smart relay.
dhcp_snooping_server_lists Sequence[GetInterfaceDhcpSnoopingServerList]: Configure DHCP server access list. The structure of dhcp_snooping_server_list block is documented below.
disc_retry_timeout int: 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_override str: Enable/disable use DNS acquired by DHCP or PPPoE.
dns_server_protocol str: DNS transport protocols.
drop_fragment str: Enable/disable drop fragment packets.
drop_overlapped_fragment str: Enable/disable drop overlapped fragment packets.
eap_ca_cert str: 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_cert str: EAP user certificate name.
egress_shaping_profile str: Outgoing traffic shaping profile.
endpoint_compliance str: Enable/disable endpoint compliance enforcement.
estimated_downstream_bandwidth int: Estimated maximum downstream bandwidth (kbps). Used to estimate link utilization.
estimated_upstream_bandwidth int: Estimated maximum upstream bandwidth (kbps). Used to estimate link utilization.
explicit_ftp_proxy str: Enable/disable the explicit FTP proxy on this interface.
explicit_web_proxy str: 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_on_extender str: Action on extender when interface fail .
fail_alert_interfaces Sequence[GetInterfaceFailAlertInterface]: 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_method str: 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_option str: 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_link int: fortilink split interface backup link.
fortilink_neighbor_detect str: Protocol for FortiGate neighbor discovery.
fortilink_split_interface str: 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_correction str: 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_redirect str: Enable/disable ICMP accept redirect.
icmp_send_redirect str: 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_server str: Configure IKE authentication SAML server.
inbandwidth int: Bandwidth limit for incoming traffic (0 - 16776000 kbps), 0 means unlimited.
ingress_shaping_profile str: Incoming traffic shaping profile.
ingress_spillover_threshold int: Ingress Spillover threshold (0 - 16776000 kbps).
interface str: Interface name.
internal int: Implicitly created.
ip str: Secondary IP address of the interface.
ip_managed_by_fortiipam str: Enable/disable automatic IP address assignment of this interface by FortiIPAM.
ipmac str: Enable/disable IP/MAC binding.
ips_sniffer_mode str: 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[GetInterfaceIpv6]: IPv6 of interface. The structure of ipv6 block is documented below.
l2forward str: Enable/disable l2 forwarding.
lacp_ha_secondary str: LACP HA secondary member.
lacp_ha_slave str: LACP HA slave.
lacp_mode str: LACP mode.
lacp_speed str: How often the interface sends LACP messages.
lcp_echo_interval int: Time in seconds between PPPoE Link Control Protocol (LCP) echo requests.
lcp_max_echo_fails int: Maximum missed LCP echo messages before disconnect.
link_up_delay int: Number of milliseconds to wait before considering a link is up.
lldp_network_policy str: 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[GetInterfaceManagedDevice]: Available when FortiLink is enabled, used for managed devices through FortiLink interface. The structure of managed_device block is documented below.
managed_subnetwork_size str: 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_bandwidth int: Measured downstream bandwidth (kbps).
measured_upstream_bandwidth int: Measured upstream bandwidth (kbps).
mediatype str: Select SFP media interface type
members Sequence[GetInterfaceMember]: 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_down str: 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_timeout int: PPPoE Active Discovery Terminate (PADT) used to terminate sessions after an idle time.
password str: PPPoE account's password.
ping_serv_status int: PING server status.
polling_interval int: sFlow polling interval (1 - 255 sec).
pppoe_unnumbered_negotiate str: Enable/disable PPPoE unnumbered negotiation.
pptp_auth_type str: PPTP authentication type.
pptp_client str: Enable/disable PPTP client.
pptp_password str: PPTP password.
pptp_server_ip str: PPTP server IP address.
pptp_timeout int: Idle timer in minutes (0 for disabled).
pptp_user str: PPTP user name.
preserve_session_route str: 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_portal str: 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_group str: 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_connections str: 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[GetInterfaceSecondaryip]: Second IP address of interface. The structure of secondaryip block is documented below.
security_exempt_list str: Name of security-exempt-list.
security_external_logout str: URL of external authentication logout server.
security_external_web str: URL of external authentication web server.
security_groups Sequence[GetInterfaceSecurityGroup]: User groups that can authenticate with the captive portal. The structure of security_groups block is documented below.
security_mac_auth_bypass str: Enable/disable MAC authentication bypass.
security_mode str: Turn on captive portal authentication for this interface.
security_redirect_url str: 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_secondary str: 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_mac str: Destination MAC address that all packets are sent to from this interface.
swc_first_create int: Initial create for switch-controller VLANs.
swc_vlan int: Creation status for switch-controller VLANs.
switch str: Contained in switch.
switch_controller_access_vlan str: Block FortiSwitch port-to-port traffic.
switch_controller_arp_inspection str: Enable/disable FortiSwitch ARP inspection.
switch_controller_dhcp_snooping str: Switch controller DHCP snooping.
switch_controller_dhcp_snooping_option82 str: Switch controller DHCP snooping option82.
switch_controller_dhcp_snooping_verify_mac str: Switch controller DHCP snooping verify MAC.
switch_controller_dynamic str: Integrated FortiLink settings for managed FortiSwitch.
switch_controller_feature str: Interface's purpose when assigning traffic (read only).
switch_controller_igmp_snooping str: Switch controller IGMP snooping.
switch_controller_igmp_snooping_fast_leave str: Switch controller IGMP snooping fast-leave.
switch_controller_igmp_snooping_proxy str: Switch controller IGMP snooping proxy.
switch_controller_iot_scanning str: Enable/disable managed FortiSwitch IoT scanning.
switch_controller_learning_limit int: Limit the number of dynamic MAC addresses on this VLAN (1 - 128, 0 = no limit, default).
switch_controller_mgmt_vlan int: VLAN to use for FortiLink management purposes.
switch_controller_nac str: Integrated NAC settings for managed FortiSwitch.
switch_controller_netflow_collect str: NetFlow collection and processing.
switch_controller_offload str: Enable/disable managed FortiSwitch routing offload.
switch_controller_offload_gw str: Enable/disable managed FortiSwitch routing offload gateway.
switch_controller_offload_ip str: IP for routing offload on FortiSwitch.
switch_controller_rspan_mode str: Stop Layer2 MAC learning and interception of BPDUs and other packets on this interface.
switch_controller_source_ip str: Source IP address used in FortiLink over L3 connections.
switch_controller_traffic_policy str: Switch controller traffic policy for the VLAN.
system_id str: Define a system ID for the aggregate interface.
system_id_type str: Method in which system ID is generated.
taggings Sequence[GetInterfaceTagging]: 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_mac str: Enable/disable use of virtual MAC for VRRP.
vrrps Sequence[GetInterfaceVrrp]: 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

acName String: PPPoE server name.
aggregate String: Aggregate interface.
aggregateType 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.
apDiscover String: Enable/disable automatic registration of unknown FortiAP devices.
arpforward String: Enable/disable ARP forwarding.
authCert String: HTTPS server certificate.
authPortalAddr String: Address of captive portal.
authType String: PPP authentication type to use.
autoAuthExtensionDevice String: Enable/disable automatic authorization of dedicated Fortinet extension device on this interface.
bandwidthMeasureTime Number: Bandwidth measure time
bfd String: Bidirectional Forwarding Detection (BFD) settings.
bfdDesiredMinTx Number: BFD desired minimal transmit interval.
bfdDetectMult Number: BFD detection multiplier.
bfdRequiredMinRx Number: BFD required minimal receive interval.
broadcastForticlientDiscovery String: Enable/disable broadcasting FortiClient discovery messages.
broadcastForward String: Enable/disable broadcast forwarding.
captivePortal Number: Enable/disable captive portal.
cliConnStatus Number: CLI connection status.
clientOptions List<Property Map>: DHCP client options. The structure of client_options block is documented below.
color Number: Color of icon on the GUI.
dedicatedTo String: Configure interface for single purpose.
defaultPurdueLevel String: 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.
detectedPeerMtu Number: MTU of detected peer (0 - 4294967295).
detectprotocol String: Protocols used to detect the server.
detectserver String: Gateway's ping server for this IP.
deviceAccessList String: Device access list.
deviceIdentification String: Enable/disable passively gathering of device identity information about the devices on the network connected to this interface.
deviceIdentificationActiveScan String: Enable/disable active gathering of device identity information about the devices on the network connected to this interface.
deviceNetscan String: Enable/disable inclusion of devices detected on this interface in network vulnerability scans.
deviceUserIdentification String: Enable/disable passive gathering of user identity information about users on this interface.
devindex Number: Device Index.
dhcpBroadcastFlag String: Enable/disable setting of the broadcast flag in messages sent by the DHCP client (default = enable).
dhcpClasslessRouteAddition String: Enable/disable addition of classless static routes retrieved from DHCP server.
dhcpClientIdentifier String: DHCP client identifier.
dhcpRelayAgentOption String: Enable/disable DHCP relay agent option.
dhcpRelayAllowNoEndOption String: Enable/disable relaying DHCP messages with no end option.
dhcpRelayCircuitId String: DHCP relay circuit ID.
dhcpRelayInterface String: Specify outgoing interface to reach server.
dhcpRelayInterfaceSelectMethod String: Specify how to select outgoing interface to reach server.
dhcpRelayIp String: DHCP relay IP address.
dhcpRelayLinkSelection String: DHCP relay link selection.
dhcpRelayRequestAllServer String: Enable/disable sending DHCP request to all servers.
dhcpRelayService String: Enable/disable allowing this interface to act as a DHCP relay.
dhcpRelaySourceIp String: IP address used by the DHCP relay as its source IP.
dhcpRelayType String: DHCP relay type (regular or IPsec).
dhcpRenewTime Number: DHCP renew time in seconds (300-604800), 0 means use the renew time provided by the server.
dhcpSmartRelay String: Enable/disable DHCP smart relay.
dhcpSnoopingServerLists List<Property Map>: Configure DHCP server access list. The structure of dhcp_snooping_server_list block is documented below.
discRetryTimeout Number: Time in seconds to wait before retrying to start a PPPoE discovery, 0 means no timeout.
disconnectThreshold 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.
dnsServerOverride String: Enable/disable use DNS acquired by DHCP or PPPoE.
dnsServerProtocol String: DNS transport protocols.
dropFragment String: Enable/disable drop fragment packets.
dropOverlappedFragment String: Enable/disable drop overlapped fragment packets.
eapCaCert String: EAP CA certificate name.
eapIdentity String: EAP identity.
eapMethod String: EAP method.
eapPassword String: EAP password.
eapSupplicant String: Enable/disable EAP-Supplicant.
eapUserCert String: EAP user certificate name.
egressShapingProfile String: Outgoing traffic shaping profile.
endpointCompliance String: Enable/disable endpoint compliance enforcement.
estimatedDownstreamBandwidth Number: Estimated maximum downstream bandwidth (kbps). Used to estimate link utilization.
estimatedUpstreamBandwidth Number: Estimated maximum upstream bandwidth (kbps). Used to estimate link utilization.
explicitFtpProxy String: Enable/disable the explicit FTP proxy on this interface.
explicitWebProxy String: 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).
failActionOnExtender String: Action on extender when interface fail .
failAlertInterfaces List<Property Map>: 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.
failAlertMethod String: Select link-failed-signal or link-down method to alert about a failed link.
failDetect String: Enable/disable fail detection features for this interface.
failDetectOption String: 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.
fortilinkBackupLink Number: fortilink split interface backup link.
fortilinkNeighborDetect String: Protocol for FortiGate neighbor discovery.
fortilinkSplitInterface String: Enable/disable FortiLink split interface to connect member link to different FortiSwitch in stack for uplink redundancy.
fortilinkStacking String: Enable/disable FortiLink switch-stacking on this interface.
forwardDomain Number: Transparent mode forward domain.
forwardErrorCorrection String: Configure forward error correction (FEC).
gwdetect String: Enable/disable detect gateway alive for first.
haPriority Number: HA election priority for the PING server.
icmpAcceptRedirect String: Enable/disable ICMP accept redirect.
icmpSendRedirect String: Enable/disable ICMP send redirect.
id String: The provider-assigned unique ID for this managed resource.
identAccept String: Enable/disable authentication for this interface.
idleTimeout Number: PPPoE auto disconnect after idle timeout seconds, 0 means no timeout.
ikeSamlServer String: Configure IKE authentication SAML server.
inbandwidth Number: Bandwidth limit for incoming traffic (0 - 16776000 kbps), 0 means unlimited.
ingressShapingProfile String: Incoming traffic shaping profile.
ingressSpilloverThreshold Number: Ingress Spillover threshold (0 - 16776000 kbps).
interface String: Interface name.
internal Number: Implicitly created.
ip String: Secondary IP address of the interface.
ipManagedByFortiipam String: Enable/disable automatic IP address assignment of this interface by FortiIPAM.
ipmac String: Enable/disable IP/MAC binding.
ipsSnifferMode String: 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.
lacpHaSecondary String: LACP HA secondary member.
lacpHaSlave String: LACP HA slave.
lacpMode String: LACP mode.
lacpSpeed String: How often the interface sends LACP messages.
lcpEchoInterval Number: Time in seconds between PPPoE Link Control Protocol (LCP) echo requests.
lcpMaxEchoFails Number: Maximum missed LCP echo messages before disconnect.
linkUpDelay Number: Number of milliseconds to wait before considering a link is up.
lldpNetworkPolicy String: LLDP-MED network policy profile.
lldpReception String: Enable/disable Link Layer Discovery Protocol (LLDP) reception.
lldpTransmission String: Enable/disable Link Layer Discovery Protocol (LLDP) transmission.
macaddr String: Change the interface's MAC address.
managedDevices List<Property Map>: Available when FortiLink is enabled, used for managed devices through FortiLink interface. The structure of managed_device block is documented below.
managedSubnetworkSize String: Number of IP addresses to be allocated by FortiIPAM and used by this FortiGate unit's DHCP server settings.
managementIp String: High Availability in-band management IP address of this interface.
measuredDownstreamBandwidth Number: Measured downstream bandwidth (kbps).
measuredUpstreamBandwidth Number: 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.
minLinks Number: Minimum number of aggregated ports that must be up.
minLinksDown String: Action to take when less than the configured minimum number of links are active.
mode String: Addressing mode (static, DHCP, PPPoE).
monitorBandwidth String: Enable monitoring bandwidth on this interface.
mtu Number: MTU value for this interface.
mtuOverride String: Enable to set a custom MTU for this interface.
name String: Tag name.
ndiscforward String: Enable/disable NDISC forwarding.
netbiosForward String: Enable/disable NETBIOS forwarding.
netflowSampler 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).
padtRetryTimeout Number: PPPoE Active Discovery Terminate (PADT) used to terminate sessions after an idle time.
password String: PPPoE account's password.
pingServStatus Number: PING server status.
pollingInterval Number: sFlow polling interval (1 - 255 sec).
pppoeUnnumberedNegotiate String: Enable/disable PPPoE unnumbered negotiation.
pptpAuthType String: PPTP authentication type.
pptpClient String: Enable/disable PPTP client.
pptpPassword String: PPTP password.
pptpServerIp String: PPTP server IP address.
pptpTimeout Number: Idle timer in minutes (0 for disabled).
pptpUser String: PPTP user name.
preserveSessionRoute String: Enable/disable preservation of session route when dirty.
priority Number: Priority of the virtual router (1 - 255).
priorityOverride String: Enable/disable fail back to higher priority port once recovered.
proxyCaptivePortal String: Enable/disable proxy captive portal on this interface.
reachableTime Number: IPv4 reachable time in milliseconds (30000 - 3600000, default = 30000).
redundantInterface String: Redundant interface.
remoteIp String: Remote IP address of tunnel.
replacemsgOverrideGroup String: Replacement message override group.
ringRx Number: RX ring size.
ringTx Number: TX ring size.
role String: Interface role.
sampleDirection String: Data that NetFlow collects (rx, tx, or both).
sampleRate Number: sFlow sample rate (10 - 99999).
scanBotnetConnections String: Enable monitoring or blocking connections to Botnet servers through this interface.
secondaryIp 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.
securityExemptList String: Name of security-exempt-list.
securityExternalLogout String: URL of external authentication logout server.
securityExternalWeb String: URL of external authentication web server.
securityGroups List<Property Map>: User groups that can authenticate with the captive portal. The structure of security_groups block is documented below.
securityMacAuthBypass String: Enable/disable MAC authentication bypass.
securityMode String: Turn on captive portal authentication for this interface.
securityRedirectUrl String: URL redirection after disclaimer/authentication.
serviceName String: PPPoE service name.
sflowSampler String: Enable/disable sFlow on this interface.
snmpIndex Number: Permanent SNMP Index of the interface.
speed String: Interface speed. The default setting and the options available depend on the interface hardware.
spilloverThreshold Number: Egress Spillover threshold (0 - 16776000 kbps), 0 means unlimited.
srcCheck String: Enable/disable source IP check.
status String: Enable/disable VRRP.
stp String: Enable/disable STP.
stpHaSecondary String: Control STP behaviour on HA secondary.
stpforward String: Enable/disable STP forwarding.
stpforwardMode String: Configure STP forwarding mode.
subst String: Enable to always send packets from this interface to a destination MAC address.
substituteDstMac String: Destination MAC address that all packets are sent to from this interface.
swcFirstCreate Number: Initial create for switch-controller VLANs.
swcVlan Number: Creation status for switch-controller VLANs.
switch String: Contained in switch.
switchControllerAccessVlan String: Block FortiSwitch port-to-port traffic.
switchControllerArpInspection String: Enable/disable FortiSwitch ARP inspection.
switchControllerDhcpSnooping String: Switch controller DHCP snooping.
switchControllerDhcpSnoopingOption82 String: Switch controller DHCP snooping option82.
switchControllerDhcpSnoopingVerifyMac String: Switch controller DHCP snooping verify MAC.
switchControllerDynamic String: Integrated FortiLink settings for managed FortiSwitch.
switchControllerFeature String: Interface's purpose when assigning traffic (read only).
switchControllerIgmpSnooping String: Switch controller IGMP snooping.
switchControllerIgmpSnoopingFastLeave String: Switch controller IGMP snooping fast-leave.
switchControllerIgmpSnoopingProxy String: Switch controller IGMP snooping proxy.
switchControllerIotScanning String: Enable/disable managed FortiSwitch IoT scanning.
switchControllerLearningLimit Number: Limit the number of dynamic MAC addresses on this VLAN (1 - 128, 0 = no limit, default).
switchControllerMgmtVlan Number: VLAN to use for FortiLink management purposes.
switchControllerNac String: Integrated NAC settings for managed FortiSwitch.
switchControllerNetflowCollect String: NetFlow collection and processing.
switchControllerOffload String: Enable/disable managed FortiSwitch routing offload.
switchControllerOffloadGw String: Enable/disable managed FortiSwitch routing offload gateway.
switchControllerOffloadIp String: IP for routing offload on FortiSwitch.
switchControllerRspanMode String: Stop Layer2 MAC learning and interception of BPDUs and other packets on this interface.
switchControllerSourceIp String: Source IP address used in FortiLink over L3 connections.
switchControllerTrafficPolicy String: Switch controller traffic policy for the VLAN.
systemId String: Define a system ID for the aggregate interface.
systemIdType String: Method in which system ID is generated.
taggings List<Property Map>: Config object tagging. The structure of tagging block is documented below.
tcpMss Number: TCP maximum segment size. 0 means do not change segment size.
trunk String: Enable/disable VLAN trunk.
trustIp1 String: Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
trustIp2 String: Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
trustIp3 String: Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts).
trustIp61 String: Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
trustIp62 String: Trusted IPv6 host for dedicated management traffic (::/0 for all hosts).
trustIp63 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.
vlanProtocol 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.
vrrpVirtualMac String: 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).
winsIp String: WINS server IP.
vdomparam String

Supporting Types

GetInterfaceClientOption

Code int: DHCP client option code.
Id int: ID.
Ip string: Secondary IP address of the interface.
Type string: DHCP client option type.
Value string: DHCP client option value.

Code int: DHCP client option code.
Id int: ID.
Ip string: Secondary IP address of the interface.
Type string: DHCP client option type.
Value string: DHCP client option value.

code Integer: DHCP client option code.
id Integer: ID.
ip String: Secondary IP address of the interface.
type String: DHCP client option type.
value String: DHCP client option value.

code number: DHCP client option code.
id number: ID.
ip string: Secondary IP address of the interface.
type string: DHCP client option type.
value string: DHCP client option value.

code int: DHCP client option code.
id int: ID.
ip str: Secondary IP address of the interface.
type str: DHCP client option type.
value str: DHCP client option value.

code Number: DHCP client option code.
id Number: ID.
ip String: Secondary IP address of the interface.
type String: DHCP client option type.
value String: DHCP client option value.

GetInterfaceDhcpSnoopingServerList

Name string: Specify the name of the desired system interface.
ServerIp string: IP address for DHCP server.

Name string: Specify the name of the desired system interface.
ServerIp string: IP address for DHCP server.

name String: Specify the name of the desired system interface.
serverIp String: IP address for DHCP server.

name string: Specify the name of the desired system interface.
serverIp string: IP address for DHCP server.

name str: Specify the name of the desired system interface.
server_ip str: IP address for DHCP server.

name String: Specify the name of the desired system interface.
serverIp String: IP address for DHCP server.

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.
CliConn6Status int: CLI IPv6 connection status.
Dhcp6ClientOptions string: DHCPv6 client options.
Dhcp6IapdLists List<Pulumiverse.Fortios.System.Inputs.GetInterfaceIpv6Dhcp6IapdList>: DHCPv6 IA-PD list The structure of dhcp6_iapd_list block is documented below.
Dhcp6InformationRequest string: Enable/disable DHCPv6 information request.
Dhcp6PrefixDelegation string: Enable/disable DHCPv6 prefix delegation.
Dhcp6PrefixHint string: DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server.
Dhcp6PrefixHintPlt int: DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time.
Dhcp6PrefixHintVlt int: DHCPv6 prefix hint valid life time (sec).
Dhcp6RelayInterfaceId string: DHCP6 relay interface ID.
Dhcp6RelayIp string: DHCPv6 relay IP address.
Dhcp6RelayService string: Enable/disable DHCPv6 relay.
Dhcp6RelaySourceInterface string: Enable/disable use of address on this interface as the source address of the relay message.
Dhcp6RelaySourceIp string: IPv6 address used by the DHCP6 relay as its source IP.
Dhcp6RelayType string: DHCPv6 relay type.
Icmp6SendRedirect string: Enable/disable sending of ICMPv6 redirects.
InterfaceIdentifier 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.
Ip6DefaultLife int: Default life (sec).
Ip6DelegatedPrefixIaid int: IAID of obtained delegated-prefix from the upstream interface.
Ip6DelegatedPrefixLists List<Pulumiverse.Fortios.System.Inputs.GetInterfaceIpv6Ip6DelegatedPrefixList>: Advertised IPv6 delegated prefix list. The structure of ip6_delegated_prefix_list block is documented below.
Ip6DnsServerOverride string: Enable/disable using the DNS server acquired by DHCP.
Ip6ExtraAddrs List<Pulumiverse.Fortios.System.Inputs.GetInterfaceIpv6Ip6ExtraAddr>: Extra IPv6 address prefixes of interface. The structure of ip6_extra_addr block is documented below.
Ip6HopLimit int: Hop limit (0 means unspecified).
Ip6LinkMtu int: IPv6 link MTU.
Ip6ManageFlag string: Enable/disable the managed flag.
Ip6MaxInterval int: IPv6 maximum interval (4 to 1800 sec).
Ip6MinInterval int: IPv6 minimum interval (3 to 1350 sec).
Ip6Mode string: Addressing mode (static, DHCP, delegated).
Ip6OtherFlag string: Enable/disable the other IPv6 flag.
Ip6PrefixLists List<Pulumiverse.Fortios.System.Inputs.GetInterfaceIpv6Ip6PrefixList>: Advertised prefix list. The structure of ip6_prefix_list block is documented below.
Ip6PrefixMode string: Assigning a prefix from DHCP or RA.
Ip6ReachableTime int: IPv6 reachable time (milliseconds; 0 means unspecified).
Ip6RetransTime int: IPv6 retransmit time (milliseconds; 0 means unspecified).
Ip6SendAdv string: Enable/disable sending advertisements about the interface.
Ip6Subnet string: Subnet to routing prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx
Ip6UpstreamInterface string: Interface name providing delegated information.
NdCert string: Neighbor discovery certificate.
NdCgaModifier string: Neighbor discovery CGA modifier.
NdMode string: Neighbor discovery mode.
NdSecurityLevel int: Neighbor discovery security level (0 - 7; 0 = least secure, default = 0).
NdTimestampDelta int: Neighbor discovery timestamp delta value (1 - 3600 sec; default = 300).
NdTimestampFuzz int: Neighbor discovery timestamp fuzz factor (1 - 60 sec; default = 1).
RaSendMtu string: Enable/disable sending link MTU in RA packet.
UniqueAutoconfAddr string: Enable/disable unique auto config address.
Vrip6LinkLocal string: Link-local IPv6 address of virtual router.
Vrrp6s List<Pulumiverse.Fortios.System.Inputs.GetInterfaceIpv6Vrrp6>: IPv6 VRRP configuration. The structure of vrrp6 block is documented below.
VrrpVirtualMac6 string: Enable/disable virtual MAC for VRRP.

Autoconf string: Enable/disable address auto config.
CliConn6Status int: CLI IPv6 connection status.
Dhcp6ClientOptions string: DHCPv6 client options.
Dhcp6IapdLists []GetInterfaceIpv6Dhcp6IapdList: DHCPv6 IA-PD list The structure of dhcp6_iapd_list block is documented below.
Dhcp6InformationRequest string: Enable/disable DHCPv6 information request.
Dhcp6PrefixDelegation string: Enable/disable DHCPv6 prefix delegation.
Dhcp6PrefixHint string: DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server.
Dhcp6PrefixHintPlt int: DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time.
Dhcp6PrefixHintVlt int: DHCPv6 prefix hint valid life time (sec).
Dhcp6RelayInterfaceId string: DHCP6 relay interface ID.
Dhcp6RelayIp string: DHCPv6 relay IP address.
Dhcp6RelayService string: Enable/disable DHCPv6 relay.
Dhcp6RelaySourceInterface string: Enable/disable use of address on this interface as the source address of the relay message.
Dhcp6RelaySourceIp string: IPv6 address used by the DHCP6 relay as its source IP.
Dhcp6RelayType string: DHCPv6 relay type.
Icmp6SendRedirect string: Enable/disable sending of ICMPv6 redirects.
InterfaceIdentifier 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.
Ip6DefaultLife int: Default life (sec).
Ip6DelegatedPrefixIaid int: IAID of obtained delegated-prefix from the upstream interface.
Ip6DelegatedPrefixLists []GetInterfaceIpv6Ip6DelegatedPrefixList: Advertised IPv6 delegated prefix list. The structure of ip6_delegated_prefix_list block is documented below.
Ip6DnsServerOverride string: Enable/disable using the DNS server acquired by DHCP.
Ip6ExtraAddrs []GetInterfaceIpv6Ip6ExtraAddr: Extra IPv6 address prefixes of interface. The structure of ip6_extra_addr block is documented below.
Ip6HopLimit int: Hop limit (0 means unspecified).
Ip6LinkMtu int: IPv6 link MTU.
Ip6ManageFlag string: Enable/disable the managed flag.
Ip6MaxInterval int: IPv6 maximum interval (4 to 1800 sec).
Ip6MinInterval int: IPv6 minimum interval (3 to 1350 sec).
Ip6Mode string: Addressing mode (static, DHCP, delegated).
Ip6OtherFlag string: Enable/disable the other IPv6 flag.
Ip6PrefixLists []GetInterfaceIpv6Ip6PrefixList: Advertised prefix list. The structure of ip6_prefix_list block is documented below.
Ip6PrefixMode string: Assigning a prefix from DHCP or RA.
Ip6ReachableTime int: IPv6 reachable time (milliseconds; 0 means unspecified).
Ip6RetransTime int: IPv6 retransmit time (milliseconds; 0 means unspecified).
Ip6SendAdv string: Enable/disable sending advertisements about the interface.
Ip6Subnet string: Subnet to routing prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx
Ip6UpstreamInterface string: Interface name providing delegated information.
NdCert string: Neighbor discovery certificate.
NdCgaModifier string: Neighbor discovery CGA modifier.
NdMode string: Neighbor discovery mode.
NdSecurityLevel int: Neighbor discovery security level (0 - 7; 0 = least secure, default = 0).
NdTimestampDelta int: Neighbor discovery timestamp delta value (1 - 3600 sec; default = 300).
NdTimestampFuzz int: Neighbor discovery timestamp fuzz factor (1 - 60 sec; default = 1).
RaSendMtu string: Enable/disable sending link MTU in RA packet.
UniqueAutoconfAddr string: Enable/disable unique auto config address.
Vrip6LinkLocal string: Link-local IPv6 address of virtual router.
Vrrp6s []GetInterfaceIpv6Vrrp6: IPv6 VRRP configuration. The structure of vrrp6 block is documented below.
VrrpVirtualMac6 string: Enable/disable virtual MAC for VRRP.

autoconf String: Enable/disable address auto config.
cliConn6Status Integer: CLI IPv6 connection status.
dhcp6ClientOptions String: DHCPv6 client options.
dhcp6IapdLists List<GetInterfaceIpv6Dhcp6IapdList>: DHCPv6 IA-PD list The structure of dhcp6_iapd_list block is documented below.
dhcp6InformationRequest String: Enable/disable DHCPv6 information request.
dhcp6PrefixDelegation String: Enable/disable DHCPv6 prefix delegation.
dhcp6PrefixHint String: DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server.
dhcp6PrefixHintPlt Integer: DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time.
dhcp6PrefixHintVlt Integer: DHCPv6 prefix hint valid life time (sec).
dhcp6RelayInterfaceId String: DHCP6 relay interface ID.
dhcp6RelayIp String: DHCPv6 relay IP address.
dhcp6RelayService String: Enable/disable DHCPv6 relay.
dhcp6RelaySourceInterface String: Enable/disable use of address on this interface as the source address of the relay message.
dhcp6RelaySourceIp String: IPv6 address used by the DHCP6 relay as its source IP.
dhcp6RelayType String: DHCPv6 relay type.
icmp6SendRedirect String: Enable/disable sending of ICMPv6 redirects.
interfaceIdentifier 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.
ip6DefaultLife Integer: Default life (sec).
ip6DelegatedPrefixIaid Integer: IAID of obtained delegated-prefix from the upstream interface.
ip6DelegatedPrefixLists List<GetInterfaceIpv6Ip6DelegatedPrefixList>: Advertised IPv6 delegated prefix list. The structure of ip6_delegated_prefix_list block is documented below.
ip6DnsServerOverride String: Enable/disable using the DNS server acquired by DHCP.
ip6ExtraAddrs List<GetInterfaceIpv6Ip6ExtraAddr>: Extra IPv6 address prefixes of interface. The structure of ip6_extra_addr block is documented below.
ip6HopLimit Integer: Hop limit (0 means unspecified).
ip6LinkMtu Integer: IPv6 link MTU.
ip6ManageFlag String: Enable/disable the managed flag.
ip6MaxInterval Integer: IPv6 maximum interval (4 to 1800 sec).
ip6MinInterval Integer: IPv6 minimum interval (3 to 1350 sec).
ip6Mode String: Addressing mode (static, DHCP, delegated).
ip6OtherFlag String: Enable/disable the other IPv6 flag.
ip6PrefixLists List<GetInterfaceIpv6Ip6PrefixList>: Advertised prefix list. The structure of ip6_prefix_list block is documented below.
ip6PrefixMode String: Assigning a prefix from DHCP or RA.
ip6ReachableTime Integer: IPv6 reachable time (milliseconds; 0 means unspecified).
ip6RetransTime Integer: IPv6 retransmit time (milliseconds; 0 means unspecified).
ip6SendAdv String: Enable/disable sending advertisements about the interface.
ip6Subnet String: Subnet to routing prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx
ip6UpstreamInterface String: Interface name providing delegated information.
ndCert String: Neighbor discovery certificate.
ndCgaModifier String: Neighbor discovery CGA modifier.
ndMode String: Neighbor discovery mode.
ndSecurityLevel Integer: Neighbor discovery security level (0 - 7; 0 = least secure, default = 0).
ndTimestampDelta Integer: Neighbor discovery timestamp delta value (1 - 3600 sec; default = 300).
ndTimestampFuzz Integer: Neighbor discovery timestamp fuzz factor (1 - 60 sec; default = 1).
raSendMtu String: Enable/disable sending link MTU in RA packet.
uniqueAutoconfAddr String: Enable/disable unique auto config address.
vrip6LinkLocal String: Link-local IPv6 address of virtual router.
vrrp6s List<GetInterfaceIpv6Vrrp6>: IPv6 VRRP configuration. The structure of vrrp6 block is documented below.
vrrpVirtualMac6 String: Enable/disable virtual MAC for VRRP.

autoconf string: Enable/disable address auto config.
cliConn6Status number: CLI IPv6 connection status.
dhcp6ClientOptions string: DHCPv6 client options.
dhcp6IapdLists GetInterfaceIpv6Dhcp6IapdList[]: DHCPv6 IA-PD list The structure of dhcp6_iapd_list block is documented below.
dhcp6InformationRequest string: Enable/disable DHCPv6 information request.
dhcp6PrefixDelegation string: Enable/disable DHCPv6 prefix delegation.
dhcp6PrefixHint string: DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server.
dhcp6PrefixHintPlt number: DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time.
dhcp6PrefixHintVlt number: DHCPv6 prefix hint valid life time (sec).
dhcp6RelayInterfaceId string: DHCP6 relay interface ID.
dhcp6RelayIp string: DHCPv6 relay IP address.
dhcp6RelayService string: Enable/disable DHCPv6 relay.
dhcp6RelaySourceInterface string: Enable/disable use of address on this interface as the source address of the relay message.
dhcp6RelaySourceIp string: IPv6 address used by the DHCP6 relay as its source IP.
dhcp6RelayType string: DHCPv6 relay type.
icmp6SendRedirect string: Enable/disable sending of ICMPv6 redirects.
interfaceIdentifier 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.
ip6DefaultLife number: Default life (sec).
ip6DelegatedPrefixIaid number: IAID of obtained delegated-prefix from the upstream interface.
ip6DelegatedPrefixLists GetInterfaceIpv6Ip6DelegatedPrefixList[]: Advertised IPv6 delegated prefix list. The structure of ip6_delegated_prefix_list block is documented below.
ip6DnsServerOverride string: Enable/disable using the DNS server acquired by DHCP.
ip6ExtraAddrs GetInterfaceIpv6Ip6ExtraAddr[]: Extra IPv6 address prefixes of interface. The structure of ip6_extra_addr block is documented below.
ip6HopLimit number: Hop limit (0 means unspecified).
ip6LinkMtu number: IPv6 link MTU.
ip6ManageFlag string: Enable/disable the managed flag.
ip6MaxInterval number: IPv6 maximum interval (4 to 1800 sec).
ip6MinInterval number: IPv6 minimum interval (3 to 1350 sec).
ip6Mode string: Addressing mode (static, DHCP, delegated).
ip6OtherFlag string: Enable/disable the other IPv6 flag.
ip6PrefixLists GetInterfaceIpv6Ip6PrefixList[]: Advertised prefix list. The structure of ip6_prefix_list block is documented below.
ip6PrefixMode string: Assigning a prefix from DHCP or RA.
ip6ReachableTime number: IPv6 reachable time (milliseconds; 0 means unspecified).
ip6RetransTime number: IPv6 retransmit time (milliseconds; 0 means unspecified).
ip6SendAdv string: Enable/disable sending advertisements about the interface.
ip6Subnet string: Subnet to routing prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx
ip6UpstreamInterface string: Interface name providing delegated information.
ndCert string: Neighbor discovery certificate.
ndCgaModifier string: Neighbor discovery CGA modifier.
ndMode string: Neighbor discovery mode.
ndSecurityLevel number: Neighbor discovery security level (0 - 7; 0 = least secure, default = 0).
ndTimestampDelta number: Neighbor discovery timestamp delta value (1 - 3600 sec; default = 300).
ndTimestampFuzz number: Neighbor discovery timestamp fuzz factor (1 - 60 sec; default = 1).
raSendMtu string: Enable/disable sending link MTU in RA packet.
uniqueAutoconfAddr string: Enable/disable unique auto config address.
vrip6LinkLocal string: Link-local IPv6 address of virtual router.
vrrp6s GetInterfaceIpv6Vrrp6[]: IPv6 VRRP configuration. The structure of vrrp6 block is documented below.
vrrpVirtualMac6 string: Enable/disable virtual MAC for VRRP.

autoconf str: Enable/disable address auto config.
cli_conn6_status int: CLI IPv6 connection status.
dhcp6_client_options str: DHCPv6 client options.
dhcp6_iapd_lists Sequence[GetInterfaceIpv6Dhcp6IapdList]: DHCPv6 IA-PD list The structure of dhcp6_iapd_list block is documented below.
dhcp6_information_request str: Enable/disable DHCPv6 information request.
dhcp6_prefix_delegation str: Enable/disable DHCPv6 prefix delegation.
dhcp6_prefix_hint str: DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server.
dhcp6_prefix_hint_plt int: DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time.
dhcp6_prefix_hint_vlt int: DHCPv6 prefix hint valid life time (sec).
dhcp6_relay_interface_id str: DHCP6 relay interface ID.
dhcp6_relay_ip str: DHCPv6 relay IP address.
dhcp6_relay_service str: Enable/disable DHCPv6 relay.
dhcp6_relay_source_interface str: Enable/disable use of address on this interface as the source address of the relay message.
dhcp6_relay_source_ip str: IPv6 address used by the DHCP6 relay as its source IP.
dhcp6_relay_type str: DHCPv6 relay type.
icmp6_send_redirect str: 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_life int: Default life (sec).
ip6_delegated_prefix_iaid int: IAID of obtained delegated-prefix from the upstream interface.
ip6_delegated_prefix_lists Sequence[GetInterfaceIpv6Ip6DelegatedPrefixList]: Advertised IPv6 delegated prefix list. The structure of ip6_delegated_prefix_list block is documented below.
ip6_dns_server_override str: Enable/disable using the DNS server acquired by DHCP.
ip6_extra_addrs Sequence[GetInterfaceIpv6Ip6ExtraAddr]: Extra IPv6 address prefixes of interface. The structure of ip6_extra_addr block is documented below.
ip6_hop_limit int: Hop limit (0 means unspecified).
ip6_link_mtu int: IPv6 link MTU.
ip6_manage_flag str: Enable/disable the managed flag.
ip6_max_interval int: IPv6 maximum interval (4 to 1800 sec).
ip6_min_interval int: IPv6 minimum interval (3 to 1350 sec).
ip6_mode str: Addressing mode (static, DHCP, delegated).
ip6_other_flag str: Enable/disable the other IPv6 flag.
ip6_prefix_lists Sequence[GetInterfaceIpv6Ip6PrefixList]: Advertised prefix list. The structure of ip6_prefix_list block is documented below.
ip6_prefix_mode str: Assigning a prefix from DHCP or RA.
ip6_reachable_time int: IPv6 reachable time (milliseconds; 0 means unspecified).
ip6_retrans_time int: IPv6 retransmit time (milliseconds; 0 means unspecified).
ip6_send_adv str: 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_interface str: Interface name providing delegated information.
nd_cert str: Neighbor discovery certificate.
nd_cga_modifier str: Neighbor discovery CGA modifier.
nd_mode str: Neighbor discovery mode.
nd_security_level int: Neighbor discovery security level (0 - 7; 0 = least secure, default = 0).
nd_timestamp_delta int: Neighbor discovery timestamp delta value (1 - 3600 sec; default = 300).
nd_timestamp_fuzz int: Neighbor discovery timestamp fuzz factor (1 - 60 sec; default = 1).
ra_send_mtu str: Enable/disable sending link MTU in RA packet.
unique_autoconf_addr str: Enable/disable unique auto config address.
vrip6_link_local str: Link-local IPv6 address of virtual router.
vrrp6s Sequence[GetInterfaceIpv6Vrrp6]: IPv6 VRRP configuration. The structure of vrrp6 block is documented below.
vrrp_virtual_mac6 str: Enable/disable virtual MAC for VRRP.

autoconf String: Enable/disable address auto config.
cliConn6Status Number: CLI IPv6 connection status.
dhcp6ClientOptions String: DHCPv6 client options.
dhcp6IapdLists List<Property Map>: DHCPv6 IA-PD list The structure of dhcp6_iapd_list block is documented below.
dhcp6InformationRequest String: Enable/disable DHCPv6 information request.
dhcp6PrefixDelegation String: Enable/disable DHCPv6 prefix delegation.
dhcp6PrefixHint String: DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server.
dhcp6PrefixHintPlt Number: DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time.
dhcp6PrefixHintVlt Number: DHCPv6 prefix hint valid life time (sec).
dhcp6RelayInterfaceId String: DHCP6 relay interface ID.
dhcp6RelayIp String: DHCPv6 relay IP address.
dhcp6RelayService String: Enable/disable DHCPv6 relay.
dhcp6RelaySourceInterface String: Enable/disable use of address on this interface as the source address of the relay message.
dhcp6RelaySourceIp String: IPv6 address used by the DHCP6 relay as its source IP.
dhcp6RelayType String: DHCPv6 relay type.
icmp6SendRedirect String: Enable/disable sending of ICMPv6 redirects.
interfaceIdentifier 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.
ip6DefaultLife Number: Default life (sec).
ip6DelegatedPrefixIaid Number: IAID of obtained delegated-prefix from the upstream interface.
ip6DelegatedPrefixLists List<Property Map>: Advertised IPv6 delegated prefix list. The structure of ip6_delegated_prefix_list block is documented below.
ip6DnsServerOverride String: Enable/disable using the DNS server acquired by DHCP.
ip6ExtraAddrs List<Property Map>: Extra IPv6 address prefixes of interface. The structure of ip6_extra_addr block is documented below.
ip6HopLimit Number: Hop limit (0 means unspecified).
ip6LinkMtu Number: IPv6 link MTU.
ip6ManageFlag String: Enable/disable the managed flag.
ip6MaxInterval Number: IPv6 maximum interval (4 to 1800 sec).
ip6MinInterval Number: IPv6 minimum interval (3 to 1350 sec).
ip6Mode String: Addressing mode (static, DHCP, delegated).
ip6OtherFlag String: Enable/disable the other IPv6 flag.
ip6PrefixLists List<Property Map>: Advertised prefix list. The structure of ip6_prefix_list block is documented below.
ip6PrefixMode String: Assigning a prefix from DHCP or RA.
ip6ReachableTime Number: IPv6 reachable time (milliseconds; 0 means unspecified).
ip6RetransTime Number: IPv6 retransmit time (milliseconds; 0 means unspecified).
ip6SendAdv String: Enable/disable sending advertisements about the interface.
ip6Subnet String: Subnet to routing prefix, syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx
ip6UpstreamInterface String: Interface name providing delegated information.
ndCert String: Neighbor discovery certificate.
ndCgaModifier String: Neighbor discovery CGA modifier.
ndMode String: Neighbor discovery mode.
ndSecurityLevel Number: Neighbor discovery security level (0 - 7; 0 = least secure, default = 0).
ndTimestampDelta Number: Neighbor discovery timestamp delta value (1 - 3600 sec; default = 300).
ndTimestampFuzz Number: Neighbor discovery timestamp fuzz factor (1 - 60 sec; default = 1).
raSendMtu String: Enable/disable sending link MTU in RA packet.
uniqueAutoconfAddr String: Enable/disable unique auto config address.
vrip6LinkLocal String: Link-local IPv6 address of virtual router.
vrrp6s List<Property Map>: IPv6 VRRP configuration. The structure of vrrp6 block is documented below.
vrrpVirtualMac6 String: Enable/disable virtual MAC for VRRP.

GetInterfaceIpv6Dhcp6IapdList

Iaid int: Identity association identifier.
PrefixHint string: DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server.
PrefixHintPlt int: DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time.
PrefixHintVlt int: DHCPv6 prefix hint valid life time (sec).

Iaid int: Identity association identifier.
PrefixHint string: DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server.
PrefixHintPlt int: DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time.
PrefixHintVlt int: DHCPv6 prefix hint valid life time (sec).

iaid Integer: Identity association identifier.
prefixHint String: DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server.
prefixHintPlt Integer: DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time.
prefixHintVlt Integer: DHCPv6 prefix hint valid life time (sec).

iaid number: Identity association identifier.
prefixHint string: DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server.
prefixHintPlt number: DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time.
prefixHintVlt number: 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_plt int: DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time.
prefix_hint_vlt int: DHCPv6 prefix hint valid life time (sec).

iaid Number: Identity association identifier.
prefixHint String: DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server.
prefixHintPlt Number: DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time.
prefixHintVlt Number: DHCPv6 prefix hint valid life time (sec).

GetInterfaceIpv6Ip6DelegatedPrefixList

AutonomousFlag string: Enable/disable the autonomous flag.
DelegatedPrefixIaid int: IAID of obtained delegated-prefix from the upstream interface.
OnlinkFlag string: Enable/disable the onlink flag.
PrefixId int: Prefix ID.
Rdnss string: Recursive DNS server option.
RdnssService string: Recursive DNS service option.
Subnet string: Add subnet ID to routing prefix.
UpstreamInterface string: Name of the interface that provides delegated information.

AutonomousFlag string: Enable/disable the autonomous flag.
DelegatedPrefixIaid int: IAID of obtained delegated-prefix from the upstream interface.
OnlinkFlag string: Enable/disable the onlink flag.
PrefixId int: Prefix ID.
Rdnss string: Recursive DNS server option.
RdnssService string: Recursive DNS service option.
Subnet string: Add subnet ID to routing prefix.
UpstreamInterface string: Name of the interface that provides delegated information.

autonomousFlag String: Enable/disable the autonomous flag.
delegatedPrefixIaid Integer: IAID of obtained delegated-prefix from the upstream interface.
onlinkFlag String: Enable/disable the onlink flag.
prefixId Integer: Prefix ID.
rdnss String: Recursive DNS server option.
rdnssService String: Recursive DNS service option.
subnet String: Add subnet ID to routing prefix.
upstreamInterface String: Name of the interface that provides delegated information.

autonomousFlag string: Enable/disable the autonomous flag.
delegatedPrefixIaid number: IAID of obtained delegated-prefix from the upstream interface.
onlinkFlag string: Enable/disable the onlink flag.
prefixId number: Prefix ID.
rdnss string: Recursive DNS server option.
rdnssService string: Recursive DNS service option.
subnet string: Add subnet ID to routing prefix.
upstreamInterface string: Name of the interface that provides delegated information.

autonomous_flag str: Enable/disable the autonomous flag.
delegated_prefix_iaid int: 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.

autonomousFlag String: Enable/disable the autonomous flag.
delegatedPrefixIaid Number: IAID of obtained delegated-prefix from the upstream interface.
onlinkFlag String: Enable/disable the onlink flag.
prefixId Number: Prefix ID.
rdnss String: Recursive DNS server option.
rdnssService String: Recursive DNS service option.
subnet String: Add subnet ID to routing prefix.
upstreamInterface 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

AutonomousFlag string: Enable/disable the autonomous flag.
Dnssls List<Pulumiverse.Fortios.System.Inputs.GetInterfaceIpv6Ip6PrefixListDnssl>: DNS search list option. The structure of dnssl block is documented below.
OnlinkFlag string: Enable/disable the onlink flag.
PreferredLifeTime int: Preferred life time (sec).
Prefix string: IPv6 prefix.
Rdnss string: Recursive DNS server option.
ValidLifeTime int: Valid life time (sec).

AutonomousFlag string: Enable/disable the autonomous flag.
Dnssls []GetInterfaceIpv6Ip6PrefixListDnssl: DNS search list option. The structure of dnssl block is documented below.
OnlinkFlag string: Enable/disable the onlink flag.
PreferredLifeTime int: Preferred life time (sec).
Prefix string: IPv6 prefix.
Rdnss string: Recursive DNS server option.
ValidLifeTime int: Valid life time (sec).

autonomousFlag String: Enable/disable the autonomous flag.
dnssls List<GetInterfaceIpv6Ip6PrefixListDnssl>: DNS search list option. The structure of dnssl block is documented below.
onlinkFlag String: Enable/disable the onlink flag.
preferredLifeTime Integer: Preferred life time (sec).
prefix String: IPv6 prefix.
rdnss String: Recursive DNS server option.
validLifeTime Integer: Valid life time (sec).

autonomousFlag string: Enable/disable the autonomous flag.
dnssls GetInterfaceIpv6Ip6PrefixListDnssl[]: DNS search list option. The structure of dnssl block is documented below.
onlinkFlag string: Enable/disable the onlink flag.
preferredLifeTime number: Preferred life time (sec).
prefix string: IPv6 prefix.
rdnss string: Recursive DNS server option.
validLifeTime number: Valid life time (sec).

autonomous_flag str: Enable/disable the autonomous flag.
dnssls Sequence[GetInterfaceIpv6Ip6PrefixListDnssl]: DNS search list option. The structure of dnssl block is documented below.
onlink_flag str: Enable/disable the onlink flag.
preferred_life_time int: Preferred life time (sec).
prefix str: IPv6 prefix.
rdnss str: Recursive DNS server option.
valid_life_time int: Valid life time (sec).

autonomousFlag String: Enable/disable the autonomous flag.
dnssls List<Property Map>: DNS search list option. The structure of dnssl block is documented below.
onlinkFlag String: Enable/disable the onlink flag.
preferredLifeTime Number: Preferred life time (sec).
prefix String: IPv6 prefix.
rdnss String: Recursive DNS server option.
validLifeTime Number: 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

AcceptMode string: Enable/disable accept mode.
AdvInterval int: Advertisement interval (1 - 255 seconds).
IgnoreDefaultRoute string: Enable/disable ignoring of default route when checking destination.
Preempt string: Enable/disable preempt mode.
Priority int: Priority of the virtual router (1 - 255).
StartTime 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.

AcceptMode string: Enable/disable accept mode.
AdvInterval int: Advertisement interval (1 - 255 seconds).
IgnoreDefaultRoute string: Enable/disable ignoring of default route when checking destination.
Preempt string: Enable/disable preempt mode.
Priority int: Priority of the virtual router (1 - 255).
StartTime 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.

acceptMode String: Enable/disable accept mode.
advInterval Integer: Advertisement interval (1 - 255 seconds).
ignoreDefaultRoute String: Enable/disable ignoring of default route when checking destination.
preempt String: Enable/disable preempt mode.
priority Integer: Priority of the virtual router (1 - 255).
startTime 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.

acceptMode string: Enable/disable accept mode.
advInterval number: Advertisement interval (1 - 255 seconds).
ignoreDefaultRoute string: Enable/disable ignoring of default route when checking destination.
preempt string: Enable/disable preempt mode.
priority number: Priority of the virtual router (1 - 255).
startTime 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_route str: 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.

acceptMode String: Enable/disable accept mode.
advInterval Number: Advertisement interval (1 - 255 seconds).
ignoreDefaultRoute String: Enable/disable ignoring of default route when checking destination.
preempt String: Enable/disable preempt mode.
priority Number: Priority of the virtual router (1 - 255).
startTime 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

InterfaceName string: Physical interface name.

InterfaceName string: Physical interface name.

interfaceName String: Physical interface name.

interfaceName string: Physical interface name.

interface_name str: Physical interface name.

interfaceName 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.
HaPriority int: HA election priority for the PING server.
Id int: ID.
Ip string: Secondary IP address of the interface.
PingServStatus int: PING server status.
SecipRelayIp string: 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.
HaPriority int: HA election priority for the PING server.
Id int: ID.
Ip string: Secondary IP address of the interface.
PingServStatus int: PING server status.
SecipRelayIp string: 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.
haPriority Integer: HA election priority for the PING server.
id Integer: ID.
ip String: Secondary IP address of the interface.
pingServStatus Integer: PING server status.
secipRelayIp String: 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.
haPriority number: HA election priority for the PING server.
id number: ID.
ip string: Secondary IP address of the interface.
pingServStatus number: PING server status.
secipRelayIp string: 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_status int: PING server status.
secip_relay_ip str: 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.
haPriority Number: HA election priority for the PING server.
id Number: ID.
ip String: Secondary IP address of the interface.
pingServStatus Number: PING server status.
secipRelayIp String: 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.
Tags List<Pulumiverse.Fortios.System.Inputs.GetInterfaceTaggingTag>: Tags. The structure of tags block is documented below.

Category string: Tag category.
Name string: Specify the name of the desired system interface.
Tags []GetInterfaceTaggingTag: Tags. The structure of tags block is documented below.

category String: Tag category.
name String: Specify the name of the desired system interface.
tags List<GetInterfaceTaggingTag>: Tags. The structure of tags block is documented below.

category string: Tag category.
name string: Specify the name of the desired system interface.
tags GetInterfaceTaggingTag[]: Tags. The structure of tags block is documented below.

category str: Tag category.
name str: Specify the name of the desired system interface.
tags Sequence[GetInterfaceTaggingTag]: Tags. The structure of tags block is documented below.

category String: Tag category.
name String: Specify the name of the desired system interface.
tags 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

AcceptMode string: Enable/disable accept mode.
AdvInterval int: Advertisement interval (1 - 255 seconds).
IgnoreDefaultRoute string: Enable/disable ignoring of default route when checking destination.
Preempt string: Enable/disable preempt mode.
Priority int: Priority of the virtual router (1 - 255).
ProxyArps List<Pulumiverse.Fortios.System.Inputs.GetInterfaceVrrpProxyArp>: VRRP Proxy ARP configuration. The structure of proxy_arp block is documented below.
StartTime int: Startup time (1 - 255 seconds).
Status string: Enable/disable VRRP.
Version string: VRRP version.
Vrdst string: Monitor the route to this destination.
VrdstPriority 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.

AcceptMode string: Enable/disable accept mode.
AdvInterval int: Advertisement interval (1 - 255 seconds).
IgnoreDefaultRoute string: Enable/disable ignoring of default route when checking destination.
Preempt string: Enable/disable preempt mode.
Priority int: Priority of the virtual router (1 - 255).
ProxyArps []GetInterfaceVrrpProxyArp: VRRP Proxy ARP configuration. The structure of proxy_arp block is documented below.
StartTime int: Startup time (1 - 255 seconds).
Status string: Enable/disable VRRP.
Version string: VRRP version.
Vrdst string: Monitor the route to this destination.
VrdstPriority 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.

acceptMode String: Enable/disable accept mode.
advInterval Integer: Advertisement interval (1 - 255 seconds).
ignoreDefaultRoute String: Enable/disable ignoring of default route when checking destination.
preempt String: Enable/disable preempt mode.
priority Integer: Priority of the virtual router (1 - 255).
proxyArps List<GetInterfaceVrrpProxyArp>: VRRP Proxy ARP configuration. The structure of proxy_arp block is documented below.
startTime Integer: Startup time (1 - 255 seconds).
status String: Enable/disable VRRP.
version String: VRRP version.
vrdst String: Monitor the route to this destination.
vrdstPriority 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.

acceptMode string: Enable/disable accept mode.
advInterval number: Advertisement interval (1 - 255 seconds).
ignoreDefaultRoute string: Enable/disable ignoring of default route when checking destination.
preempt string: Enable/disable preempt mode.
priority number: Priority of the virtual router (1 - 255).
proxyArps GetInterfaceVrrpProxyArp[]: VRRP Proxy ARP configuration. The structure of proxy_arp block is documented below.
startTime number: Startup time (1 - 255 seconds).
status string: Enable/disable VRRP.
version string: VRRP version.
vrdst string: Monitor the route to this destination.
vrdstPriority 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_route str: 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[GetInterfaceVrrpProxyArp]: 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.

acceptMode String: Enable/disable accept mode.
advInterval Number: Advertisement interval (1 - 255 seconds).
ignoreDefaultRoute String: Enable/disable ignoring of default route when checking destination.
preempt String: Enable/disable preempt mode.
priority Number: Priority of the virtual router (1 - 255).
proxyArps List<Property Map>: VRRP Proxy ARP configuration. The structure of proxy_arp block is documented below.
startTime Number: Startup time (1 - 255 seconds).
status String: Enable/disable VRRP.
version String: VRRP version.
vrdst String: Monitor the route to this destination.
vrdstPriority 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

Id int: ID.
Ip string: Secondary IP address of the interface.

Id int: ID.
Ip string: Secondary IP address of the interface.

id Integer: ID.
ip String: Secondary IP address of the interface.

id number: ID.
ip string: Secondary IP address of the interface.

id int: ID.
ip str: Secondary IP address of the interface.

id Number: ID.
ip String: Secondary IP address of the interface.

Package Details

Repository: fortios pulumiverse/pulumi-fortios
License: Apache-2.0
Notes: This Pulumi package is based on the fortios Terraform Provider.

Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

pulumiverse/pulumi-fortios

fortios.system.getInterface

On this page

On this page

Example Usage

Using getInterface

getInterface Result

Supporting Types

GetInterfaceClientOption

GetInterfaceDhcpSnoopingServerList

GetInterfaceFailAlertInterface

GetInterfaceIpv6

GetInterfaceIpv6Dhcp6IapdList

GetInterfaceIpv6Ip6DelegatedPrefixList

GetInterfaceIpv6Ip6ExtraAddr

GetInterfaceIpv6Ip6PrefixList

GetInterfaceIpv6Ip6PrefixListDnssl

GetInterfaceIpv6Vrrp6

GetInterfaceManagedDevice

GetInterfaceMember

GetInterfaceSecondaryip

GetInterfaceSecurityGroup

GetInterfaceTagging

GetInterfaceTaggingTag

GetInterfaceVrrp

GetInterfaceVrrpProxyArp

Package Details

On this page

On this page