tunnel_mib

package
v0.0.0-...-50def94 Latest Latest
Warning

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

 Go to latest Published: Nov 2, 2023 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

The MIB module for management of IP Tunnels, independent of the specific encapsulation scheme in use.

Copyright (C) The Internet Society (2005). This version of this MIB module is part of RFC 4087; see the RFC itself for full legal notices.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type TUNNELMIB 

type TUNNELMIB struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// The (conceptual) table containing information on configured tunnels.
	TunnelIfTable TUNNELMIB_TunnelIfTable

	// The (conceptual) table containing information on configured tunnels.  This
	// table can be used to map a set of tunnel endpoints to the associated
	// ifIndex value.  It can also be used for row creation.  Note that every row
	// in the tunnelIfTable with a fixed IPv4 destination address should have a
	// corresponding row in the tunnelConfigTable, regardless of whether it was
	// created via SNMP.  Since this table does not support IPv6, it is deprecated
	// in favor of tunnelInetConfigTable.
	TunnelConfigTable TUNNELMIB_TunnelConfigTable

	// The (conceptual) table containing information on configured tunnels.  This
	// table can be used to map a set of tunnel endpoints to the associated
	// ifIndex value.  It can also be used for row creation.  Note that every row
	// in the tunnelIfTable with a fixed destination address should have a
	// corresponding row in the tunnelInetConfigTable, regardless of whether it
	// was created via SNMP.
	TunnelInetConfigTable TUNNELMIB_TunnelInetConfigTable
}

TUNNELMIB

func (*TUNNELMIB) GetEntityData 

func (tUNNELMIB *TUNNELMIB) GetEntityData() *types.CommonEntityData

type TUNNELMIB_TunnelConfigTable 

type TUNNELMIB_TunnelConfigTable struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// An entry (conceptual row) containing the information on a particular
	// configured tunnel.  Since this entry does not support IPv6, it is
	// deprecated in favor of tunnelInetConfigEntry. The type is slice of
	// TUNNELMIB_TunnelConfigTable_TunnelConfigEntry.
	TunnelConfigEntry []*TUNNELMIB_TunnelConfigTable_TunnelConfigEntry
}

TUNNELMIB_TunnelConfigTable The (conceptual) table containing information on configured tunnels. This table can be used to map a set of tunnel endpoints to the associated ifIndex value. It can also be used for row creation. Note that every row in the tunnelIfTable with a fixed IPv4 destination address should have a corresponding row in the tunnelConfigTable, regardless of whether it was created via SNMP.

Since this table does not support IPv6, it is deprecated in favor of tunnelInetConfigTable.

func (*TUNNELMIB_TunnelConfigTable) GetEntityData 

func (tunnelConfigTable *TUNNELMIB_TunnelConfigTable) GetEntityData() *types.CommonEntityData

type TUNNELMIB_TunnelConfigTable_TunnelConfigEntry 

type TUNNELMIB_TunnelConfigTable_TunnelConfigEntry struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YListKey   string

	// This attribute is a key. The address of the local endpoint of the tunnel,
	// or 0.0.0.0 if the device is free to choose any of its addresses at tunnel
	// establishment time.  Since this object does not support IPv6, it is
	// deprecated in favor of tunnelInetConfigLocalAddress. The type is string
	// with pattern:
	// (([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?.
	TunnelConfigLocalAddress interface{}

	// This attribute is a key. The address of the remote endpoint of the tunnel.
	// Since this object does not support IPv6, it is deprecated in favor of
	// tunnelInetConfigRemoteAddress. The type is string with pattern:
	// (([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?.
	TunnelConfigRemoteAddress interface{}

	// This attribute is a key. The encapsulation method used by the tunnel.
	// Since this object does not support IPv6, it is deprecated in favor of
	// tunnelInetConfigEncapsMethod. The type is IANAtunnelType.
	TunnelConfigEncapsMethod interface{}

	// This attribute is a key. An identifier used to distinguish between multiple
	// tunnels of the same encapsulation method, with the same endpoints.  If the
	// encapsulation protocol only allows one tunnel per set of endpoint addresses
	// (such as for GRE or IP-in-IP), the value of this object is 1.  For
	// encapsulation methods (such as L2F) which allow multiple parallel tunnels,
	// the manager is responsible for choosing any ID which does not conflict with
	// an existing row, such as choosing a random number.  Since this object does
	// not support IPv6, it is deprecated in favor of tunnelInetConfigID. The type
	// is interface{} with range: 1..2147483647.
	TunnelConfigID interface{}

	// If the value of tunnelConfigStatus for this row is active, then this object
	// contains the value of ifIndex corresponding to the tunnel interface.  A
	// value of 0 is not legal in the active state, and means that the interface
	// index has not yet been assigned.  Since this object does not support IPv6,
	// it is deprecated in favor of tunnelInetConfigIfIndex. The type is
	// interface{} with range: 0..2147483647.
	TunnelConfigIfIndex interface{}

	// The status of this row, by which new entries may be created, or old entries
	// deleted from this table.  The agent need not support setting this object to
	// createAndWait or notInService since there are no other writable objects in
	// this table, and writable objects in rows of corresponding tables such as
	// the tunnelIfTable may be modified while this row is active.  To create a
	// row in this table for an encapsulation method which does not support
	// multiple parallel tunnels with the same endpoints, the management station
	// should simply use a tunnelConfigID of 1, and set tunnelConfigStatus to
	// createAndGo.  For encapsulation methods such as L2F which allow multiple
	// parallel tunnels, the management station may select a pseudo-random number
	// to use as the tunnelConfigID and set tunnelConfigStatus to createAndGo.  In
	// the event that this ID is already in use and an inconsistentValue is
	// returned in response to the set operation, the management station should
	// simply select a new pseudo-random number and retry the operation.  Creating
	// a row in this table will cause an interface index to be assigned by the
	// agent in an implementation-dependent manner, and corresponding rows will be
	// instantiated in the ifTable and the tunnelIfTable.  The status of this row
	// will become active as soon as the agent assigns the interface index,
	// regardless of whether the interface is operationally up.  Deleting a row in
	// this table will likewise delete the corresponding row in the ifTable and in
	// the tunnelIfTable.  Since this object does not support IPv6, it is
	// deprecated in favor of tunnelInetConfigStatus. The type is RowStatus.
	TunnelConfigStatus interface{}
}

