routeros

package module
v0.0.0-...-db1d587 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 12, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package routeros holds the hand-written half of the generated view: the conversions the emitted code calls.

These duplicate rest/scalar deliberately rather than importing it. rest is pinned to a Go release candidate for encoding/json/v2, and nothing about a typed accessor should drag a prerelease toolchain into a caller's build. When rest settles onto a released Go, this file should collapse into it.

Package routeros is a typed view of a few RouterOS menus.

Every value RouterOS returns is a string; these types say what each one means, on the router's own authority rather than a schema written by hand.

Index

Constants

View Source 
const InterfaceBridgePath = "/interface/bridge"

InterfaceBridge is /interface/bridge.

list, writable. Rows are addressable by name, which this RouterOS enforces unique.

View Source 
const InterfacePath = "/interface"

Interface is /interface.

list, writable. No field is a proven unique key here (UNPROBED), so a caller addressing rows needs one of its own.

View Source 
const IpAddressPath = "/ip/address"

IpAddress is /ip/address.

list, writable. No field is a proven unique key here (DUPLICATE), so a caller addressing rows needs one of its own.

View Source 
const IpFirewallFilterPath = "/ip/firewall/filter"

IpFirewallFilter is /ip/firewall/filter.

ordered-list, writable. No field is a proven unique key here (DUPLICATE), so a caller addressing rows needs one of its own.

View Source 
const RoutingBgpSessionPath = "/routing/bgp/session"

RoutingBgpSession is /routing/bgp/session.

list, read-only. No field is a proven unique key here (UNPROBED), so a caller addressing rows needs one of its own.

View Source 
const SystemHealthPath = "/system/health"

SystemHealth is /system/health.

list, writable. No field is a proven unique key here (UNPROBED), so a caller addressing rows needs one of its own.

View Source 
const SystemResourcePath = "/system/resource"

SystemResource is /system/resource.

singleton, read-only.

Variables

This section is empty.

Functions

This section is empty.

Types

type Interface 

type Interface struct {
	// ID is the router's own row handle. It is reassigned when a row is
	// deleted and recreated, so it addresses a row and does not identify one.
	ID string

	ActualMtu        int64        // actual-mtu (read-only, integer number)
	Comment          string       // comment (string)
	DefaultName      string       // default-name (read-only, string)
	Disabled         bool         // disabled
	Dynamic          bool         // dynamic (read-only)
	FpRpsDrop        int64        // fp-rps-drop (read-only, integer number)
	FpRxByte         int64        // fp-rx-byte (read-only, integer number)
	FpRxPacket       int64        // fp-rx-packet (read-only, integer number)
	FpTxByte         int64        // fp-tx-byte (read-only, integer number)
	FpTxPacket       int64        // fp-tx-packet (read-only, integer number)
	Inactive         bool         // inactive (read-only)
	L2mtu            int64        // l2mtu (integer number)
	LastLinkDownTime string       // last-link-down-time (read-only)
	LastLinkUpTime   string       // last-link-up-time (read-only)
	LinkDowns        int64        // link-downs (read-only, integer number)
	MacAddress       string       // mac-address (read-only, MAC address)
	MaxL2mtu         int64        // max-l2mtu (read-only, integer number)
	Mtu              InterfaceMtu // mtu
	Name             string       // name (string)
	Passthrough      bool         // passthrough (read-only)
	Running          bool         // running (read-only)
	RxByte           int64        // rx-byte (read-only, integer number)
	RxDrop           int64        // rx-drop (read-only, integer number)
	RxError          int64        // rx-error (read-only, integer number)
	RxPacket         int64        // rx-packet (read-only, integer number)
	Slave            bool         // slave (read-only)
	TxByte           int64        // tx-byte (read-only, integer number)
	TxDrop           int64        // tx-drop (read-only, integer number)
	TxError          int64        // tx-error (read-only, integer number)
	TxPacket         int64        // tx-packet (read-only, integer number)
	TxQueueDrop      int64        // tx-queue-drop (read-only, integer number)
	Type             string       // type (read-only, string)
	Vrf              string       // vrf (read-only)
}

func DecodeInterface 

func DecodeInterface(r map[string]string) Interface

DecodeInterface reads one record as the router returned it.

func (Interface) Encode 

func (v Interface) Encode() map[string]string

Encode returns the writable fields as the router expects them. Read-only fields are omitted; sending one back is how a caller discovers that the router rejects unknown parameters.

type InterfaceBridge 

type InterfaceBridge struct {
	// ID is the router's own row handle. It is reassigned when a row is
	// deleted and recreated, so it addresses a row and does not identify one.
	ID string

	ActualMtu                int64                          // actual-mtu (read-only, integer number)
	AdminMac                 string                         // admin-mac (MAC address)
	AgeingTime               time.Duration                  // ageing-time (time interval)
	Arp                      InterfaceBridgeArp             // arp
	ArpTimeout               string                         // arp-timeout
	AutoMac                  bool                           // auto-mac
	Comment                  string                         // comment (string)
	CopyFrom                 string                         // copy-from
	DhcpAgentCircuitId       string                         // dhcp-agent-circuit-id (string)
	DhcpAgentRemoteId        string                         // dhcp-agent-remote-id (string)
	DhcpSnooping             bool                           // dhcp-snooping
	Dhcpv6AgentCircuitId     string                         // dhcpv6-agent-circuit-id (string)
	Dhcpv6AgentRemoteId      string                         // dhcpv6-agent-remote-id (string)
	Dhcpv6Snooping           bool                           // dhcpv6-snooping
	Disabled                 bool                           // disabled
	Dynamic                  bool                           // dynamic (read-only)
	EtherType                InterfaceBridgeEtherType       // ether-type
	FastForward              bool                           // fast-forward
	ForwardDelay             time.Duration                  // forward-delay (time interval)
	ForwardReservedAddresses bool                           // forward-reserved-addresses
	FrameTypes               InterfaceBridgeFrameTypes      // frame-types
	IgmpSnooping             bool                           // igmp-snooping
	IgmpVersion              InterfaceBridgeIgmpVersion     // igmp-version
	IngressFiltering         bool                           // ingress-filtering
	L2mtu                    int64                          // l2mtu (read-only, integer number)
	LastMemberInterval       time.Duration                  // last-member-interval (time interval)
	LastMemberQueryCount     int64                          // last-member-query-count (integer number)
	MacAddress               string                         // mac-address (read-only, MAC address)
	Managed                  bool                           // managed (read-only)
	MaxHops                  int64                          // max-hops (integer number)
	MaxLearnedEntries        string                         // max-learned-entries (integer number)
	MaxMessageAge            time.Duration                  // max-message-age (time interval)
	MembershipInterval       time.Duration                  // membership-interval (time interval)
	MlagHeartbeat            string                         // mlag-heartbeat (time interval)
	MlagPeerPort             string                         // mlag-peer-port
	MlagPriority             int64                          // mlag-priority (integer number)
	MldVersion               InterfaceBridgeMldVersion      // mld-version
	Mtu                      InterfaceBridgeMtu             // mtu
	MulticastQuerier         bool                           // multicast-querier
	MulticastRouter          InterfaceBridgeMulticastRouter // multicast-router
	Mvrp                     bool                           // mvrp
	Name                     string                         // name (string)
	PortCostMode             InterfaceBridgePortCostMode    // port-cost-mode
	Priority                 int64                          // priority (integer number)
	ProtocolMode             InterfaceBridgeProtocolMode    // protocol-mode
	Pvid                     int64                          // pvid (integer number)
	QuerierInterval          time.Duration                  // querier-interval (time interval)
	QueryInterval            time.Duration                  // query-interval (time interval)
	QueryResponseInterval    time.Duration                  // query-response-interval (time interval)
	RaGuard                  bool                           // ra-guard
	RegionName               string                         // region-name (string)
	RegionRevision           int64                          // region-revision (integer number)
	Running                  bool                           // running (read-only)
	StartupQueryCount        int64                          // startup-query-count (integer number)
	StartupQueryInterval     time.Duration                  // startup-query-interval (time interval)
	TransmitHoldCount        int64                          // transmit-hold-count (integer number)
	VlanFiltering            bool                           // vlan-filtering
}

