Data Model | Forward Networks Docs

📄️ AfiSafiType

Identity type for AFI,SAFI tuples for BGP-4

The abstract forwarding tables (AFTs) that are associated with the network instance. An AFT is instantiated per-protocol running within the network-instance - such that one exists for IPv4 Unicast, IPv6 Unicast, MPLS, L2 forwarding entries, etc. A forwarding entry within the FIB has a set of next-hops, which may be a reference to an entry within another table - e.g., where a Layer 3 next-hop has an associated Layer 2 forwarding entry.

📄️ Aggregation

Fields

📄️ AllowedCertificationAuthorityEnrollmentUrlsDevicePolicy

Fields

📄️ AllowedServicesDevicePolicy

Fields

📄️ AnycastConfigurationDetail

Fields

📄️ AnycastService

Fields

📄️ AnycastServiceConfiguration

Fields

📄️ ArcsightConfig

Fields

📄️ ArpEntry

Fields

📄️ AsPath

Fields

📄️ AsType

Options

📄️ AttrSet

Path attributes that may be in use by multiple routes in the table.

📄️ Backend

Options

📄️ BackendBucket

Fields

📄️ BackendServer

Fields

📄️ Bgp

Fields

📄️ BgpNeighbor

Fields

📄️ BgpNeighborStatistics

Fields

📄️ BgpOrigin

Options

📄️ BgpRib

Defines a data model for representing BGP routing table contents.

📄️ BgpSessionState

Options

📄️ BluecatConfig

Fields

📄️ BluecatConfigItem

Fields

📄️ BluecatConfigItemData

Fields

📄️ BluecatOutputs

Fields

📄️ BluecatRoute

Fields

📄️ BluecatServerDataItem

Fields

📄️ BluecatServerItem

Fields

📄️ BluecatServers

Fields

📄️ BluecatServices

Fields

📄️ Bridge

Bridge domain related data for a bridge interface.

📄️ CisaExploitationEntry

An entry from CISA's Known Exploited Vulnerabilities (KEV) catalog.

📄️ CliCommandResponse

Fields

📄️ CliSource

Fields

📄️ CloudAccount

Defines a data model for representing NQE cloud account with all related data.

📄️ CloudFirewall

Defined within a VPC

📄️ CloudFirewallRule

Fields

📄️ CloudFirewallRuleDefinition

Fields

📄️ CloudIface

Fields

📄️ CloudRoute

Fields

📄️ CloudRouteNextHop

Options

📄️ CloudRouteType

Options

📄️ CloudType

Options

📄️ ClusterHaInfo

Fields

📄️ Command

Fields

📄️ CommandType

Options

📄️ ComputeInstance

Fields

📄️ ConfigLine

Information about a single line in a device config file.

📄️ ConnectsToAccessLayerSwitchInterfacePolicy

Fields

📄️ ConnectsToCoreLayerInterfacePolicy

Fields

📄️ ConnectsToCustomerEdgeDeviceInterfacePolicy

Fields

📄️ ConnectsToDodinDeviceInterfacePolicy

Fields

📄️ ConnectsViaFiberOpticsInterfacePolicy

Fields

📄️ ContainerType

Options

📄️ Cve

Fields

📄️ CveApplicationCriteria

Fields

📄️ CveDatabase

Fields

📄️ CveFinding

Fields

📄️ CveFindingBasis

Options

📄️ CveHardwareCriteria

Fields

📄️ CveOsCriteria

Fields

📄️ CveProductCriteria

Fields

📄️ DataConnector

Fields

📄️ DcGateway

Fields

📄️ DefaultInterfaceParameters

Fields

📄️ DefaultStigParameters

Fields

📄️ DefaultVrfParameters

Fields

📄️ Device

Fields

📄️ DeviceCollectionError

Options

📄️ DeviceDiscoveryIfaceInfo

Fields

📄️ DeviceDiscoveryNeighbor

Information about a CDP or LLDP neighbor. Note that the neighbor may not be a collected device. For example, it may be an end host.

📄️ DeviceHost

Fields

📄️ DeviceHostType

Options

📄️ DeviceL3IfaceName

Fields

📄️ DeviceParameters

Fields

📄️ DevicePart

Fields

📄️ DevicePartSupport

Fields

📄️ DevicePartType

Options

📄️ DevicePolicy

Fields

📄️ DeviceProcessingError

Options