TUNNELMIB_TunnelConfigTable_TunnelConfigEntry An entry (conceptual row) containing the information on a particular configured tunnel.

Since this entry does not support IPv6, it is deprecated in favor of tunnelInetConfigEntry.

func (*TUNNELMIB_TunnelConfigTable_TunnelConfigEntry) GetEntityData 

func (tunnelConfigEntry *TUNNELMIB_TunnelConfigTable_TunnelConfigEntry) GetEntityData() *types.CommonEntityData

type TUNNELMIB_TunnelIfTable 

type TUNNELMIB_TunnelIfTable struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// An entry (conceptual row) containing the information on a particular
	// configured tunnel. The type is slice of
	// TUNNELMIB_TunnelIfTable_TunnelIfEntry.
	TunnelIfEntry []*TUNNELMIB_TunnelIfTable_TunnelIfEntry
}

TUNNELMIB_TunnelIfTable The (conceptual) table containing information on configured tunnels.

func (*TUNNELMIB_TunnelIfTable) GetEntityData 

func (tunnelIfTable *TUNNELMIB_TunnelIfTable) GetEntityData() *types.CommonEntityData

type TUNNELMIB_TunnelIfTable_TunnelIfEntry 

type TUNNELMIB_TunnelIfTable_TunnelIfEntry struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YListKey   string

	// This attribute is a key. The type is string with range: 1..2147483647.
	// Refers to if_mib.IFMIB_IfTable_IfEntry_IfIndex
	IfIndex interface{}

	// The address of the local endpoint of the tunnel (i.e., the source address
	// used in the outer IP header), or 0.0.0.0 if unknown or if the tunnel is
	// over IPv6.  Since this object does not support IPv6, it is deprecated in
	// favor of tunnelIfLocalInetAddress. The type is string with pattern:
	// (([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?.
	TunnelIfLocalAddress interface{}

	// The address of the remote endpoint of the tunnel (i.e., the destination
	// address used in the outer IP header), or 0.0.0.0 if unknown, or an IPv6
	// address, or  the tunnel is not a point-to-point link (e.g., if it is a 6to4
	// tunnel).  Since this object does not support IPv6, it is deprecated in
	// favor of tunnelIfRemoteInetAddress. The type is string with pattern:
	// (([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?.
	TunnelIfRemoteAddress interface{}

	// The encapsulation method used by the tunnel. The type is IANAtunnelType.
	TunnelIfEncapsMethod interface{}

	// The IPv4 TTL or IPv6 Hop Limit to use in the outer IP header.  A value of 0
	// indicates that the value is copied from the payload's header. The type is
	// interface{} with range: 0..255.
	TunnelIfHopLimit interface{}

	// The method used by the tunnel to secure the outer IP header.  The value
	// ipsec indicates that IPsec is used between the tunnel endpoints for
	// authentication or encryption or both.  More specific security-related
	// information may be available in a MIB module for the security protocol in
	// use. The type is TunnelIfSecurity.
	TunnelIfSecurity interface{}

	// The method used to set the high 6 bits (the  differentiated services
	// codepoint) of the IPv4 TOS or IPv6 Traffic Class in the outer IP header.  A
	// value of -1 indicates that the bits are copied from the payload's header.
	// A value of -2 indicates that a traffic conditioner is invoked and more
	// information may be available in a traffic conditioner MIB module. A value
	// between 0 and 63 inclusive indicates that the bit field is set to the
	// indicated value.  Note: instead of the name tunnelIfTOS, a better name
	// would have been tunnelIfDSCPMethod, but the existing name appeared in RFC
	// 2667 and existing objects cannot be renamed. The type is interface{} with
	// range: -2..63.
	TunnelIfTOS interface{}

	// The method used to set the IPv6 Flow Label value. This object need not be
	// present in rows where tunnelIfAddressType indicates the tunnel is not over
	// IPv6.  A value of -1 indicates that a traffic conditioner is invoked and
	// more information may be available in a traffic conditioner MIB.  Any other
	// value indicates that the Flow Label field is set to the indicated value.
	// The type is interface{} with range: -1..100.
	TunnelIfFlowLabel interface{}

	// The type of address in the corresponding tunnelIfLocalInetAddress and
	// tunnelIfRemoteInetAddress objects. The type is InetAddressType.
	TunnelIfAddressType interface{}

	// The address of the local endpoint of the tunnel (i.e., the source address
	// used in the outer IP header).  If the address is unknown, the value is
	// 0.0.0.0 for IPv4 or :: for IPv6.  The type of this object is given by
	// tunnelIfAddressType. The type is string with length: 0..255.
	TunnelIfLocalInetAddress interface{}

	// The address of the remote endpoint of the tunnel (i.e., the destination
	// address used in the outer IP header).  If the address is unknown or the
	// tunnel is not a point-to-point link (e.g., if it is a 6to4 tunnel), the
	// value is 0.0.0.0 for tunnels over IPv4 or :: for tunnels over IPv6.  The
	// type of this object is given by tunnelIfAddressType. The type is string
	// with length: 0..255.
	TunnelIfRemoteInetAddress interface{}

	// The maximum number of additional encapsulations permitted for packets
	// undergoing encapsulation at this node.  A value of -1 indicates that no
	// limit is present (except as a result of the packet size). The type is
	// interface{} with range: -1..255.
	TunnelIfEncapsLimit interface{}
}