func DecodeInterfaceBridge 

func DecodeInterfaceBridge(r map[string]string) InterfaceBridge

DecodeInterfaceBridge reads one record as the router returned it.

func (InterfaceBridge) Encode 

func (v InterfaceBridge) Encode() map[string]string

Encode returns the writable fields as the router expects them. Read-only fields are omitted; sending one back is how a caller discovers that the router rejects unknown parameters.

type InterfaceBridgeArp 

type InterfaceBridgeArp string

InterfaceBridgeArp is the vocabulary the router states for /interface/bridge arp. 

const (
	InterfaceBridgeArpDisabled      InterfaceBridgeArp = "disabled"
	InterfaceBridgeArpEnabled       InterfaceBridgeArp = "enabled"
	InterfaceBridgeArpLocalProxyArp InterfaceBridgeArp = "local-proxy-arp"
	InterfaceBridgeArpProxyArp      InterfaceBridgeArp = "proxy-arp"
	InterfaceBridgeArpReplyOnly     InterfaceBridgeArp = "reply-only"
)

type InterfaceBridgeEtherType 

type InterfaceBridgeEtherType string

InterfaceBridgeEtherType is the vocabulary the router states for /interface/bridge ether-type. 

const (
	InterfaceBridgeEtherTypeN0x8100 InterfaceBridgeEtherType = "0x8100"
	InterfaceBridgeEtherTypeN0x88a8 InterfaceBridgeEtherType = "0x88a8"
	InterfaceBridgeEtherTypeN0x9100 InterfaceBridgeEtherType = "0x9100"
)

type InterfaceBridgeFrameTypes 

type InterfaceBridgeFrameTypes string

InterfaceBridgeFrameTypes is the vocabulary the router states for /interface/bridge frame-types. 

const (
	InterfaceBridgeFrameTypesAdmitAll                           InterfaceBridgeFrameTypes = "admit-all"
	InterfaceBridgeFrameTypesAdmitOnlyUntaggedAndPriorityTagged InterfaceBridgeFrameTypes = "admit-only-untagged-and-priority-tagged"
	InterfaceBridgeFrameTypesAdmitOnlyVlanTagged                InterfaceBridgeFrameTypes = "admit-only-vlan-tagged"
)

type InterfaceBridgeIgmpVersion 

type InterfaceBridgeIgmpVersion string

InterfaceBridgeIgmpVersion is the vocabulary the router states for /interface/bridge igmp-version. 

const (
	InterfaceBridgeIgmpVersionN2 InterfaceBridgeIgmpVersion = "2"
	InterfaceBridgeIgmpVersionN3 InterfaceBridgeIgmpVersion = "3"
)

type InterfaceBridgeMldVersion 

type InterfaceBridgeMldVersion string

InterfaceBridgeMldVersion is the vocabulary the router states for /interface/bridge mld-version. 

const (
	InterfaceBridgeMldVersionN1 InterfaceBridgeMldVersion = "1"
	InterfaceBridgeMldVersionN2 InterfaceBridgeMldVersion = "2"
)

type InterfaceBridgeMtu 

type InterfaceBridgeMtu string

InterfaceBridgeMtu is the vocabulary the router states for /interface/bridge mtu. 

const (
	InterfaceBridgeMtuAuto InterfaceBridgeMtu = "auto"
)

type InterfaceBridgeMulticastRouter 

type InterfaceBridgeMulticastRouter string

InterfaceBridgeMulticastRouter is the vocabulary the router states for /interface/bridge multicast-router. 

const (
	InterfaceBridgeMulticastRouterDisabled       InterfaceBridgeMulticastRouter = "disabled"
	InterfaceBridgeMulticastRouterPermanent      InterfaceBridgeMulticastRouter = "permanent"
	InterfaceBridgeMulticastRouterTemporaryQuery InterfaceBridgeMulticastRouter = "temporary-query"
)

type InterfaceBridgePortCostMode 

type InterfaceBridgePortCostMode string

InterfaceBridgePortCostMode is the vocabulary the router states for /interface/bridge port-cost-mode. 

const (
	InterfaceBridgePortCostModeLong  InterfaceBridgePortCostMode = "long"
	InterfaceBridgePortCostModeShort InterfaceBridgePortCostMode = "short"
)

type InterfaceBridgeProtocolMode 

type InterfaceBridgeProtocolMode string

InterfaceBridgeProtocolMode is the vocabulary the router states for /interface/bridge protocol-mode. 

const (
	InterfaceBridgeProtocolModeMstp InterfaceBridgeProtocolMode = "mstp"
	InterfaceBridgeProtocolModeNone InterfaceBridgeProtocolMode = "none"
	InterfaceBridgeProtocolModeRstp InterfaceBridgeProtocolMode = "rstp"
	InterfaceBridgeProtocolModeStp  InterfaceBridgeProtocolMode = "stp"
)

type InterfaceMtu 

type InterfaceMtu string

InterfaceMtu is the vocabulary the router states for /interface mtu. 

const (
	InterfaceMtuAuto InterfaceMtu = "auto"
)

type IpAddress 

type IpAddress struct {
	// ID is the router's own row handle. It is reassigned when a row is
	// deleted and recreated, so it addresses a row and does not identify one.
	ID string

	ActualInterface string // actual-interface (read-only)
	Address         string // address (IP address|integer number)
	Broadcast       string // broadcast (IP address)
	Comment         string // comment (string)
	Disabled        bool   // disabled
	Dynamic         bool   // dynamic (read-only)
	Interface       string // interface
	Invalid         bool   // invalid (read-only)
	Netmask         string // netmask (IP address)
	Network         string // network (IP address)
	Slave           bool   // slave (read-only)
	Vrf             string // vrf (read-only)
}

Omitted, the router having stated no type: copy-from.

func DecodeIpAddress 

func DecodeIpAddress(r map[string]string) IpAddress

DecodeIpAddress reads one record as the router returned it.

func (IpAddress) Encode 

func (v IpAddress) Encode() map[string]string

Encode returns the writable fields as the router expects them. Read-only fields are omitted; sending one back is how a caller discovers that the router rejects unknown parameters.

type IpFirewallFilter 