📄️ DeviceSecurityZone

A security zone on a device.

📄️ DeviceSecurityZoneReference

Reference of a security zone on a firewall

📄️ DeviceSnapshotInfo

Fields

📄️ DeviceSnapshotResult

Options

📄️ DeviceType

Classification of networking devices. Common types include ROUTER, SWITCH, and FIREWALL.

📄️ DirectConnection

Fields

📄️ DnsActivityConfigurationDetail

Fields

📄️ DnsActivityService

Fields

📄️ DnsActivityServiceConfiguration

Fields

📄️ DnsResolverConfigurationDetail

Fields

📄️ DnsResolverService

Fields

📄️ DnsResolverServiceConfiguration

Fields

📄️ DuplexMode

Options

📄️ EdgeServicePointConfigurationDetail

Fields

📄️ EdgeServicePointService

Fields

📄️ EdgeServicePointServiceConfiguration

Fields

📄️ EncapsulationHeaderType

Options

📄️ Ethernet

Fields

📄️ ExternalSources

Fields

📄️ FhrpState

Options

📄️ Files

Information about config data sources for a device.

📄️ FirewallConfigurationDetail

Fields

📄️ FirewallPolicy

Fields

📄️ FirewallRule

Fields

📄️ FirewallService

Fields

📄️ FirewallServiceConfiguration

Fields

📄️ GatewayConfigurationDetail

Fields

📄️ GatewayConfigurationDetailData

Fields

📄️ GatewayContainer

Fields

📄️ GatewayService

Fields

📄️ GatewayServiceConfiguration

Fields

📄️ GlobalAccelerator

Fields

📄️ GlobalAcceleratorListener

Fields

📄️ GlobalAcceleratorListenerEndpoint

Options

📄️ GlobalAcceleratorListenerEndpointGroup

Fields

📄️ GlobalAcceleratorStatus

Options

📄️ Ha

Fields

📄️ HaOperationMode

Options

📄️ HeaderRegion

Fields

📄️ HeaderRewrite

Fields

📄️ Hop

Fields

📄️ HttpApiEndpointResult

Fields

📄️ HttpApiEndpointStatus

Options

📄️ HttpEndpoint

Fields

📄️ HttpPage

Fields

📄️ HttpSource

Fields

📄️ Iface

Fields

📄️ IfaceAcls

Access control list details for an interface.

📄️ IfaceFhrp

Fields

📄️ IfaceFhrpGroup

Fields

📄️ IfaceFhrpInfo

Fields

📄️ IfaceIpv4Info

The IPv4 addresses configured on an interface.

📄️ IfaceIpv6Info

The IPv6 addresses configured on an interface.

📄️ IfaceSubIface

The names of the interface and subinterface that are associated with the network instance.

📄️ IfaceType

Options

📄️ InetGateway

Fields

📄️ InstanceIface

Fields

📄️ InterfaceConnectivityParameters

Fields

📄️ InterfaceConnectivityPolicy

Fields

📄️ InterfacePolicy

Fields

📄️ InterfacesService

Fields

📄️ InterfacesServiceConfiguration

Fields

📄️ InterfacesServiceConfigurationDetail

Fields

📄️ IntRange

Fields

📄️ IpEntry

Fields

📄️ IpUnicast

Fields

📄️ Ipv4Address

Fields

📄️ Ipv6Address

Fields

📄️ IsExternalInterfacePolicy

Fields

📄️ IsProviderEdgeDevicePolicy

Fields

📄️ IsUntrustedInterfacePolicy

Fields

📄️ KeepAliveStatus

Options

📄️ Layer

Network layer in the OSI model.

📄️ LifecycleData

Firewall hit count and timestamps for their creation, last modification, and last used. Present for systems that were succesfully collected and have one of these operating systems: SRX, PAN_OS, CHECKPOINT, FORTINET and ASA, if reported by the the operating system. At least one of the fields will be non-null.

📄️ LoadBalancer

Fields

📄️ LoadBalancerRule

Fields

📄️ Location

Fields

📄️ MacEntry

Fields

📄️ MacEntryInterfaceInfo

Fields

📄️ MacEntrySourceType

Options

📄️ MacEntryType

Options

📄️ ManagementSubnetsDevicePolicy

Fields

📄️ MetadataMatches

Fields

📄️ MstInstance

Fields

📄️ Mstp