TUNNELMIB_TunnelIfTable_TunnelIfEntry An entry (conceptual row) containing the information on a particular configured tunnel.

func (*TUNNELMIB_TunnelIfTable_TunnelIfEntry) GetEntityData 

func (tunnelIfEntry *TUNNELMIB_TunnelIfTable_TunnelIfEntry) GetEntityData() *types.CommonEntityData

type TUNNELMIB_TunnelIfTable_TunnelIfEntry_TunnelIfSecurity 

type TUNNELMIB_TunnelIfTable_TunnelIfEntry_TunnelIfSecurity string

TUNNELMIB_TunnelIfTable_TunnelIfEntry_TunnelIfSecurity represents security protocol in use. 

const (
	TUNNELMIB_TunnelIfTable_TunnelIfEntry_TunnelIfSecurity_none TUNNELMIB_TunnelIfTable_TunnelIfEntry_TunnelIfSecurity = "none"

	TUNNELMIB_TunnelIfTable_TunnelIfEntry_TunnelIfSecurity_ipsec TUNNELMIB_TunnelIfTable_TunnelIfEntry_TunnelIfSecurity = "ipsec"

	TUNNELMIB_TunnelIfTable_TunnelIfEntry_TunnelIfSecurity_other TUNNELMIB_TunnelIfTable_TunnelIfEntry_TunnelIfSecurity = "other"
)

type TUNNELMIB_TunnelInetConfigTable 

type TUNNELMIB_TunnelInetConfigTable struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// An entry (conceptual row) containing the information on a particular
	// configured tunnel.  Note that there is a 128 subid maximum for object OIDs.
	// Implementers need to be aware that if the total number of octets in
	// tunnelInetConfigLocalAddress and tunnelInetConfigRemoteAddress exceeds 110
	// then OIDs of column instances in this table will have more than 128
	// sub-identifiers and cannot be accessed using SNMPv1, SNMPv2c, or SNMPv3.
	// In practice this is not expected to be a problem since IPv4 and IPv6
	// addresses will not cause the limit to be reached, but if other types are
	// supported by an agent, care must be taken to ensure that the sum of the
	// lengths do not cause the limit to be exceeded. The type is slice of
	// TUNNELMIB_TunnelInetConfigTable_TunnelInetConfigEntry.
	TunnelInetConfigEntry []*TUNNELMIB_TunnelInetConfigTable_TunnelInetConfigEntry
}