type IpFirewallFilter struct {
	// ID is the router's own row handle. It is reassigned when a row is
	// deleted and recreated, so it addresses a row and does not identify one.
	ID string

	Action                  IpFirewallFilterAction                  // action
	AddressList             string                                  // address-list (string)
	AddressListTimeout      string                                  // address-list-timeout (time interval)
	Bytes                   int64                                   // bytes (read-only, integer number)
	Chain                   string                                  // chain (string)
	Comment                 string                                  // comment (string)
	ConnectionBytes         int64                                   // connection-bytes (integer number)
	ConnectionLimit         string                                  // connection-limit (integer number)
	ConnectionMark          IpFirewallFilterConnectionMark          // connection-mark
	ConnectionNatState      IpFirewallFilterConnectionNatState      // connection-nat-state
	ConnectionRate          string                                  // connection-rate (integer number)
	ConnectionState         IpFirewallFilterConnectionState         // connection-state
	ConnectionType          IpFirewallFilterConnectionType          // connection-type
	Content                 string                                  // content (string)
	Disabled                bool                                    // disabled
	Dscp                    string                                  // dscp (integer number)
	DstAddress              string                                  // dst-address (IP address range)
	DstAddressList          string                                  // dst-address-list (string)
	DstAddressType          IpFirewallFilterDstAddressType          // dst-address-type
	DstLimit                int64                                   // dst-limit (integer number)
	DstPort                 string                                  // dst-port (max 15 times)
	Dynamic                 bool                                    // dynamic (read-only)
	Fragment                bool                                    // fragment
	Hotspot                 IpFirewallFilterHotspot                 // hotspot
	IcmpOptions             string                                  // icmp-options (integer number)
	InBridgePort            string                                  // in-bridge-port
	InBridgePortList        string                                  // in-bridge-port-list
	InInterface             string                                  // in-interface
	InInterfaceList         string                                  // in-interface-list
	IngressPriority         string                                  // ingress-priority (integer number)
	Invalid                 bool                                    // invalid (read-only)
	IpsecPolicy             IpFirewallFilterIpsecPolicy             // ipsec-policy
	Ipv4Options             IpFirewallFilterIpv4Options             // ipv4-options
	JumpTarget              string                                  // jump-target (string)
	Layer7Protocol          string                                  // layer7-protocol
	Limit                   string                                  // limit (integer number|time interval)
	Log                     bool                                    // log
	LogPrefix               string                                  // log-prefix (string)
	Nth                     string                                  // nth (integer number)
	OutBridgePort           string                                  // out-bridge-port
	OutBridgePortList       string                                  // out-bridge-port-list
	OutInterface            string                                  // out-interface
	OutInterfaceList        string                                  // out-interface-list
	P2p                     IpFirewallFilterP2p                     // p2p
	PacketMark              IpFirewallFilterPacketMark              // packet-mark
	PacketSize              string                                  // packet-size (integer number)
	Packets                 int64                                   // packets (read-only, integer number)
	PerConnectionClassifier IpFirewallFilterPerConnectionClassifier // per-connection-classifier
	Port                    string                                  // port (max 15 times)
	Priority                string                                  // priority (integer number)
	Protocol                IpFirewallFilterProtocol                // protocol
	Psd                     int64                                   // psd (integer number)
	Random                  int64                                   // random (integer number)
	Realm                   string                                  // realm (integer number)
	RejectWith              IpFirewallFilterRejectWith              // reject-with
	RoutingMark             IpFirewallFilterRoutingMark             // routing-mark
	SrcAddress              string                                  // src-address (IP address range)
	SrcAddressList          string                                  // src-address-list (string)
	SrcAddressType          IpFirewallFilterSrcAddressType          // src-address-type
	SrcMacAddress           string                                  // src-mac-address (MAC address)
	SrcPort                 string                                  // src-port (max 15 times)
	TcpFlags                IpFirewallFilterTcpFlags                // tcp-flags
	TcpMss                  string                                  // tcp-mss (integer number)
	Time                    string                                  // time (time interval)
	TlsHost                 string                                  // tls-host (string)
	Tos                     string                                  // tos (integer number)
	Ttl                     IpFirewallFilterTtl                     // ttl
}

Omitted, the router having stated no type: copy-from, place-before.

func DecodeIpFirewallFilter 

func DecodeIpFirewallFilter(r map[string]string) IpFirewallFilter

DecodeIpFirewallFilter reads one record as the router returned it.

func (IpFirewallFilter) Encode 

func (v IpFirewallFilter) Encode() map[string]string

Encode returns the writable fields as the router expects them. Read-only fields are omitted; sending one back is how a caller discovers that the router rejects unknown parameters.

type IpFirewallFilterAction 

type IpFirewallFilterAction string

IpFirewallFilterAction is the vocabulary the router states for /ip/firewall/filter action. 

const (
	IpFirewallFilterActionAccept              IpFirewallFilterAction = "accept"
	IpFirewallFilterActionAddDstToAddressList IpFirewallFilterAction = "add-dst-to-address-list"
	IpFirewallFilterActionAddSrcToAddressList IpFirewallFilterAction = "add-src-to-address-list"
	IpFirewallFilterActionDrop                IpFirewallFilterAction = "drop"
	IpFirewallFilterActionFasttrackConnection IpFirewallFilterAction = "fasttrack-connection"
	IpFirewallFilterActionJump                IpFirewallFilterAction = "jump"
	IpFirewallFilterActionLog                 IpFirewallFilterAction = "log"
	IpFirewallFilterActionPassthrough         IpFirewallFilterAction = "passthrough"
	IpFirewallFilterActionReject              IpFirewallFilterAction = "reject"
	IpFirewallFilterActionReturn              IpFirewallFilterAction = "return"
	IpFirewallFilterActionTarpit              IpFirewallFilterAction = "tarpit"
)

type IpFirewallFilterConnectionMark 

type IpFirewallFilterConnectionMark string

IpFirewallFilterConnectionMark is the vocabulary the router states for /ip/firewall/filter connection-mark. 

const (
	IpFirewallFilterConnectionMarkNot    IpFirewallFilterConnectionMark = "!"
	IpFirewallFilterConnectionMarkNoMark IpFirewallFilterConnectionMark = "no-mark"
)

type IpFirewallFilterConnectionNatState 

type IpFirewallFilterConnectionNatState string

IpFirewallFilterConnectionNatState is the vocabulary the router states for /ip/firewall/filter connection-nat-state. 

const (
	IpFirewallFilterConnectionNatStateNot     IpFirewallFilterConnectionNatState = "!"
	IpFirewallFilterConnectionNatStateDstnat  IpFirewallFilterConnectionNatState = "dstnat"
	IpFirewallFilterConnectionNatStateEinDnat IpFirewallFilterConnectionNatState = "ein-dnat"
	IpFirewallFilterConnectionNatStateEinSnat IpFirewallFilterConnectionNatState = "ein-snat"
	IpFirewallFilterConnectionNatStateSrcnat  IpFirewallFilterConnectionNatState = "srcnat"
)

type IpFirewallFilterConnectionState 

type IpFirewallFilterConnectionState string

IpFirewallFilterConnectionState is the vocabulary the router states for /ip/firewall/filter connection-state. 

const (
	IpFirewallFilterConnectionStateNot         IpFirewallFilterConnectionState = "!"
	IpFirewallFilterConnectionStateEstablished IpFirewallFilterConnectionState = "established"
	IpFirewallFilterConnectionStateInvalid     IpFirewallFilterConnectionState = "invalid"
	IpFirewallFilterConnectionStateNew         IpFirewallFilterConnectionState = "new"
	IpFirewallFilterConnectionStateRelated     IpFirewallFilterConnectionState = "related"
	IpFirewallFilterConnectionStateUntracked   IpFirewallFilterConnectionState = "untracked"
)

type IpFirewallFilterConnectionType 

type IpFirewallFilterConnectionType string

IpFirewallFilterConnectionType is the vocabulary the router states for /ip/firewall/filter connection-type. 

const (
	IpFirewallFilterConnectionTypeNot    IpFirewallFilterConnectionType = "!"
	IpFirewallFilterConnectionTypeFtp    IpFirewallFilterConnectionType = "ftp"
	IpFirewallFilterConnectionTypeH323   IpFirewallFilterConnectionType = "h323"
	IpFirewallFilterConnectionTypeIrc    IpFirewallFilterConnectionType = "irc"
	IpFirewallFilterConnectionTypePptp   IpFirewallFilterConnectionType = "pptp"
	IpFirewallFilterConnectionTypeQuake3 IpFirewallFilterConnectionType = "quake3"
	IpFirewallFilterConnectionTypeSip    IpFirewallFilterConnectionType = "sip"
	IpFirewallFilterConnectionTypeTftp   IpFirewallFilterConnectionType = "tftp"
)

type IpFirewallFilterDstAddressType 

type IpFirewallFilterDstAddressType string

IpFirewallFilterDstAddressType is the vocabulary the router states for /ip/firewall/filter dst-address-type. 