Multi Spanning-tree protocol configuration and operation data.

📄️ MulticastMode

Options

📄️ NamedVlanCollection

Fields

📄️ NatEntry

Fields

📄️ NatGateway

Fields

📄️ NatType

Options

📄️ Network

Fields

📄️ NetworkAcl

Fields

📄️ NetworkEndpoint

Fields

📄️ NetworkExtensions

Contains user-defined extensions to the standard Network data model. By default, this type has no fields. In any Forward Instance, this type will have one field for each Data File defined.

📄️ NetworkInstance

Fields

📄️ NetworkInstanceFdb

Fields

📄️ NetworkInstanceProtocol

Fields

📄️ NetworkInstanceType

Options

📄️ NetworkObject

Fields

📄️ NextHop

Fields

📄️ NextHopType

Options

📄️ NtpConfigurationDetail

Fields

📄️ NtpServer

Fields

📄️ NtpService

Fields

📄️ NtpServiceConfiguration

Fields

📄️ OidCollectionStatus

Options

📄️ OidEntry

Fields

📄️ OidOutput

Fields

📄️ OperStatus

The current operational state of the interface.

📄️ OrganizationalUnit

Defines a data model for representing NQE cloud account organizational unit.

📄️ OriginProtocol

Options

📄️ OS

Options

📄️ Ospf

Fields

📄️ OspfArea

Fields

📄️ OspfAreaType

Options

📄️ OspfNeighbor

Fields

📄️ OspfRemotePeer

Fields

📄️ OspfRole

Options

📄️ OspfRouterType

Options

📄️ OsSupport

Contains dates for some of the OS support milestones of this device.

📄️ OutboundRule

Fields

📄️ Outputs

Fields

📄️ PaginatedHttpEndpoint

Fields

📄️ PaginatedHttpEndpointStatus

Options

📄️ PanosFiles

Fields

📄️ Path

Fields

📄️ PbrAction

PBR action data will be added in upcoming releases

📄️ PeerLink

Fields

📄️ PeerStatus

Options

📄️ PeerType

Labels a peer or peer group as explicitly internal or external.

📄️ PhysicalLink

Fields

📄️ Platform

Fields

📄️ PortSpeed

Type to specify available Ethernet link speeds.

📄️ PublicUnallocatedIp

A public unallocated IPv4 address and related metadata.

📄️ PublicUnallocatedIpSubnet

A public unallocatd IPv4 subnet and related metadata.

📄️ QRadarConfig

Fields

📄️ RapidPvst

Rapid per vlan Spanning-tree protocol configuration and operation data.

📄️ RapidPvstVlan

Rapid Spanning-tree protocol configuration and operation data.

📄️ RefObj

Fields

📄️ RefObjType

Options

📄️ RequiresDefaultVlanInterfacePolicy

Fields

📄️ RequiresMulticastInterfacePolicy

Fields

📄️ Route

Fields

📄️ RoutedVlan

Fields

📄️ RouteTable

Fields

📄️ RoutingProtocolType

Type for routing protocols, including those which may install prefixes into the RIB

📄️ Rstp

Rapid Spanning-tree protocol configuration and operation data.

📄️ RuleContainer

The origin of a firewall rule.

📄️ SecurityGroup

Fields

📄️ SecurityRule

Fields

📄️ SecurityRuleAction

Options

📄️ ServiceEndpoint

Fields

📄️ Severity

Options

📄️ SnmpAgentService

Fields

📄️ SnmpAgentServiceSystem

Fields

📄️ SnmpAgentV1

Fields

📄️ SnmpAgentV2C

Fields

📄️ SnmpAgentV3

Fields

📄️ SnmpConfigurationDetail

Fields

📄️ SnmpService

Fields

📄️ SnmpServiceConfiguration

Fields

📄️ SnmpSource

Fields

📄️ SnmpTrapServer

Fields

📄️ SnmpTrapService

Fields

📄️ SshConfigurationDetail

Fields

📄️ SshService

Fields

📄️ SshServiceConfiguration

Fields

📄️ SshTacacsConfig

Fields

📄️ StigDatabase

Fields

📄️ StigGuide

Fields

📄️ StigParameterUsage

Fields

📄️ StigPolicy

Fields

📄️ StigPolicyCondition

The condition (a set of constraints) under which a policy applies to a device in the network. The condition is true for a device when all constraint fields on this set are satisfied.