TUNNELMIB_TunnelInetConfigTable The (conceptual) table containing information on configured tunnels. This table can be used to map a set of tunnel endpoints to the associated ifIndex value. It can also be used for row creation. Note that every row in the tunnelIfTable with a fixed destination address should have a corresponding row in the tunnelInetConfigTable, regardless of whether it was created via SNMP.

func (*TUNNELMIB_TunnelInetConfigTable) GetEntityData 

func (tunnelInetConfigTable *TUNNELMIB_TunnelInetConfigTable) GetEntityData() *types.CommonEntityData

type TUNNELMIB_TunnelInetConfigTable_TunnelInetConfigEntry 

type TUNNELMIB_TunnelInetConfigTable_TunnelInetConfigEntry struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YListKey   string

	// This attribute is a key. The address type over which the tunnel
	// encapsulates packets. The type is InetAddressType.
	TunnelInetConfigAddressType interface{}

	// This attribute is a key. The address of the local endpoint of the tunnel,
	// or 0.0.0.0 (for IPv4) or :: (for IPv6) if the device is free to choose any
	// of its addresses at tunnel establishment time. The type is string with
	// length: 0..255.
	TunnelInetConfigLocalAddress interface{}

	// This attribute is a key. The address of the remote endpoint of the tunnel.
	// The type is string with length: 0..255.
	TunnelInetConfigRemoteAddress interface{}

	// This attribute is a key. The encapsulation method used by the tunnel. The
	// type is IANAtunnelType.
	TunnelInetConfigEncapsMethod interface{}

	// This attribute is a key. An identifier used to distinguish between multiple
	// tunnels of the same encapsulation method, with the same endpoints.  If the
	// encapsulation protocol only allows one tunnel per set of endpoint addresses
	// (such as for GRE or IP-in-IP), the value of this object is 1.  For
	// encapsulation methods (such as L2F) which allow multiple parallel tunnels,
	// the manager is responsible for choosing any ID which does not  conflict
	// with an existing row, such as choosing a random number. The type is
	// interface{} with range: 1..2147483647.
	TunnelInetConfigID interface{}

	// If the value of tunnelInetConfigStatus for this row is active, then this
	// object contains the value of ifIndex corresponding to the tunnel interface.
	// A value of 0 is not legal in the active state, and means that the interface
	// index has not yet been assigned. The type is interface{} with range:
	// 0..2147483647.
	TunnelInetConfigIfIndex interface{}

	// The status of this row, by which new entries may be created, or old entries
	// deleted from this table.  The agent need not support setting this object to
	// createAndWait or notInService since there are no other writable objects in
	// this table, and writable objects in rows of corresponding tables such as
	// the tunnelIfTable may be modified while this row is active.  To create a
	// row in this table for an encapsulation method which does not support
	// multiple parallel tunnels with the same endpoints, the management station
	// should simply use a tunnelInetConfigID of 1, and set tunnelInetConfigStatus
	// to createAndGo.  For encapsulation methods such as L2F which allow multiple
	// parallel tunnels, the management station may select a pseudo-random number
	// to use as the tunnelInetConfigID and set tunnelInetConfigStatus to
	// createAndGo.  In the event that this ID is already in use and an
	// inconsistentValue is returned in response to the set operation, the
	// management station should simply select a new pseudo-random number and
	// retry the operation.  Creating a row in this table will cause an interface
	// index to be assigned by the agent in an implementation-dependent manner,
	// and corresponding rows will be instantiated in the ifTable and the
	// tunnelIfTable.  The status of this row will become active as soon as the
	// agent assigns the interface index, regardless of whether the interface is
	// operationally up.  Deleting a row in this table will likewise delete the
	// corresponding row in the ifTable and in the tunnelIfTable. The type is
	// RowStatus.
	TunnelInetConfigStatus interface{}

	// The storage type of this row.  If the row is permanent(4), no objects in
	// the row need be writable. The type is StorageType.
	TunnelInetConfigStorageType interface{}
}

TUNNELMIB_TunnelInetConfigTable_TunnelInetConfigEntry An entry (conceptual row) containing the information on a particular configured tunnel. Note that there is a 128 subid maximum for object OIDs. Implementers need to be aware that if the total number of octets in tunnelInetConfigLocalAddress and tunnelInetConfigRemoteAddress exceeds 110 then OIDs of column instances in this table will have more than 128 sub-identifiers and cannot be accessed using SNMPv1, SNMPv2c, or SNMPv3. In practice this is not expected to be a problem since IPv4 and IPv6 addresses will not cause the limit to be reached, but if other types are supported by an agent, care must be taken to ensure that the sum of the lengths do not cause the limit to be exceeded.

func (*TUNNELMIB_TunnelInetConfigTable_TunnelInetConfigEntry) GetEntityData 

func (tunnelInetConfigEntry *TUNNELMIB_TunnelInetConfigTable_TunnelInetConfigEntry) GetEntityData() *types.CommonEntityData

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.