const (
	IpFirewallFilterDstAddressTypeNot       IpFirewallFilterDstAddressType = "!"
	IpFirewallFilterDstAddressTypeBlackhole IpFirewallFilterDstAddressType = "blackhole"
	IpFirewallFilterDstAddressTypeBroadcast IpFirewallFilterDstAddressType = "broadcast"
	IpFirewallFilterDstAddressTypeLocal     IpFirewallFilterDstAddressType = "local"
	IpFirewallFilterDstAddressTypeMulticast IpFirewallFilterDstAddressType = "multicast"
	IpFirewallFilterDstAddressTypeUnicast   IpFirewallFilterDstAddressType = "unicast"
)

type IpFirewallFilterHotspot 

type IpFirewallFilterHotspot string

IpFirewallFilterHotspot is the vocabulary the router states for /ip/firewall/filter hotspot. 

const (
	IpFirewallFilterHotspotNot        IpFirewallFilterHotspot = "!"
	IpFirewallFilterHotspotAuth       IpFirewallFilterHotspot = "auth"
	IpFirewallFilterHotspotFromClient IpFirewallFilterHotspot = "from-client"
	IpFirewallFilterHotspotHttp       IpFirewallFilterHotspot = "http"
	IpFirewallFilterHotspotLocalDst   IpFirewallFilterHotspot = "local-dst"
	IpFirewallFilterHotspotToClient   IpFirewallFilterHotspot = "to-client"
)

type IpFirewallFilterIpsecPolicy 

type IpFirewallFilterIpsecPolicy string

IpFirewallFilterIpsecPolicy is the vocabulary the router states for /ip/firewall/filter ipsec-policy. 

const (
	IpFirewallFilterIpsecPolicyIn  IpFirewallFilterIpsecPolicy = "in"
	IpFirewallFilterIpsecPolicyOut IpFirewallFilterIpsecPolicy = "out"
)

type IpFirewallFilterIpv4Options 

type IpFirewallFilterIpv4Options string

IpFirewallFilterIpv4Options is the vocabulary the router states for /ip/firewall/filter ipv4-options. 

const (
	IpFirewallFilterIpv4OptionsAny                 IpFirewallFilterIpv4Options = "any"
	IpFirewallFilterIpv4OptionsLooseSourceRouting  IpFirewallFilterIpv4Options = "loose-source-routing"
	IpFirewallFilterIpv4OptionsNoRecordRoute       IpFirewallFilterIpv4Options = "no-record-route"
	IpFirewallFilterIpv4OptionsNoRouterAlert       IpFirewallFilterIpv4Options = "no-router-alert"
	IpFirewallFilterIpv4OptionsNoSourceRouting     IpFirewallFilterIpv4Options = "no-source-routing"
	IpFirewallFilterIpv4OptionsNoTimestamp         IpFirewallFilterIpv4Options = "no-timestamp"
	IpFirewallFilterIpv4OptionsNone                IpFirewallFilterIpv4Options = "none"
	IpFirewallFilterIpv4OptionsRecordRoute         IpFirewallFilterIpv4Options = "record-route"
	IpFirewallFilterIpv4OptionsRouterAlert         IpFirewallFilterIpv4Options = "router-alert"
	IpFirewallFilterIpv4OptionsStrictSourceRouting IpFirewallFilterIpv4Options = "strict-source-routing"
	IpFirewallFilterIpv4OptionsTimestamp           IpFirewallFilterIpv4Options = "timestamp"
)

type IpFirewallFilterP2p 

type IpFirewallFilterP2p string

IpFirewallFilterP2p is the vocabulary the router states for /ip/firewall/filter p2p. 

const (
	IpFirewallFilterP2pNot           IpFirewallFilterP2p = "!"
	IpFirewallFilterP2pAllP2p        IpFirewallFilterP2p = "all-p2p"
	IpFirewallFilterP2pBitTorrent    IpFirewallFilterP2p = "bit-torrent"
	IpFirewallFilterP2pBlubster      IpFirewallFilterP2p = "blubster"
	IpFirewallFilterP2pDirectConnect IpFirewallFilterP2p = "direct-connect"
	IpFirewallFilterP2pEdonkey       IpFirewallFilterP2p = "edonkey"
	IpFirewallFilterP2pFasttrack     IpFirewallFilterP2p = "fasttrack"
	IpFirewallFilterP2pGnutella      IpFirewallFilterP2p = "gnutella"
	IpFirewallFilterP2pSoulseek      IpFirewallFilterP2p = "soulseek"
	IpFirewallFilterP2pWarez         IpFirewallFilterP2p = "warez"
	IpFirewallFilterP2pWinmx         IpFirewallFilterP2p = "winmx"
)

type IpFirewallFilterPacketMark 

type IpFirewallFilterPacketMark string

IpFirewallFilterPacketMark is the vocabulary the router states for /ip/firewall/filter packet-mark. 

const (
	IpFirewallFilterPacketMarkNot    IpFirewallFilterPacketMark = "!"
	IpFirewallFilterPacketMarkNoMark IpFirewallFilterPacketMark = "no-mark"
)

type IpFirewallFilterPerConnectionClassifier 

type IpFirewallFilterPerConnectionClassifier string

IpFirewallFilterPerConnectionClassifier is the vocabulary the router states for /ip/firewall/filter per-connection-classifier. 

const (
	IpFirewallFilterPerConnectionClassifierNot                   IpFirewallFilterPerConnectionClassifier = "!"
	IpFirewallFilterPerConnectionClassifierBothAddresses         IpFirewallFilterPerConnectionClassifier = "both-addresses"
	IpFirewallFilterPerConnectionClassifierBothAddressesAndPorts IpFirewallFilterPerConnectionClassifier = "both-addresses-and-ports"
	IpFirewallFilterPerConnectionClassifierBothPorts             IpFirewallFilterPerConnectionClassifier = "both-ports"
	IpFirewallFilterPerConnectionClassifierDstAddress            IpFirewallFilterPerConnectionClassifier = "dst-address"
	IpFirewallFilterPerConnectionClassifierDstAddressAndPort     IpFirewallFilterPerConnectionClassifier = "dst-address-and-port"
	IpFirewallFilterPerConnectionClassifierDstPort               IpFirewallFilterPerConnectionClassifier = "dst-port"
	IpFirewallFilterPerConnectionClassifierSrcAddress            IpFirewallFilterPerConnectionClassifier = "src-address"
	IpFirewallFilterPerConnectionClassifierSrcAddressAndPort     IpFirewallFilterPerConnectionClassifier = "src-address-and-port"
	IpFirewallFilterPerConnectionClassifierSrcPort               IpFirewallFilterPerConnectionClassifier = "src-port"
)

type IpFirewallFilterProtocol 

type IpFirewallFilterProtocol string

IpFirewallFilterProtocol is the vocabulary the router states for /ip/firewall/filter protocol. 

