Skip to main content
Version: 1.0.0

Properties

About Properties#

When making a request or a subscription you can specify properties (i.e. in TopologyRequest or TelemetrySubscription). This allows you to define the properties you want to be returned for the requested objects. This is optional, since omitting properties results in all available properties being returned.

Different objects provide different properties (i.e. LSNode, LSLink, TelemetryData).

invalid properties

The Jalapeño API Gateway ignores invalid properties. Make sure therefore, that the strings you provide match the properties below exactly.

All Properties#

LsNode Properties#

  • "Key"
  • "Id"
  • "RouterHash"
  • "DomainId"
  • "RouterIp"
  • "PeerHash"
  • "PeerIp"
  • "PeerAsn"
  • "Timestamp"
  • "IgpRouterId"
  • "Asn"
  • "Mtid"
  • "AreaId"
  • "Protocol"
  • "ProtocolId"
  • "Name"
  • "IsPrepolicy"
  • "IsAdjRibIn"

LsLink Properties#

  • "Key"
  • "Id"
  • "RouterHash"
  • "RouterIp"
  • "DomainId"
  • "PeerHash"
  • "PeerIp"
  • "PeerAsn"
  • "Timestamp"
  • "IgpRouterId"
  • "Protocol"
  • "AreaId"
  • "Nexthop"
  • "Mtid"
  • "LocalLinkIp"
  • "RemoteLinkIp"
  • "IgpMetric"
  • "RemoteNodeHash"
  • "LocalNodeHash"
  • "RemoteIgpRouterId"

LsPrefix Properties#

  • "Key"
  • "Id"
  • "RouterHash"
  • "RouterIp"
  • "DomainId"
  • "PeerHash"
  • "PeerIp"
  • "PeerAsn"
  • "Timestamp"
  • "IgpRouterId"
  • "Protocol"
  • "AreaId"
  • "Nexthop"
  • "LocalNodeHash"
  • "Mtid"
  • "Prefix"
  • "PrefixLen"
  • "PrefixMetric"
  • "IsPrepolicy"
  • "IsAdjRibIn"

LsSrv6Sid Properties#

  • "Key"
  • "Id"
  • "RouterHash"
  • "RouterIp"
  • "DomainId"
  • "PeerHash"
  • "PeerIp"
  • "PeerAsn"
  • "Timestamp"
  • "IgpRouterId"
  • "LocalNodeAsn"
  • "Protocol"
  • "Nexthop"
  • "LocalNodeHash"
  • "Mtid"
  • "IgpFlags"
  • "IsPrepolicy"
  • "IsAdjRibIn"
  • "Srv6Sid"

LsNodeEdge Properties#

  • "Key"
  • "Id"
  • "From"
  • "To"
  • "Link"

Properties for Physical Interfaces#

  • "DataRate"
  • "PacketsSent"
  • "PacketsReceived"

Properties for Loopback Interfaces#

  • "State"
  • "LastStateTransitionTime"