# Functions
Acl factory function to initiallize Acl resource given a Node.
Bgp factory function to initiallize BGPEntity resource given a Node.
BgpNeighbors factory function to initiallize BgpNeighborsEntity resource given a Node.
EthernetInterface factory function to initiallize EthernetInterfaceEntity resource given a Node.
Interface factory function to initiallize BaseInterfaceEntity resource given a Node.
IPInterface factory function to initiallize IPInterface resource given a Node.
Mlag factory function to initiallize MlagEntity resource given a Node.
PortChannel factory function to initiallize VxlanInterfaceEntity resource given a Node.
Ptp factory function to initiallize PTPEntity resource given a Node.
PTPInterfaces factory function to initiallize PTPInterfaceEntity resource given a Node.
Show factory function to initiallize Show resource given a Node.
Stp factory function to initiallize STPEntity resource given a Node.
STPInstance factory function to initiallize STPInstanceEntity resource given a Node.
STPInterfaces factory function to initiallize STPInterfaceEntity resource given a Node.
SwitchPort factory function to initiallize SwitchPortEntity resource given a Node.
System factory function to initiallize System resource given a Node.
User factory function to initiallize User resource given a Node.
Vlan factory function to initiallize Vlans resource given a Node.
Vxlan factory function to initiallize VxlanInterfaceEntity resource given a Node.
# Structs
AbstractBaseEntity object for all resources to derive from
This AbstractBaseEntity object should not be directly instatiated.
AclConfig represents an Acl Config entry with a name, type, and individual entries in AclEntryMap.
AclEntity provides a configuration resource for Acl.
BaseInterfaceEntity provides a configuration resource for Interface.
BgpConfig represents the parsed Bgp config for an interface.
BGPEntity provides a configuration resource for Bgp.
BgpNeighborsEntity provides a configuration resource for Bgp neighbors.
No description provided by the author
EthernetInterfaceEntity provides a configuration resource for Ethernet Interface.
EthInterfaceCounters defined data structure for mapping JSON response of 'show interface' to manageable object.
InterfaceAddress defined data structure for mapping JSON response of 'show interface' to manageable object.
InterfaceStatistics defined data structure for mapping JSON response of 'show interface' to manageable object.
IPAddress defined data structure for mapping JSON response of 'show interface' to manageable object.
IPInterfaceEntity provides a configuration resource for IpInterfaces.
No description provided by the author
No description provided by the author
No description provided by the author
MlagConfig represents an Mlag Config entry.
MlagEntity provides a configuration resource for Mlags.
PhysicalInputErrors defined data structure for mapping JSON response of 'show interface' to manageable object.
PhysicalOutputErrors defined data structure for mapping JSON response of 'show interface' to manageable object.
PortChannelInterfaceEntity provides a configuration resource for PortChannel.
PtpClockSummary represents common data in "show ptp" output.
PtpConfig represents the parsed ptp config.
PTPEntity provides a configuration resource for ptp.
PTPInterfaceEntity provides a configuration resource for PTP.
PtpIntf represents inidividual interface in "show ptp" output.
No description provided by the author
No description provided by the author
No description provided by the author
ShowEntity provides a configuration resource for VLANs.
No description provided by the author
ShowInterface defined data structure for mapping JSON response of 'show interface' to manageable object.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ShowPTP represents "show ptp" output.
ShowTrunkGroup defined data structure for mapping JSON response of 'show vlan trunk group' to manageable object.
ShowVersion defined data structure for mapping JSON response of 'show version' to manageable object.
STPEntity provides a configuration resource for STP.
STPInstanceEntity provides a configuration resource for STPInstance.
STPInterfaceEntity provides a configuration resource for STP.
SwitchInterface defined data structure for mapping JSON response of 'show interface' to manageable object.
No description provided by the author
SwitchPortEntity provides a configuration resource for SwitchPorts
Logical layer 2 interfaces built on top of physical Ethernet and bundled Port-Channel interfaces can be configured and managed with an instance of Switchport.
No description provided by the author
SystemEntity provides a configuration resource for System.
UserEntity resource provides configuration for local user resources of an EOS node.
VlanEntity provides a configuration resource for VLANs.
No description provided by the author
VxlanInterfaceEntity provides a configuration resource for Vxlan.
# Type aliases
AclEntry represents a parsed Acl entry of the form { "action" : "" "srcaddr" : "" "srclen" : "" "log" : "" }.
AclEntryMap is a key/value.
BgpNeighborCollection is a collection of BgpNeighborConfigs.
BgpNeighborConfig represents the parsed Bgp neighbor config { "peer_group" : "peer1", "remote_as" : "99", "send_community" : "true", "shutdown" : "false", "description" : "This is a bgp entity", "next_hop_self" : "1.1.1.1", "route_in_map" : "in-map", "route_out_map" : "out-map", }.
BgpNetworkEntry represents a BGP network config entry.
GlobalMlagConfig represents a parsed Global Mlag entry { "domain_id" : "2", "local_interface": "1.1.1.1", "peer_address" : "2.2.2.2", "peer_link" : "Ethernet1", "shutdown" : "false", }.
InterfaceConfig represents the parsed Interface config { "name" : "ethernet1", "type" : "generic", "shutdown" : "false", "description" : "Backhaul-to-East", }.
InterfaceMlagConfig represents the parsed Mlag config for all interfaces { "Port-Channel1" : "2", "Port-Channel10" : "5", ..
IPInterfaceConfig represents a parsed IPInterface entry.
IPInterfaceConfigMap represents a hash of various IPInterfaceConfig's.
PTPInterfaceCollection is a collection of PTPInterfaceConfigs mapped by interface name: { "Ethernet49/1" : PTPInterfaceConfig { "enabled" : "false", "role" : "dynamic", "transport" : "layer2", }, "Ethernet1" : ..
PTPInterfaceConfig represents the parsed PTP interface config { "enabled" : "true", "role" : "dynamic", "transport" : "layer2", }.
STPInterfaceCollection is a collection of STPInterfaceConfigs mapped by interface name: { "Port-Channel1" : STPInterfaceConfig { "bpduguard" : "false", "portfast" : "true", "portfast_type" : "edge", }, "Ethernet1" : ..
STPInterfaceConfig represents the parsed STP interface config { "bpduguard" : "false", "portfast" : "true", "portfast_type" : "edge", }.
SwitchPortConfig represents a parsed SwitchPort entry.
SwitchPortConfigMap represents a parsed SwitchPort entry.
SystemConfig represents a parsed system entry containing.
UserConfig represents a parsed user entry containing:
"username" : "", "privilege" : "", "role" : "", "nopassword" : "", "secret" : "", "format" : "", "sshkey" : "",
.
UserConfigMap is a mapped entry of UserConfigs containing:
"username" : { "username" : "", "privilege" : "", "role" : "", "nopassword" : "", "secret" : "", "format" : "", "sshkey" : "", }
.
VlanConfig represents a parsed vlan entry containing.
VlanConfigMap represents a parsed vlan entry containing.
VxlanConfigCollection is a collection of Vxlan interfaces { "1" : VxlanInterfaceConfig{}, }.
VxlanInterfaceConfig represents the parsed Vxlan interface config {
"name" : "Vxlan1" "type" : "vxlan" "shutdown" : "false" "description" : "" "source_interface" : "Ethernet1", "multicast_group" : "", "udp_port" : "1024", "flood_list" : "", }.