const (
	IpFirewallFilterProtocolNot       IpFirewallFilterProtocol = "!"
	IpFirewallFilterProtocolDccp      IpFirewallFilterProtocol = "dccp"
	IpFirewallFilterProtocolDdp       IpFirewallFilterProtocol = "ddp"
	IpFirewallFilterProtocolEgp       IpFirewallFilterProtocol = "egp"
	IpFirewallFilterProtocolEncap     IpFirewallFilterProtocol = "encap"
	IpFirewallFilterProtocolEtherip   IpFirewallFilterProtocol = "etherip"
	IpFirewallFilterProtocolGgp       IpFirewallFilterProtocol = "ggp"
	IpFirewallFilterProtocolGre       IpFirewallFilterProtocol = "gre"
	IpFirewallFilterProtocolHmp       IpFirewallFilterProtocol = "hmp"
	IpFirewallFilterProtocolIcmp      IpFirewallFilterProtocol = "icmp"
	IpFirewallFilterProtocolIcmpv6    IpFirewallFilterProtocol = "icmpv6"
	IpFirewallFilterProtocolIdprCmtp  IpFirewallFilterProtocol = "idpr-cmtp"
	IpFirewallFilterProtocolIgmp      IpFirewallFilterProtocol = "igmp"
	IpFirewallFilterProtocolIpencap   IpFirewallFilterProtocol = "ipencap"
	IpFirewallFilterProtocolIpip      IpFirewallFilterProtocol = "ipip"
	IpFirewallFilterProtocolIpsecAh   IpFirewallFilterProtocol = "ipsec-ah"
	IpFirewallFilterProtocolIpsecEsp  IpFirewallFilterProtocol = "ipsec-esp"
	IpFirewallFilterProtocolIpv6Encap IpFirewallFilterProtocol = "ipv6-encap"
	IpFirewallFilterProtocolIpv6Frag  IpFirewallFilterProtocol = "ipv6-frag"
	IpFirewallFilterProtocolIpv6Nonxt IpFirewallFilterProtocol = "ipv6-nonxt"
	IpFirewallFilterProtocolIpv6Opts  IpFirewallFilterProtocol = "ipv6-opts"
	IpFirewallFilterProtocolIpv6Route IpFirewallFilterProtocol = "ipv6-route"
	IpFirewallFilterProtocolIsoTp4    IpFirewallFilterProtocol = "iso-tp4"
	IpFirewallFilterProtocolL2tp      IpFirewallFilterProtocol = "l2tp"
	IpFirewallFilterProtocolOspf      IpFirewallFilterProtocol = "ospf"
	IpFirewallFilterProtocolPim       IpFirewallFilterProtocol = "pim"
	IpFirewallFilterProtocolPup       IpFirewallFilterProtocol = "pup"
	IpFirewallFilterProtocolRdp       IpFirewallFilterProtocol = "rdp"
	IpFirewallFilterProtocolRspf      IpFirewallFilterProtocol = "rspf"
	IpFirewallFilterProtocolRsvp      IpFirewallFilterProtocol = "rsvp"
	IpFirewallFilterProtocolSctp      IpFirewallFilterProtocol = "sctp"
	IpFirewallFilterProtocolSt        IpFirewallFilterProtocol = "st"
	IpFirewallFilterProtocolTcp       IpFirewallFilterProtocol = "tcp"
	IpFirewallFilterProtocolUdp       IpFirewallFilterProtocol = "udp"
	IpFirewallFilterProtocolUdpLite   IpFirewallFilterProtocol = "udp-lite"
	IpFirewallFilterProtocolVmtp      IpFirewallFilterProtocol = "vmtp"
	IpFirewallFilterProtocolVrrp      IpFirewallFilterProtocol = "vrrp"
	IpFirewallFilterProtocolXnsIdp    IpFirewallFilterProtocol = "xns-idp"
	IpFirewallFilterProtocolXtp       IpFirewallFilterProtocol = "xtp"
)

type IpFirewallFilterRejectWith 

type IpFirewallFilterRejectWith string

IpFirewallFilterRejectWith is the vocabulary the router states for /ip/firewall/filter reject-with. 

const (
	IpFirewallFilterRejectWithIcmpAdminProhibited     IpFirewallFilterRejectWith = "icmp-admin-prohibited"
	IpFirewallFilterRejectWithIcmpHostProhibited      IpFirewallFilterRejectWith = "icmp-host-prohibited"
	IpFirewallFilterRejectWithIcmpHostUnreachable     IpFirewallFilterRejectWith = "icmp-host-unreachable"
	IpFirewallFilterRejectWithIcmpNetProhibited       IpFirewallFilterRejectWith = "icmp-net-prohibited"
	IpFirewallFilterRejectWithIcmpNetworkUnreachable  IpFirewallFilterRejectWith = "icmp-network-unreachable"
	IpFirewallFilterRejectWithIcmpPortUnreachable     IpFirewallFilterRejectWith = "icmp-port-unreachable"
	IpFirewallFilterRejectWithIcmpProtocolUnreachable IpFirewallFilterRejectWith = "icmp-protocol-unreachable"
	IpFirewallFilterRejectWithTcpReset                IpFirewallFilterRejectWith = "tcp-reset"
)

type IpFirewallFilterRoutingMark 

type IpFirewallFilterRoutingMark string

IpFirewallFilterRoutingMark is the vocabulary the router states for /ip/firewall/filter routing-mark. 

const (
	IpFirewallFilterRoutingMarkNot  IpFirewallFilterRoutingMark = "!"
	IpFirewallFilterRoutingMarkMain IpFirewallFilterRoutingMark = "main"
)

type IpFirewallFilterSrcAddressType 

type IpFirewallFilterSrcAddressType string

IpFirewallFilterSrcAddressType is the vocabulary the router states for /ip/firewall/filter src-address-type. 

const (
	IpFirewallFilterSrcAddressTypeNot       IpFirewallFilterSrcAddressType = "!"
	IpFirewallFilterSrcAddressTypeBlackhole IpFirewallFilterSrcAddressType = "blackhole"
	IpFirewallFilterSrcAddressTypeBroadcast IpFirewallFilterSrcAddressType = "broadcast"
	IpFirewallFilterSrcAddressTypeLocal     IpFirewallFilterSrcAddressType = "local"
	IpFirewallFilterSrcAddressTypeMulticast IpFirewallFilterSrcAddressType = "multicast"
	IpFirewallFilterSrcAddressTypeUnicast   IpFirewallFilterSrcAddressType = "unicast"
)

type IpFirewallFilterTcpFlags 

type IpFirewallFilterTcpFlags string

IpFirewallFilterTcpFlags is the vocabulary the router states for /ip/firewall/filter tcp-flags. 

const (
	IpFirewallFilterTcpFlagsNot  IpFirewallFilterTcpFlags = "!"
	IpFirewallFilterTcpFlagsNot2 IpFirewallFilterTcpFlags = "!,"
	IpFirewallFilterTcpFlagsAck  IpFirewallFilterTcpFlags = "ack"
	IpFirewallFilterTcpFlagsCwr  IpFirewallFilterTcpFlags = "cwr"
	IpFirewallFilterTcpFlagsEce  IpFirewallFilterTcpFlags = "ece"
	IpFirewallFilterTcpFlagsFin  IpFirewallFilterTcpFlags = "fin"
	IpFirewallFilterTcpFlagsPsh  IpFirewallFilterTcpFlags = "psh"
	IpFirewallFilterTcpFlagsRst  IpFirewallFilterTcpFlags = "rst"
	IpFirewallFilterTcpFlagsSyn  IpFirewallFilterTcpFlags = "syn"
	IpFirewallFilterTcpFlagsUrg  IpFirewallFilterTcpFlags = "urg"
)

type IpFirewallFilterTtl 

type IpFirewallFilterTtl string

IpFirewallFilterTtl is the vocabulary the router states for /ip/firewall/filter ttl. 

const (
	IpFirewallFilterTtlEqual       IpFirewallFilterTtl = "equal"
	IpFirewallFilterTtlGreaterThan IpFirewallFilterTtl = "greater-than"
	IpFirewallFilterTtlLessThan    IpFirewallFilterTtl = "less-than"
	IpFirewallFilterTtlNotEqual    IpFirewallFilterTtl = "not-equal"
)

type RoutingBgpSession 

type RoutingBgpSession struct {
	// ID is the router's own row handle. It is reassigned when a row is
	// deleted and recreated, so it addresses a row and does not identify one.
	ID string

	CiscoVplsNlriLenFmt              RoutingBgpSessionCiscoVplsNlriLenFmt    // cisco-vpls-nlri-len-fmt (read-only)
	Ebgp                             string                                  // ebgp (read-only)
	Established                      bool                                    // established (read-only)
	HoldTime                         string                                  // hold-time (read-only, time interval)
	Ibgp                             string                                  // ibgp (read-only)
	InputAddPath                     RoutingBgpSessionInputAddPath           // input.add-path (read-only)
	InputAffinity                    RoutingBgpSessionInputAffinity          // input.affinity (read-only)
	InputAllowAs                     int64                                   // input.allow-as (read-only, integer number)
	InputAsOverride                  bool                                    // input.as-override (read-only)
	InputFilter                      string                                  // input.filter (read-only, string)
	InputIgnoreAsPathLen             bool                                    // input.ignore-as-path-len (read-only)
	InputLastNotification            string                                  // input.last-notification (read-only, string)
	InputLimitProcessRoutes          int64                                   // input.limit-process-routes (read-only, integer number)
	InputProcid                      int64                                   // input.procid (read-only, integer number)
	Instance                         string                                  // instance (read-only)
	KeepaliveTime                    time.Duration                           // keepalive-time (read-only, time interval)
	KeepaliveTimer                   string                                  // keepalive-timer (read-only)
	LastStarted                      string                                  // last-started (read-only)
	LastStopped                      string                                  // last-stopped (read-only)
	LimitExceeded                    string                                  // limit-exceeded (read-only)
	LocalAddress                     string                                  // local.address (read-only)
	LocalAfi                         RoutingBgpSessionLocalAfi               // local.afi (read-only)
	LocalAs                          string                                  // local.as (read-only)
	LocalBytes                       int64                                   // local.bytes (read-only, integer number)
	LocalCapabilities                RoutingBgpSessionLocalCapabilities      // local.capabilities (read-only)
	LocalClusterId                   string                                  // local.cluster-id (read-only, IP address)
	LocalEor                         RoutingBgpSessionLocalEor               // local.eor (read-only)
	LocalId                          string                                  // local.id (read-only, IP address)
	LocalMessages                    int64                                   // local.messages (read-only, integer number)
	LocalPort                        int64                                   // local.port (read-only, integer number)
	LocalRole                        RoutingBgpSessionLocalRole              // local.role (read-only)
	Multihop                         bool                                    // multihop (read-only)
	Name                             string                                  // name (read-only, string)
	NexthopChoice                    RoutingBgpSessionNexthopChoice          // nexthop-choice (read-only)
	OutputAddPath                    RoutingBgpSessionOutputAddPath          // output.add-path (read-only)
	OutputAffinity                   RoutingBgpSessionOutputAffinity         // output.affinity (read-only)
	OutputDefaultOriginate           RoutingBgpSessionOutputDefaultOriginate // output.default-originate (read-only)
	OutputDefaultPrepend             int64                                   // output.default-prepend (read-only, integer number)
	OutputFilterChain                string                                  // output.filter-chain (read-only, string)
	OutputFilterSelect               string                                  // output.filter-select (read-only, string)
	OutputKeepSentAttributes         bool                                    // output.keep-sent-attributes (read-only)
	OutputLastNotification           string                                  // output.last-notification (read-only, string)
	OutputNetwork                    string                                  // output.network (read-only, string)
	OutputNoClientToClientReflection bool                                    // output.no-client-to-client-reflection (read-only)
	OutputNoEarlyCut                 bool                                    // output.no-early-cut (read-only)
	OutputProcid                     int64                                   // output.procid (read-only, integer number)
	OutputRemovePrivateAs            bool                                    // output.remove-private-as (read-only)
	PrefixCount                      int64                                   // prefix-count (read-only, integer number)
	RemoteAddress                    string                                  // remote.address (read-only)
	RemoteAfi                        RoutingBgpSessionRemoteAfi              // remote.afi (read-only)
	RemoteAs                         string                                  // remote.as (read-only)
	RemoteBytes                      int64                                   // remote.bytes (read-only, integer number)
	RemoteCapabilities               RoutingBgpSessionRemoteCapabilities     // remote.capabilities (read-only)
	RemoteEor                        RoutingBgpSessionRemoteEor              // remote.eor (read-only)
	RemoteGrAfi                      RoutingBgpSessionRemoteGrAfi            // remote.gr-afi (read-only)
	RemoteGrAfiFwp                   RoutingBgpSessionRemoteGrAfiFwp         // remote.gr-afi-fwp (read-only)
	RemoteGrRestart                  bool                                    // remote.gr-restart (read-only)
	RemoteGrTime                     int64                                   // remote.gr-time (read-only, integer number)
	RemoteHoldTime                   string                                  // remote.hold-time (read-only, time interval)
	RemoteId                         string                                  // remote.id (read-only, IP address)
	RemoteMessages                   int64                                   // remote.messages (read-only, integer number)
	RemotePort                       int64                                   // remote.port (read-only, integer number)
	RemoteRefusedCapOpt              bool                                    // remote.refused-cap-opt (read-only)
	RemoteRole                       RoutingBgpSessionRemoteRole             // remote.role (read-only)
	RestartTimer                     string                                  // restart-timer (read-only)
	RoutingTable                     string                                  // routing-table (read-only)
	SaveTo                           string                                  // save-to (read-only, string)
	Stopped                          string                                  // stopped (read-only)
	Uptime                           string                                  // uptime (read-only)
	UseBfd                           bool                                    // use-bfd (read-only)
	Vrf                              string                                  // vrf (read-only)
}

func DecodeRoutingBgpSession 

func DecodeRoutingBgpSession(r map[string]string) RoutingBgpSession

DecodeRoutingBgpSession reads one record as the router returned it.

func (RoutingBgpSession) Encode 

func (v RoutingBgpSession) Encode() map[string]string

Encode returns the writable fields as the router expects them. RoutingBgpSession has none: the device maintains this menu.

type RoutingBgpSessionCiscoVplsNlriLenFmt 

type RoutingBgpSessionCiscoVplsNlriLenFmt string

RoutingBgpSessionCiscoVplsNlriLenFmt is the vocabulary the router states for /routing/bgp/session cisco-vpls-nlri-len-fmt. 

const (
	RoutingBgpSessionCiscoVplsNlriLenFmtAutoBits  RoutingBgpSessionCiscoVplsNlriLenFmt = "auto-bits"
	RoutingBgpSessionCiscoVplsNlriLenFmtAutoBytes RoutingBgpSessionCiscoVplsNlriLenFmt = "auto-bytes"
	RoutingBgpSessionCiscoVplsNlriLenFmtBits      RoutingBgpSessionCiscoVplsNlriLenFmt = "bits"
	RoutingBgpSessionCiscoVplsNlriLenFmtBytes     RoutingBgpSessionCiscoVplsNlriLenFmt = "bytes"
)

type RoutingBgpSessionInputAddPath 

type RoutingBgpSessionInputAddPath string

RoutingBgpSessionInputAddPath is the vocabulary the router states for /routing/bgp/session input.add-path. 

const (
	RoutingBgpSessionInputAddPathIp   RoutingBgpSessionInputAddPath = "ip"
	RoutingBgpSessionInputAddPathIpv6 RoutingBgpSessionInputAddPath = "ipv6"
)

type RoutingBgpSessionInputAffinity 

type RoutingBgpSessionInputAffinity string

RoutingBgpSessionInputAffinity is the vocabulary the router states for /routing/bgp/session input.affinity. 

const (
	RoutingBgpSessionInputAffinityAfi      RoutingBgpSessionInputAffinity = "afi"
	RoutingBgpSessionInputAffinityAlone    RoutingBgpSessionInputAffinity = "alone"
	RoutingBgpSessionInputAffinityInstance RoutingBgpSessionInputAffinity = "instance"
	RoutingBgpSessionInputAffinityMain     RoutingBgpSessionInputAffinity = "main"
	RoutingBgpSessionInputAffinityRemoteAs RoutingBgpSessionInputAffinity = "remote-as"
	RoutingBgpSessionInputAffinityVrf      RoutingBgpSessionInputAffinity = "vrf"
)

type RoutingBgpSessionLocalAfi 

type RoutingBgpSessionLocalAfi string

RoutingBgpSessionLocalAfi is the vocabulary the router states for /routing/bgp/session local.afi. 

const (
	RoutingBgpSessionLocalAfiEvpn       RoutingBgpSessionLocalAfi = "evpn"
	RoutingBgpSessionLocalAfiIp         RoutingBgpSessionLocalAfi = "ip"
	RoutingBgpSessionLocalAfiIpv6       RoutingBgpSessionLocalAfi = "ipv6"
	RoutingBgpSessionLocalAfiL2vpn      RoutingBgpSessionLocalAfi = "l2vpn"
	RoutingBgpSessionLocalAfiL2vpnCisco RoutingBgpSessionLocalAfi = "l2vpn-cisco"
	RoutingBgpSessionLocalAfiVpnv4      RoutingBgpSessionLocalAfi = "vpnv4"
	RoutingBgpSessionLocalAfiVpnv6      RoutingBgpSessionLocalAfi = "vpnv6"
)

type RoutingBgpSessionLocalCapabilities 

type RoutingBgpSessionLocalCapabilities string

RoutingBgpSessionLocalCapabilities is the vocabulary the router states for /routing/bgp/session local.capabilities. 

const (
	RoutingBgpSessionLocalCapabilitiesAp   RoutingBgpSessionLocalCapabilities = "ap"
	RoutingBgpSessionLocalCapabilitiesAs4  RoutingBgpSessionLocalCapabilities = "as4"
	RoutingBgpSessionLocalCapabilitiesEnhe RoutingBgpSessionLocalCapabilities = "enhe"
	RoutingBgpSessionLocalCapabilitiesGr   RoutingBgpSessionLocalCapabilities = "gr"
	RoutingBgpSessionLocalCapabilitiesMp   RoutingBgpSessionLocalCapabilities = "mp"
	RoutingBgpSessionLocalCapabilitiesRole RoutingBgpSessionLocalCapabilities = "role"
	RoutingBgpSessionLocalCapabilitiesRr   RoutingBgpSessionLocalCapabilities = "rr"
)

type RoutingBgpSessionLocalEor 

type RoutingBgpSessionLocalEor string

RoutingBgpSessionLocalEor is the vocabulary the router states for /routing/bgp/session local.eor. 

const (
	RoutingBgpSessionLocalEorIp         RoutingBgpSessionLocalEor = "ip"
	RoutingBgpSessionLocalEorIpv6       RoutingBgpSessionLocalEor = "ipv6"
	RoutingBgpSessionLocalEorL2vpn      RoutingBgpSessionLocalEor = "l2vpn"
	RoutingBgpSessionLocalEorL2vpnCisco RoutingBgpSessionLocalEor = "l2vpn-cisco"
	RoutingBgpSessionLocalEorVpnv4      RoutingBgpSessionLocalEor = "vpnv4"
)

type RoutingBgpSessionLocalRole 

type RoutingBgpSessionLocalRole string

RoutingBgpSessionLocalRole is the vocabulary the router states for /routing/bgp/session local.role. 

const (
	RoutingBgpSessionLocalRoleEbgp         RoutingBgpSessionLocalRole = "ebgp"
	RoutingBgpSessionLocalRoleEbgpCustomer RoutingBgpSessionLocalRole = "ebgp-customer"
	RoutingBgpSessionLocalRoleEbgpPeer     RoutingBgpSessionLocalRole = "ebgp-peer"
	RoutingBgpSessionLocalRoleEbgpProvider RoutingBgpSessionLocalRole = "ebgp-provider"
	RoutingBgpSessionLocalRoleEbgpRs       RoutingBgpSessionLocalRole = "ebgp-rs"
	RoutingBgpSessionLocalRoleEbgpRsClient RoutingBgpSessionLocalRole = "ebgp-rs-client"
	RoutingBgpSessionLocalRoleIbgp         RoutingBgpSessionLocalRole = "ibgp"
	RoutingBgpSessionLocalRoleIbgpRr       RoutingBgpSessionLocalRole = "ibgp-rr"
)

type RoutingBgpSessionNexthopChoice 

type RoutingBgpSessionNexthopChoice string

RoutingBgpSessionNexthopChoice is the vocabulary the router states for /routing/bgp/session nexthop-choice. 

const (
	RoutingBgpSessionNexthopChoiceDefault   RoutingBgpSessionNexthopChoice = "default"
	RoutingBgpSessionNexthopChoiceForceSelf RoutingBgpSessionNexthopChoice = "force-self"
	RoutingBgpSessionNexthopChoicePropagate RoutingBgpSessionNexthopChoice = "propagate"
)

type RoutingBgpSessionOutputAddPath 

type RoutingBgpSessionOutputAddPath string

RoutingBgpSessionOutputAddPath is the vocabulary the router states for /routing/bgp/session output.add-path. 

const (
	RoutingBgpSessionOutputAddPathIp   RoutingBgpSessionOutputAddPath = "ip"
	RoutingBgpSessionOutputAddPathIpv6 RoutingBgpSessionOutputAddPath = "ipv6"
)

type RoutingBgpSessionOutputAffinity 

type RoutingBgpSessionOutputAffinity string

RoutingBgpSessionOutputAffinity is the vocabulary the router states for /routing/bgp/session output.affinity. 

const (
	RoutingBgpSessionOutputAffinityAfi      RoutingBgpSessionOutputAffinity = "afi"
	RoutingBgpSessionOutputAffinityAlone    RoutingBgpSessionOutputAffinity = "alone"
	RoutingBgpSessionOutputAffinityInput    RoutingBgpSessionOutputAffinity = "input"
	RoutingBgpSessionOutputAffinityInstance RoutingBgpSessionOutputAffinity = "instance"
	RoutingBgpSessionOutputAffinityMain     RoutingBgpSessionOutputAffinity = "main"
	RoutingBgpSessionOutputAffinityRemoteAs RoutingBgpSessionOutputAffinity = "remote-as"
	RoutingBgpSessionOutputAffinityVrf      RoutingBgpSessionOutputAffinity = "vrf"
)

type RoutingBgpSessionOutputDefaultOriginate 

type RoutingBgpSessionOutputDefaultOriginate string

RoutingBgpSessionOutputDefaultOriginate is the vocabulary the router states for /routing/bgp/session output.default-originate. 

const (
	RoutingBgpSessionOutputDefaultOriginateAlways      RoutingBgpSessionOutputDefaultOriginate = "always"
	RoutingBgpSessionOutputDefaultOriginateIfInstalled RoutingBgpSessionOutputDefaultOriginate = "if-installed"
	RoutingBgpSessionOutputDefaultOriginateNever       RoutingBgpSessionOutputDefaultOriginate = "never"
)

type RoutingBgpSessionRemoteAfi 

type RoutingBgpSessionRemoteAfi string

RoutingBgpSessionRemoteAfi is the vocabulary the router states for /routing/bgp/session remote.afi. 

const (
	RoutingBgpSessionRemoteAfiEvpn       RoutingBgpSessionRemoteAfi = "evpn"
	RoutingBgpSessionRemoteAfiIp         RoutingBgpSessionRemoteAfi = "ip"
	RoutingBgpSessionRemoteAfiIpv6       RoutingBgpSessionRemoteAfi = "ipv6"
	RoutingBgpSessionRemoteAfiL2vpn      RoutingBgpSessionRemoteAfi = "l2vpn"
	RoutingBgpSessionRemoteAfiL2vpnCisco RoutingBgpSessionRemoteAfi = "l2vpn-cisco"
	RoutingBgpSessionRemoteAfiVpnv4      RoutingBgpSessionRemoteAfi = "vpnv4"
	RoutingBgpSessionRemoteAfiVpnv6      RoutingBgpSessionRemoteAfi = "vpnv6"
)

type RoutingBgpSessionRemoteCapabilities 

type RoutingBgpSessionRemoteCapabilities string

RoutingBgpSessionRemoteCapabilities is the vocabulary the router states for /routing/bgp/session remote.capabilities. 

const (
	RoutingBgpSessionRemoteCapabilitiesAp   RoutingBgpSessionRemoteCapabilities = "ap"
	RoutingBgpSessionRemoteCapabilitiesAs4  RoutingBgpSessionRemoteCapabilities = "as4"
	RoutingBgpSessionRemoteCapabilitiesDyn  RoutingBgpSessionRemoteCapabilities = "dyn"
	RoutingBgpSessionRemoteCapabilitiesEm   RoutingBgpSessionRemoteCapabilities = "em"
	RoutingBgpSessionRemoteCapabilitiesEnhe RoutingBgpSessionRemoteCapabilities = "enhe"
	RoutingBgpSessionRemoteCapabilitiesErr  RoutingBgpSessionRemoteCapabilities = "err"
	RoutingBgpSessionRemoteCapabilitiesFqdn RoutingBgpSessionRemoteCapabilities = "fqdn"
	RoutingBgpSessionRemoteCapabilitiesGr   RoutingBgpSessionRemoteCapabilities = "gr"
	RoutingBgpSessionRemoteCapabilitiesLlgr RoutingBgpSessionRemoteCapabilities = "llgr"
	RoutingBgpSessionRemoteCapabilitiesMl   RoutingBgpSessionRemoteCapabilities = "ml"
	RoutingBgpSessionRemoteCapabilitiesMp   RoutingBgpSessionRemoteCapabilities = "mp"
	RoutingBgpSessionRemoteCapabilitiesMs   RoutingBgpSessionRemoteCapabilities = "ms"
	RoutingBgpSessionRemoteCapabilitiesOrf  RoutingBgpSessionRemoteCapabilities = "orf"
	RoutingBgpSessionRemoteCapabilitiesRole RoutingBgpSessionRemoteCapabilities = "role"
	RoutingBgpSessionRemoteCapabilitiesRr   RoutingBgpSessionRemoteCapabilities = "rr"
	RoutingBgpSessionRemoteCapabilitiesSec  RoutingBgpSessionRemoteCapabilities = "sec"
)

type RoutingBgpSessionRemoteEor 

type RoutingBgpSessionRemoteEor string

RoutingBgpSessionRemoteEor is the vocabulary the router states for /routing/bgp/session remote.eor. 

const (
	RoutingBgpSessionRemoteEorEvpn       RoutingBgpSessionRemoteEor = "evpn"
	RoutingBgpSessionRemoteEorIp         RoutingBgpSessionRemoteEor = "ip"
	RoutingBgpSessionRemoteEorIpv6       RoutingBgpSessionRemoteEor = "ipv6"
	RoutingBgpSessionRemoteEorL2vpn      RoutingBgpSessionRemoteEor = "l2vpn"
	RoutingBgpSessionRemoteEorL2vpnCisco RoutingBgpSessionRemoteEor = "l2vpn-cisco"
	RoutingBgpSessionRemoteEorVpnv4      RoutingBgpSessionRemoteEor = "vpnv4"
	RoutingBgpSessionRemoteEorVpnv6      RoutingBgpSessionRemoteEor = "vpnv6"
)

type RoutingBgpSessionRemoteGrAfi 

type RoutingBgpSessionRemoteGrAfi string

RoutingBgpSessionRemoteGrAfi is the vocabulary the router states for /routing/bgp/session remote.gr-afi. 

const (
	RoutingBgpSessionRemoteGrAfiIp         RoutingBgpSessionRemoteGrAfi = "ip"
	RoutingBgpSessionRemoteGrAfiIpv6       RoutingBgpSessionRemoteGrAfi = "ipv6"
	RoutingBgpSessionRemoteGrAfiL2vpn      RoutingBgpSessionRemoteGrAfi = "l2vpn"
	RoutingBgpSessionRemoteGrAfiL2vpnCisco RoutingBgpSessionRemoteGrAfi = "l2vpn-cisco"
	RoutingBgpSessionRemoteGrAfiVpnv4      RoutingBgpSessionRemoteGrAfi = "vpnv4"
	RoutingBgpSessionRemoteGrAfiVpnv6      RoutingBgpSessionRemoteGrAfi = "vpnv6"
)

type RoutingBgpSessionRemoteGrAfiFwp 

type RoutingBgpSessionRemoteGrAfiFwp string

RoutingBgpSessionRemoteGrAfiFwp is the vocabulary the router states for /routing/bgp/session remote.gr-afi-fwp. 

const (
	RoutingBgpSessionRemoteGrAfiFwpIp         RoutingBgpSessionRemoteGrAfiFwp = "ip"
	RoutingBgpSessionRemoteGrAfiFwpIpv6       RoutingBgpSessionRemoteGrAfiFwp = "ipv6"
	RoutingBgpSessionRemoteGrAfiFwpL2vpn      RoutingBgpSessionRemoteGrAfiFwp = "l2vpn"
	RoutingBgpSessionRemoteGrAfiFwpL2vpnCisco RoutingBgpSessionRemoteGrAfiFwp = "l2vpn-cisco"
	RoutingBgpSessionRemoteGrAfiFwpVpnv4      RoutingBgpSessionRemoteGrAfiFwp = "vpnv4"
	RoutingBgpSessionRemoteGrAfiFwpVpnv6      RoutingBgpSessionRemoteGrAfiFwp = "vpnv6"
)

type RoutingBgpSessionRemoteRole 

type RoutingBgpSessionRemoteRole string

RoutingBgpSessionRemoteRole is the vocabulary the router states for /routing/bgp/session remote.role. 

const (
	RoutingBgpSessionRemoteRoleCustomer          RoutingBgpSessionRemoteRole = "customer"
	RoutingBgpSessionRemoteRolePeer              RoutingBgpSessionRemoteRole = "peer"
	RoutingBgpSessionRemoteRoleProvider          RoutingBgpSessionRemoteRole = "provider"
	RoutingBgpSessionRemoteRoleRouteServer       RoutingBgpSessionRemoteRole = "route-server"
	RoutingBgpSessionRemoteRoleRouteServerClient RoutingBgpSessionRemoteRole = "route-server-client"
)

type SystemHealth 

type SystemHealth struct {
	// ID is the router's own row handle. It is reassigned when a row is
	// deleted and recreated, so it addresses a row and does not identify one.
	ID string

	Name  string // name (read-only, string)
	Type  string // type (read-only)
	Value string // value (read-only, integer number)
}

Omitted, the router having stated no type: state-after-reboot.

func DecodeSystemHealth 

func DecodeSystemHealth(r map[string]string) SystemHealth

DecodeSystemHealth reads one record as the router returned it.

func (SystemHealth) Encode 

func (v SystemHealth) Encode() map[string]string

Encode returns the writable fields as the router expects them. SystemHealth has none: the device maintains this menu.

type SystemResource 

type SystemResource struct {
	ArchitectureName     string        // architecture-name (read-only, string value)
	BoardName            string        // board-name (read-only, string value)
	BuildTime            string        // build-time (read-only, date time)
	Cpu                  string        // cpu (read-only, string value)
	CpuCount             int64         // cpu-count (read-only, integer number)
	CpuLoad              int64         // cpu-load (read-only, integer number)
	FreeHddSpace         int64         // free-hdd-space (read-only, integer number)
	FreeMemory           int64         // free-memory (read-only, integer number)
	Platform             string        // platform (read-only, string value)
	TotalHddSpace        int64         // total-hdd-space (read-only, integer number)
	TotalMemory          int64         // total-memory (read-only, integer number)
	Uptime               time.Duration // uptime (read-only, time interval)
	Version              string        // version (read-only, string value)
	WriteSectSinceReboot int64         // write-sect-since-reboot (read-only, integer number)
	WriteSectTotal       int64         // write-sect-total (read-only, integer number)
}

Omitted, the router having stated no type: bad-blocks, cpu-frequency, factory-software.

func DecodeSystemResource 

func DecodeSystemResource(r map[string]string) SystemResource

DecodeSystemResource reads one record as the router returned it.

func (SystemResource) Encode 

func (v SystemResource) Encode() map[string]string

Encode returns the writable fields as the router expects them. SystemResource has none: the device maintains this menu.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.