Management of the LLDP agent. More...

#include "core/net.h"
#include "lldp/lldp.h"

Functions
void	lldpMgmtLock (LldpAgentContext *context)
	Acquire exclusive access to the LLDP agent context. More...

void	lldpMgmtUnlock (LldpAgentContext *context)
	Release exclusive access to the LLDP agent context. More...

error_t	lldpMgmtSetMsgTxInterval (LldpAgentContext *context, uint_t msgTxInterval, bool_t commit)
	Set transmit interval. More...

error_t	lldpMgmtSetMsgTxHold (LldpAgentContext *context, uint_t msgTxHold, bool_t commit)
	Set transmit hold multiplier. More...

error_t	lldpMgmtSetReinitDelay (LldpAgentContext *context, uint_t reinitDelay, bool_t commit)
	Set re-initialization delay. More...

error_t	lldpMgmtSetTxDelay (LldpAgentContext *context, uint_t txDelay, bool_t commit)
	Set transmit delay. More...

error_t	lldpMgmtSetNotificationInterval (LldpAgentContext *context, uint_t notificationInterval, bool_t commit)
	Set notification interval. More...

error_t	lldpMgmtSetAdminStatus (LldpAgentContext *context, uint_t portIndex, LldpAdminStatus adminStatus, bool_t commit)
	Set administrative status. More...

error_t	lldpMgmtSetNotificationEnable (LldpAgentContext *context, uint_t portIndex, bool_t notificationEnable, bool_t commit)
	Enable or disable notifications. More...

error_t	lldpMgmtSetBasicTlvFilter (LldpAgentContext *context, uint_t portIndex, uint8_t mask, bool_t commit)
	Set the list of TLVs enabled for transmission. More...

error_t	lldpMgmtGetMsgTxInterval (LldpAgentContext context, uint_t msgTxInterval)
	Get transmit interval. More...

error_t	lldpMgmtGetMsgTxHold (LldpAgentContext context, uint_t msgTxHold)
	Get transmit hold multiplier. More...

error_t	lldpMgmtGetReinitDelay (LldpAgentContext context, uint_t reinitDelay)
	Get re-initialization delay. More...

error_t	lldpMgmtGetTxDelay (LldpAgentContext context, uint_t txDelay)
	Get transmit delay. More...

error_t	lldpMgmtGetNotificationInterval (LldpAgentContext context, uint_t notificationInterval)
	Get notification interval. More...

error_t	lldpMgmtGetAdminStatus (LldpAgentContext context, uint_t portIndex, LldpAdminStatus adminStatus)
	Get administrative status. More...

error_t	lldpMgmtGetNotificationEnable (LldpAgentContext context, uint_t portIndex, bool_t notificationEnable)
	Check whether notifications are enabled or disabled. More...

error_t	lldpMgmtGetMibBasicTlvsTxEnable (LldpAgentContext context, uint_t portIndex, uint8_t mibBasicTlvsTxEnable)
	Get the list of TLVs enabled for transmission. More...

error_t	lldpMgmtGetLocalChassisId (LldpAgentContext context, LldpChassisIdSubtype chassisIdSubtype, const uint8_t *chassisId, size_t chassisIdLen)
	Extract chassis ID from local system MIB. More...

error_t	lldpMgmtGetLocalPortId (LldpAgentContext context, uint_t portIndex, LldpPortIdSubtype portIdSubtype, const uint8_t *portId, size_t portIdLen)
	Extract port ID from local system MIB. More...

error_t	lldpMgmtGetLocalPortDesc (LldpAgentContext context, uint_t portIndex, const char_t portDesc, size_t portDescLen)
	Extract port description from local system MIB. More...

error_t	lldpMgmtGetLocalSysName (LldpAgentContext context, const char_t sysName, size_t sysNameLen)
	Extract system name from local system MIB. More...

error_t	lldpMgmtGetLocalSysDesc (LldpAgentContext context, const char_t sysDesc, size_t sysDescLen)
	Extract system description from local system MIB. More...

error_t	lldpMgmtGetLocalSysCap (LldpAgentContext context, uint16_t supportedCap, uint16_t *enabledCap)
	Extract system capabilities from local system MIB. More...

int_t	lldpMgmtFindLocalMgmtAddr (LldpAgentContext context, uint8_t mgmtAddrSubtype, const uint8_t mgmtAddr, size_t mgmtAddrLen)
	Search the local system MIB for a given management address. More...

error_t	lldpMgmtGetLocalMgmtAddr (LldpAgentContext context, uint_t index, LldpMgmtAddrSubtype mgmtAddrSubtype, const uint8_t *mgmtAddr, size_t mgmtAddrLen, LldpIfNumSubtype ifNumSubtype, uint32_t ifNum, const uint8_t *oid, size_t oidLen)
	Extract management address from local system MIB. More...

LldpNeighborEntry *	lldpMgmtFindRemoteTableEntry (LldpAgentContext *context, uint32_t timeMark, uint_t portIndex, uint32_t index)
	Search the remote systems MIB for a given entry. More...

error_t	lldpMgmtGetRemoteChassisId (LldpNeighborEntry entry, LldpChassisIdSubtype chassisIdSubtype, const uint8_t *chassisId, size_t chassisIdLen)
	Extract chassis ID from remote systems MIB. More...

error_t	lldpMgmtGetRemotePortId (LldpNeighborEntry entry, LldpPortIdSubtype portIdSubtype, const uint8_t *portId, size_t portIdLen)
	Extract port ID from remote systems MIB. More...

error_t	lldpMgmtGetRemotePortDesc (LldpNeighborEntry entry, const char_t portDesc, size_t portDescLen)
	Extract port description from remote systems MIB. More...

error_t	lldpMgmtGetRemoteSysName (LldpNeighborEntry entry, const char_t sysName, size_t sysNameLen)
	Extract system name from remote systems MIB. More...

error_t	lldpMgmtGetRemoteSysDesc (LldpNeighborEntry entry, const char_t sysDesc, size_t sysDescLen)
	Extract system description from remote systems MIB. More...

error_t	lldpMgmtGetRemoteSysCap (LldpNeighborEntry entry, uint16_t supportedCap, uint16_t *enabledCap)
	Extract system capabilities from remote systems MIB. More...

int_t	lldpMgmtFindRemoteMgmtAddr (LldpNeighborEntry entry, uint8_t mgmtAddrSubtype, const uint8_t mgmtAddr, size_t mgmtAddrLen)
	Search the remote system MIB for a given management address. More...

error_t	lldpMgmtGetRemoteMgmtAddr (LldpNeighborEntry entry, uint_t index, LldpMgmtAddrSubtype mgmtAddrSubtype, const uint8_t *mgmtAddr, size_t mgmtAddrLen, LldpIfNumSubtype ifNumSubtype, uint32_t ifNum, const uint8_t *oid, size_t oidLen)
	Extract management address from remote systems MIB. More...

error_t	lldpMgmtGetRemoteUnknownTlv (LldpNeighborEntry entry, uint8_t type, uint_t index, const uint8_t info, size_t infoLen)
	Extract unknown TLV from remote systems MIB. More...

error_t	lldpMgmtGetRemoteOrgDefInfo (LldpNeighborEntry entry, uint32_t oui, uint8_t subtype, uint_t index, const uint8_t info, size_t infoLen)
	Extract organizationally defined TLV from remote systems MIB. More...

error_t	lldpMgmtGetStatsFramesOutTotal (LldpAgentContext context, uint_t portIndex, uint32_t statsFramesOutTotal)
	Get the value of the statsFramesOutTotal statistics counter. More...

error_t	lldpMgmtGetStatsFramesDiscardedTotal (LldpAgentContext context, uint_t portIndex, uint32_t statsFramesDiscardedTotal)
	Get the value of the statsFramesDiscardedTotal statistics counter. More...

error_t	lldpMgmtGetStatsFramesInErrorsTotal (LldpAgentContext context, uint_t portIndex, uint32_t statsFramesInErrorsTotal)
	Get the value of the statsFramesInErrorsTotal statistics counter. More...

error_t	lldpMgmtGetStatsFramesInTotal (LldpAgentContext context, uint_t portIndex, uint32_t statsFramesInTotal)
	Get the value of the statsFramesInTotal statistics counter. More...

error_t	lldpMgmtGetStatsTLVsDiscardedTotal (LldpAgentContext context, uint_t portIndex, uint32_t statsTLVsDiscardedTotal)
	Get the value of the statsTLVsDiscardedTotal statistics counter. More...

error_t	lldpMgmtGetStatsTLVsUnrecognizedTotal (LldpAgentContext context, uint_t portIndex, uint32_t statsTLVsUnrecognizedTotal)
	Get the value of the statsTLVsUnrecognizedTotal statistics counter. More...

error_t	lldpMgmtGetStatsAgeoutsTotal (LldpAgentContext context, uint_t portIndex, uint32_t statsAgeoutsTotal)
	Get the value of the statsAgeoutsTotal statistics counter. More...

error_t	lldpMgmtGetStatsRemTablesLastChangeTime (LldpAgentContext context, uint32_t statsRemTablesLastChangeTime)
	Get the value of the statsRemTablesLastChangeTime statistics counter. More...

error_t	lldpMgmtGetStatsRemTablesInserts (LldpAgentContext context, uint32_t statsRemTablesInserts)
	Get the value of the statsRemTablesInserts statistics counter. More...

error_t	lldpMgmtGetStatsRemTablesDeletes (LldpAgentContext context, uint32_t statsRemTablesDeletes)
	Get the value of the statsRemTablesDeletes statistics counter. More...

error_t	lldpMgmtGetStatsRemTablesDrops (LldpAgentContext context, uint32_t statsRemTablesDrops)
	Get the value of the statsRemTablesDrops statistics counter. More...

error_t	lldpMgmtGetStatsRemTablesAgeouts (LldpAgentContext context, uint32_t statsRemTablesAgeouts)
	Get the value of the statsRemTablesAgeouts statistics counter. More...

Detailed Description

Management of the LLDP agent.

License

SPDX-License-Identifier: GPL-2.0-or-later

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author: Oryx Embedded SARL (www.oryx-embedded.com)

Version: 2.4.4

Definition in file lldp_mgmt.h.

Function Documentation

◆ lldpMgmtFindLocalMgmtAddr()

int_t lldpMgmtFindLocalMgmtAddr	(	LldpAgentContext *	context,
		uint8_t	mgmtAddrSubtype,
		const uint8_t *	mgmtAddr,
		size_t	mgmtAddrLen
	)

Search the local system MIB for a given management address.

Parameters

[in]	context	Pointer to the LLDP agent context
[in]	mgmtAddrSubtype	Type of management address
[in]	mgmtAddr	Octet string indicating a particular management address
[in]	mgmtAddrLen	Length of the management address, in bytes

Returns: index Zero-based index corresponding to the management address

Definition at line 1023 of file lldp_mgmt.c.

◆ lldpMgmtFindRemoteMgmtAddr()

int_t lldpMgmtFindRemoteMgmtAddr	(	LldpNeighborEntry *	entry,
		uint8_t	mgmtAddrSubtype,
		const uint8_t *	mgmtAddr,
		size_t	mgmtAddrLen
	)

Search the remote system MIB for a given management address.

Parameters

[in]	entry	Pointer to a given entry of the remote systems MIB
[in]	mgmtAddrSubtype	Type of management address
[in]	mgmtAddr	Octet string indicating a particular management address
[in]	mgmtAddrLen	Length of the management address, in bytes

Returns: index Zero-based index corresponding to the management address

Definition at line 1539 of file lldp_mgmt.c.

◆ lldpMgmtFindRemoteTableEntry()

LldpNeighborEntry* lldpMgmtFindRemoteTableEntry	(	LldpAgentContext *	context,
		uint32_t	timeMark,
		uint_t	portIndex,
		uint32_t	index
	)

Search the remote systems MIB for a given entry.

Parameters

[in]	context	Pointer to the LLDP agent context
[in]	timeMark	Timestamp used to implement time-filtered rows
[in]	portIndex	Index value used to identify the port on which the remote system information was received
[in]	index	Arbitrary local integer value used to identify a particular connection

Returns: Pointer to the matching entry in the remote systems MIB

Definition at line 1218 of file lldp_mgmt.c.

◆ lldpMgmtGetAdminStatus()

error_t lldpMgmtGetAdminStatus	(	LldpAgentContext *	context,
		uint_t	portIndex,
		LldpAdminStatus *	adminStatus
	)

Get administrative status.

Parameters

[in]	context	Pointer to the LLDP agent context
[in]	portIndex	Port index
[out]	adminStatus	The administrative status indicates whether or not the local LLDP agent is enabled

Returns: Error code

Definition at line 580 of file lldp_mgmt.c.

◆ lldpMgmtGetLocalChassisId()

error_t lldpMgmtGetLocalChassisId	(	LldpAgentContext *	context,
		LldpChassisIdSubtype *	chassisIdSubtype,
		const uint8_t **	chassisId,
		size_t *	chassisIdLen
	)

Extract chassis ID from local system MIB.

Parameters

[in]	context	Pointer to the LLDP agent context
[out]	chassisIdSubtype	Type of identifier used for the chassis
[out]	chassisId	Administratively assigned name that identifies the chassis
[out]	chassisIdLen	Length of the chassis ID, in bytes

Returns: Error code

Definition at line 694 of file lldp_mgmt.c.

◆ lldpMgmtGetLocalMgmtAddr()

error_t lldpMgmtGetLocalMgmtAddr	(	LldpAgentContext *	context,
		uint_t	index,
		LldpMgmtAddrSubtype *	mgmtAddrSubtype,
		const uint8_t **	mgmtAddr,
		size_t *	mgmtAddrLen,
		LldpIfNumSubtype *	ifNumSubtype,
		uint32_t *	ifNum,
		const uint8_t **	oid,
		size_t *	oidLen
	)

Extract management address from local system MIB.

Parameters

[in]	context	Pointer to the LLDP agent context
[in]	index	Zero-based index identifying a management address
[out]	mgmtAddrSubtype	Type of management address
[out]	mgmtAddr	Octet string indicating a particular management address
[out]	mgmtAddrLen	Length of the management address, in bytes
[out]	ifNumSubtype	Numbering method used for defining the interface number
[out]	ifNum	Number within the system that identifies the specific interface associated with this management address
[out]	oid	OID that identifies the type of hardware component or protocol entity associated with the indicated management address
[out]	oidLen	Length of the OID, in bytes

Returns: Error code

Definition at line 1116 of file lldp_mgmt.c.

◆ lldpMgmtGetLocalPortDesc()

error_t lldpMgmtGetLocalPortDesc	(	LldpAgentContext *	context,
		uint_t	portIndex,
		const char_t **	portDesc,
		size_t *	portDescLen
	)

Extract port description from local system MIB.

Parameters

[in]	context	Pointer to the LLDP agent context
[in]	portIndex	Port index
[out]	portDesc	Station port's description
[out]	portDescLen	Length of the port description, in bytes

Returns: Error code

Definition at line 817 of file lldp_mgmt.c.

◆ lldpMgmtGetLocalPortId()

error_t lldpMgmtGetLocalPortId	(	LldpAgentContext *	context,
		uint_t	portIndex,
		LldpPortIdSubtype *	portIdSubtype,
		const uint8_t **	portId,
		size_t *	portIdLen
	)

Extract port ID from local system MIB.

Parameters

[in]	context	Pointer to the LLDP agent context
[in]	portIndex	Port index
[out]	portIdSubtype	Type of identifier used for the port
[out]	portId	Administratively assigned name that identifies the port
[out]	portIdLen	Length of the port ID, in bytes

Returns: Error code

Definition at line 752 of file lldp_mgmt.c.

◆ lldpMgmtGetLocalSysCap()

error_t lldpMgmtGetLocalSysCap	(	LldpAgentContext *	context,
		uint16_t *	supportedCap,
		uint16_t *	enabledCap
	)

Extract system capabilities from local system MIB.

Parameters

[in]	context	Pointer to the LLDP agent context
[out]	supportedCap	Bit-map of the capabilities supported by the system
[out]	enabledCap	Bit-map of the capabilities currently enabled

Returns: Error code

Definition at line 968 of file lldp_mgmt.c.

◆ lldpMgmtGetLocalSysDesc()

error_t lldpMgmtGetLocalSysDesc	(	LldpAgentContext *	context,
		const char_t **	sysDesc,
		size_t *	sysDescLen
	)

Extract system description from local system MIB.

Parameters

[in]	context	Pointer to the LLDP agent context
[out]	sysDesc	Textual description of the network entity
[out]	sysDescLen	Length of the system description, in bytes

Returns: Error code

Definition at line 919 of file lldp_mgmt.c.

◆ lldpMgmtGetLocalSysName()

error_t lldpMgmtGetLocalSysName	(	LldpAgentContext *	context,
		const char_t **	sysName,
		size_t *	sysNameLen
	)

Extract system name from local system MIB.

Parameters

[in]	context	Pointer to the LLDP agent context
[out]	sysName	System's administratively assigned name
[out]	sysNameLen	Length of the system name, in bytes

Returns: Error code

Definition at line 871 of file lldp_mgmt.c.

◆ lldpMgmtGetMibBasicTlvsTxEnable()

error_t lldpMgmtGetMibBasicTlvsTxEnable	(	LldpAgentContext *	context,
		uint_t	portIndex,
		uint8_t *	mibBasicTlvsTxEnable
	)

Get the list of TLVs enabled for transmission.

Parameters

[in]	context	Pointer to the LLDP agent context
[in]	portIndex	Port index
[out]	mibBasicTlvsTxEnable	Bit-map indicating the TLVs enabled for transmission

Returns: Error code

Definition at line 656 of file lldp_mgmt.c.

◆ lldpMgmtGetMsgTxHold()

error_t lldpMgmtGetMsgTxHold	(	LldpAgentContext *	context,
		uint_t *	msgTxHold
	)

Get transmit hold multiplier.

Parameters

[in]	context	Pointer to the LLDP agent context
[out]	msgTxHold	Multiplier on the msgTxInterval that determines the actual TTL value used in an LLDPDU

Returns: Error code

Definition at line 473 of file lldp_mgmt.c.

◆ lldpMgmtGetMsgTxInterval()

error_t lldpMgmtGetMsgTxInterval	(	LldpAgentContext *	context,
		uint_t *	msgTxInterval
	)

Get transmit interval.

Parameters

[in]	context	Pointer to the LLDP agent context
[out]	msgTxInterval	Time interval between successive transmit cycles, in seconds

Returns: Error code

Definition at line 445 of file lldp_mgmt.c.

◆ lldpMgmtGetNotificationEnable()

error_t lldpMgmtGetNotificationEnable	(	LldpAgentContext *	context,
		uint_t	portIndex,
		bool_t *	notificationEnable
	)

Check whether notifications are enabled or disabled.

Parameters

[in]	context	Pointer to the LLDP agent context
[in]	portIndex	Port index
[out]	notificationEnable	This parameter controls whether or not notifications from the agent are enabled

Returns: Error code

Definition at line 618 of file lldp_mgmt.c.

◆ lldpMgmtGetNotificationInterval()

error_t lldpMgmtGetNotificationInterval	(	LldpAgentContext *	context,
		uint_t *	notificationInterval
	)

Get notification interval.

Parameters

[in]	context	Pointer to the LLDP agent context
[out]	notificationInterval	Notification interval

Returns: Error code

Definition at line 551 of file lldp_mgmt.c.

◆ lldpMgmtGetReinitDelay()

error_t lldpMgmtGetReinitDelay	(	LldpAgentContext *	context,
		uint_t *	reinitDelay
	)

Get re-initialization delay.

Parameters

[in]	context	Pointer to the LLDP agent context
[out]	reinitDelay	Delay before re-initialization will be attempted

Returns: Error code

Definition at line 499 of file lldp_mgmt.c.

◆ lldpMgmtGetRemoteChassisId()

error_t lldpMgmtGetRemoteChassisId	(	LldpNeighborEntry *	entry,
		LldpChassisIdSubtype *	chassisIdSubtype,
		const uint8_t **	chassisId,
		size_t *	chassisIdLen
	)

Extract chassis ID from remote systems MIB.

Parameters

[in]	entry	Pointer to a given entry of the remote systems MIB
[out]	chassisIdSubtype	Type of identifier used for the chassis
[out]	chassisId	Administratively assigned name that identifies the chassis
[out]	chassisIdLen	Length of the chassis ID, in bytes

Returns: Error code

Definition at line 1257 of file lldp_mgmt.c.

◆ lldpMgmtGetRemoteMgmtAddr()

error_t lldpMgmtGetRemoteMgmtAddr	(	LldpNeighborEntry *	entry,
		uint_t	index,
		LldpMgmtAddrSubtype *	mgmtAddrSubtype,
		const uint8_t **	mgmtAddr,
		size_t *	mgmtAddrLen,
		LldpIfNumSubtype *	ifNumSubtype,
		uint32_t *	ifNum,
		const uint8_t **	oid,
		size_t *	oidLen
	)

Extract management address from remote systems MIB.

Parameters

[in]	entry	Pointer to a given entry of the remote systems MIB
[in]	index	Zero-based index identifying a management address
[out]	mgmtAddrSubtype	Type of management address
[out]	mgmtAddr	Octet string indicating a particular management address
[out]	mgmtAddrLen	Length of the management address, in bytes
[out]	ifNumSubtype	Numbering method used for defining the interface number
[out]	ifNum	Number within the system that identifies the specific interface associated with this management address
[out]	oid	OID that identifies the type of hardware component or protocol entity associated with the indicated management address
[out]	oidLen	Length of the OID, in bytes

Returns: Error code

Definition at line 1608 of file lldp_mgmt.c.

◆ lldpMgmtGetRemoteOrgDefInfo()

error_t lldpMgmtGetRemoteOrgDefInfo	(	LldpNeighborEntry *	entry,
		uint32_t	oui,
		uint8_t	subtype,
		uint_t	index,
		const uint8_t **	info,
		size_t *	infoLen
	)

Extract organizationally defined TLV from remote systems MIB.

Parameters

[in]	entry	Pointer to a given entry of the remote systems MIB
[in]	oui	Organizationally unique identifier
[in]	subtype	Organizationally defined subtype
[in]	index	Index identifying a particular instance of the TLV
[out]	info	Organizationally defined information string
[out]	infoLen	Length of the information string, in bytes

Returns: Error code

Definition at line 1705 of file lldp_mgmt.c.

◆ lldpMgmtGetRemotePortDesc()

error_t lldpMgmtGetRemotePortDesc	(	LldpNeighborEntry *	entry,
		const char_t **	portDesc,
		size_t *	portDescLen
	)

Extract port description from remote systems MIB.

Parameters

[in]	entry	Pointer to a given entry of the remote systems MIB
[out]	portDesc	Station port's description
[out]	portDescLen	Length of the port description, in bytes

Returns: Error code

Definition at line 1360 of file lldp_mgmt.c.

◆ lldpMgmtGetRemotePortId()

error_t lldpMgmtGetRemotePortId	(	LldpNeighborEntry *	entry,
		LldpPortIdSubtype *	portIdSubtype,
		const uint8_t **	portId,
		size_t *	portIdLen
	)

Extract port ID from remote systems MIB.

Parameters

[in]	entry	Pointer to a given entry of the remote systems MIB
[out]	portIdSubtype	Type of identifier used for the port
[out]	portId	Administratively assigned name that identifies the port
[out]	portIdLen	Length of the port ID, in bytes

Returns: Error code

Definition at line 1309 of file lldp_mgmt.c.

◆ lldpMgmtGetRemoteSysCap()

error_t lldpMgmtGetRemoteSysCap	(	LldpNeighborEntry *	entry,
		uint16_t *	supportedCap,
		uint16_t *	enabledCap
	)

Extract system capabilities from remote systems MIB.

Parameters

[in]	entry	Pointer to a given entry of the remote systems MIB
[out]	supportedCap	Bit-map of the capabilities supported by the system
[out]	enabledCap	Bit-map of the capabilities currently enabled

Returns: Error code

Definition at line 1489 of file lldp_mgmt.c.

◆ lldpMgmtGetRemoteSysDesc()

error_t lldpMgmtGetRemoteSysDesc	(	LldpNeighborEntry *	entry,
		const char_t **	sysDesc,
		size_t *	sysDescLen
	)

Extract system description from remote systems MIB.

Parameters

[in]	entry	Pointer to a given entry of the remote systems MIB
[out]	sysDesc	Textual description of the network entity
[out]	sysDescLen	Length of the system description, in bytes

Returns: Error code

Definition at line 1446 of file lldp_mgmt.c.

◆ lldpMgmtGetRemoteSysName()

error_t lldpMgmtGetRemoteSysName	(	LldpNeighborEntry *	entry,
		const char_t **	sysName,
		size_t *	sysNameLen
	)

Extract system name from remote systems MIB.

Parameters

[in]	entry	Pointer to a given entry of the remote systems MIB
[out]	sysName	System's administratively assigned name
[out]	sysNameLen	Length of the system name, in bytes

Returns: Error code

Definition at line 1403 of file lldp_mgmt.c.

◆ lldpMgmtGetRemoteUnknownTlv()

error_t lldpMgmtGetRemoteUnknownTlv	(	LldpNeighborEntry *	entry,
		uint8_t	type,
		uint_t	index,
		const uint8_t **	info,
		size_t *	infoLen
	)

Extract unknown TLV from remote systems MIB.

Parameters

[in]	entry	Pointer to a given entry of the remote systems MIB
[in]	type	TLV type field
[in]	index	Index identifying a particular instance of the TLV
[out]	info	TLV information string
[out]	infoLen	Length of the information string, in bytes

Returns: Error code

Definition at line 1686 of file lldp_mgmt.c.

◆ lldpMgmtGetStatsAgeoutsTotal()

error_t lldpMgmtGetStatsAgeoutsTotal	(	LldpAgentContext *	context,
		uint_t	portIndex,
		uint32_t *	statsAgeoutsTotal
	)

Get the value of the statsAgeoutsTotal statistics counter.

Parameters

[in]	context	Pointer to the LLDP agent context
[in]	portIndex	Port index
[out]	statsAgeoutsTotal	Number of age-outs that occurred on a given port

Returns: Error code

Definition at line 1951 of file lldp_mgmt.c.

◆ lldpMgmtGetStatsFramesDiscardedTotal()

error_t lldpMgmtGetStatsFramesDiscardedTotal	(	LldpAgentContext *	context,
		uint_t	portIndex,
		uint32_t *	statsFramesDiscardedTotal
	)

Get the value of the statsFramesDiscardedTotal statistics counter.

Parameters

[in]	context	Pointer to the LLDP agent context
[in]	portIndex	Port index
[out]	statsFramesDiscardedTotal	Number of LLDP frames received by this LLDP agent on the indicated port, and then discarded for any reason

Returns: Error code

Definition at line 1762 of file lldp_mgmt.c.

◆ lldpMgmtGetStatsFramesInErrorsTotal()

error_t lldpMgmtGetStatsFramesInErrorsTotal	(	LldpAgentContext *	context,
		uint_t	portIndex,
		uint32_t *	statsFramesInErrorsTotal
	)

Get the value of the statsFramesInErrorsTotal statistics counter.

Parameters

[in]	context	Pointer to the LLDP agent context
[in]	portIndex	Port index
[out]	statsFramesInErrorsTotal	Number of invalid LLDP frames received by this LLDP agent on the indicated port, while this LLDP agent is enabled

Returns: Error code

Definition at line 1800 of file lldp_mgmt.c.

◆ lldpMgmtGetStatsFramesInTotal()

error_t lldpMgmtGetStatsFramesInTotal	(	LldpAgentContext *	context,
		uint_t	portIndex,
		uint32_t *	statsFramesInTotal
	)

Get the value of the statsFramesInTotal statistics counter.

Parameters

[in]	context	Pointer to the LLDP agent context
[in]	portIndex	Port index
[out]	statsFramesInTotal	Number of valid LLDP frames received by this LLDP agent on the indicated port, while this LLDP agent is enabled

Returns: Error code

Definition at line 1838 of file lldp_mgmt.c.

◆ lldpMgmtGetStatsFramesOutTotal()

error_t lldpMgmtGetStatsFramesOutTotal	(	LldpAgentContext *	context,
		uint_t	portIndex,
		uint32_t *	statsFramesOutTotal
	)

Get the value of the statsFramesOutTotal statistics counter.

Parameters

[in]	context	Pointer to the LLDP agent context
[in]	portIndex	Port index
[out]	statsFramesOutTotal	Count of all LLDP frames transmitted through the port

Returns: Error code

Definition at line 1724 of file lldp_mgmt.c.

◆ lldpMgmtGetStatsRemTablesAgeouts()

error_t lldpMgmtGetStatsRemTablesAgeouts	(	LldpAgentContext *	context,
		uint32_t *	statsRemTablesAgeouts
	)

Get the value of the statsRemTablesAgeouts statistics counter.

Parameters

[in]	context	Pointer to the LLDP agent context
[out]	statsRemTablesAgeouts	The number of times the complete set of information advertised by a particular MSAP has been deleted from tables because the information timeliness interval has expired

Returns: Error code

Definition at line 2102 of file lldp_mgmt.c.

◆ lldpMgmtGetStatsRemTablesDeletes()

error_t lldpMgmtGetStatsRemTablesDeletes	(	LldpAgentContext *	context,
		uint32_t *	statsRemTablesDeletes
	)

Get the value of the statsRemTablesDeletes statistics counter.

Parameters

[in]	context	Pointer to the LLDP agent context
[out]	statsRemTablesDeletes	The number of times the complete set of information advertised by a particular MSAP has been deleted from tables

Returns: Error code

Definition at line 2044 of file lldp_mgmt.c.

◆ lldpMgmtGetStatsRemTablesDrops()

error_t lldpMgmtGetStatsRemTablesDrops	(	LldpAgentContext *	context,
		uint32_t *	statsRemTablesDrops
	)

Get the value of the statsRemTablesDrops statistics counter.

Parameters

[in]	context	Pointer to the LLDP agent context
[out]	statsRemTablesDrops	The number of times the complete set of information advertised by a particular MSAP could not be entered into tables because of insufficient resources

Returns: Error code

Definition at line 2073 of file lldp_mgmt.c.

◆ lldpMgmtGetStatsRemTablesInserts()

error_t lldpMgmtGetStatsRemTablesInserts	(	LldpAgentContext *	context,
		uint32_t *	statsRemTablesInserts
	)

Get the value of the statsRemTablesInserts statistics counter.

Parameters

[in]	context	Pointer to the LLDP agent context
[out]	statsRemTablesInserts	The number of times the complete set of information advertised by a particular MSAP has been inserted into tables

Returns: Error code

Definition at line 2016 of file lldp_mgmt.c.

◆ lldpMgmtGetStatsRemTablesLastChangeTime()

error_t lldpMgmtGetStatsRemTablesLastChangeTime	(	LldpAgentContext *	context,
		uint32_t *	statsRemTablesLastChangeTime
	)

Get the value of the statsRemTablesLastChangeTime statistics counter.

Parameters

[in]	context	Pointer to the LLDP agent context
[out]	statsRemTablesLastChangeTime	The time at which an entry was created, modified, or deleted in tables

Returns: Error code

Definition at line 1988 of file lldp_mgmt.c.

◆ lldpMgmtGetStatsTLVsDiscardedTotal()

error_t lldpMgmtGetStatsTLVsDiscardedTotal	(	LldpAgentContext *	context,
		uint_t	portIndex,
		uint32_t *	statsTLVsDiscardedTotal
	)

Get the value of the statsTLVsDiscardedTotal statistics counter.

Parameters

[in]	context	Pointer to the LLDP agent context
[in]	portIndex	Port index
[out]	statsTLVsDiscardedTotal	Number of LLDP TLVs discarded for any reason by this LLDP agent on the indicated port

Returns: Error code

Definition at line 1876 of file lldp_mgmt.c.

◆ lldpMgmtGetStatsTLVsUnrecognizedTotal()

error_t lldpMgmtGetStatsTLVsUnrecognizedTotal	(	LldpAgentContext *	context,
		uint_t	portIndex,
		uint32_t *	statsTLVsUnrecognizedTotal
	)

Get the value of the statsTLVsUnrecognizedTotal statistics counter.

Parameters

[in]	context	Pointer to the LLDP agent context
[in]	portIndex	Port index
[out]	statsTLVsUnrecognizedTotal	Number of LLDP TLVs received on the given port that are not recognized by this LLDP agent

Returns: Error code

Definition at line 1914 of file lldp_mgmt.c.

◆ lldpMgmtGetTxDelay()

error_t lldpMgmtGetTxDelay	(	LldpAgentContext *	context,
		uint_t *	txDelay
	)

Get transmit delay.

Parameters

[in]	context	Pointer to the LLDP agent context
[out]	txDelay	Delay between successive LLDP frame transmissions

Returns: Error code

Definition at line 525 of file lldp_mgmt.c.

◆ lldpMgmtLock()

void lldpMgmtLock ( LldpAgentContext * context )

Acquire exclusive access to the LLDP agent context.

Parameters

[in] context Pointer to the LLDP agent context

Definition at line 51 of file lldp_mgmt.c.

◆ lldpMgmtSetAdminStatus()

error_t lldpMgmtSetAdminStatus	(	LldpAgentContext *	context,
		uint_t	portIndex,
		LldpAdminStatus	adminStatus,
		bool_t	commit
	)

Set administrative status.

Parameters

[in]	context	Pointer to the LLDP agent context
[in]	portIndex	Port index
[in]	adminStatus	The administrative status indicates whether or not the local LLDP agent is enabled
[in]	commit	If this flag is TRUE, the LLDP agent verifies the parameter value and commits the change if the value is valid. If FALSE, the LLDP agent only performs the verification and does not take any further action

Returns: Error code

Definition at line 297 of file lldp_mgmt.c.

◆ lldpMgmtSetBasicTlvFilter()

error_t lldpMgmtSetBasicTlvFilter	(	LldpAgentContext *	context,
		uint_t	portIndex,
		uint8_t	mask,
		bool_t	commit
	)

Set the list of TLVs enabled for transmission.

Parameters

[in]	context	Pointer to the LLDP agent context
[in]	portIndex	Port index
[in]	mask	Bit-map indicating the TLVs enabled for transmission
[in]	commit	If this flag is TRUE, the LLDP agent verifies the parameter value and commits the change if the value is valid. If FALSE, the LLDP agent only performs the verification and does not take any further action

Returns: Error code

Definition at line 399 of file lldp_mgmt.c.

◆ lldpMgmtSetMsgTxHold()

error_t lldpMgmtSetMsgTxHold	(	LldpAgentContext *	context,
		uint_t	msgTxHold,
		bool_t	commit
	)

Set transmit hold multiplier.

Parameters

[in]	context	Pointer to the LLDP agent context
[in]	msgTxHold	Multiplier on the msgTxInterval that determines the actual TTL value used in an LLDPDU
[in]	commit	If this flag is TRUE, the LLDP agent verifies the parameter value and commits the change if the value is valid. If FALSE, the LLDP agent only performs the verification and does not take any further action

Returns: Error code

Definition at line 127 of file lldp_mgmt.c.

◆ lldpMgmtSetMsgTxInterval()

error_t lldpMgmtSetMsgTxInterval	(	LldpAgentContext *	context,
		uint_t	msgTxInterval,
		bool_t	commit
	)

Set transmit interval.

Parameters

[in]	context	Pointer to the LLDP agent context
[in]	msgTxInterval	Time interval between successive transmit cycles, in seconds
[in]	commit	If this flag is TRUE, the LLDP agent verifies the parameter value and commits the change if the value is valid. If FALSE, the LLDP agent only performs the verification and does not take any further action

Returns: Error code

Definition at line 81 of file lldp_mgmt.c.

◆ lldpMgmtSetNotificationEnable()

error_t lldpMgmtSetNotificationEnable	(	LldpAgentContext *	context,
		uint_t	portIndex,
		bool_t	notificationEnable,
		bool_t	commit
	)

Enable or disable notifications.

Parameters

[in]	context	Pointer to the LLDP agent context
[in]	portIndex	Port index
[in]	notificationEnable	This parameter controls whether or not notifications from the agent are enabled
[in]	commit	If this flag is TRUE, the LLDP agent verifies the parameter value and commits the change if the value is valid. If FALSE, the LLDP agent only performs the verification and does not take any further action

Returns: Error code

Definition at line 355 of file lldp_mgmt.c.

◆ lldpMgmtSetNotificationInterval()

error_t lldpMgmtSetNotificationInterval	(	LldpAgentContext *	context,
		uint_t	notificationInterval,
		bool_t	commit
	)

Set notification interval.

Parameters

[in]	context	Pointer to the LLDP agent context
[in]	notificationInterval	Notification interval
[in]	commit	If this flag is TRUE, the LLDP agent verifies the parameter value and commits the change if the value is valid. If FALSE, the LLDP agent only performs the verification and does not take any further action

Returns: Error code

Definition at line 254 of file lldp_mgmt.c.

◆ lldpMgmtSetReinitDelay()

error_t lldpMgmtSetReinitDelay	(	LldpAgentContext *	context,
		uint_t	reinitDelay,
		bool_t	commit
	)

Set re-initialization delay.

Parameters

[in]	context	Pointer to the LLDP agent context
[in]	reinitDelay	Delay before re-initialization will be attempted
[in]	commit	If this flag is TRUE, the LLDP agent verifies the parameter value and commits the change if the value is valid. If FALSE, the LLDP agent only performs the verification and does not take any further action

Returns: Error code

Definition at line 172 of file lldp_mgmt.c.

◆ lldpMgmtSetTxDelay()

error_t lldpMgmtSetTxDelay	(	LldpAgentContext *	context,
		uint_t	txDelay,
		bool_t	commit
	)

Set transmit delay.

Parameters

[in]	context	Pointer to the LLDP agent context
[in]	txDelay	Delay between successive LLDP frame transmissions
[in]	commit	If this flag is TRUE, the LLDP agent verifies the parameter value and commits the change if the value is valid. If FALSE, the LLDP agent only performs the verification and does not take any further action

Returns: Error code

Definition at line 213 of file lldp_mgmt.c.

◆ lldpMgmtUnlock()

void lldpMgmtUnlock ( LldpAgentContext * context )

Release exclusive access to the LLDP agent context.

Parameters

[in] context Pointer to the LLDP agent context

Definition at line 63 of file lldp_mgmt.c.

Functions

Detailed Description

License

Function Documentation

◆ lldpMgmtFindLocalMgmtAddr()

◆ lldpMgmtFindRemoteMgmtAddr()

◆ lldpMgmtFindRemoteTableEntry()

◆ lldpMgmtGetAdminStatus()

◆ lldpMgmtGetLocalChassisId()

◆ lldpMgmtGetLocalMgmtAddr()

◆ lldpMgmtGetLocalPortDesc()

◆ lldpMgmtGetLocalPortId()

◆ lldpMgmtGetLocalSysCap()

◆ lldpMgmtGetLocalSysDesc()

◆ lldpMgmtGetLocalSysName()

◆ lldpMgmtGetMibBasicTlvsTxEnable()

◆ lldpMgmtGetMsgTxHold()

◆ lldpMgmtGetMsgTxInterval()

◆ lldpMgmtGetNotificationEnable()

◆ lldpMgmtGetNotificationInterval()

◆ lldpMgmtGetReinitDelay()

◆ lldpMgmtGetRemoteChassisId()

◆ lldpMgmtGetRemoteMgmtAddr()

◆ lldpMgmtGetRemoteOrgDefInfo()

◆ lldpMgmtGetRemotePortDesc()

◆ lldpMgmtGetRemotePortId()

◆ lldpMgmtGetRemoteSysCap()

◆ lldpMgmtGetRemoteSysDesc()

◆ lldpMgmtGetRemoteSysName()

◆ lldpMgmtGetRemoteUnknownTlv()

◆ lldpMgmtGetStatsAgeoutsTotal()

◆ lldpMgmtGetStatsFramesDiscardedTotal()

◆ lldpMgmtGetStatsFramesInErrorsTotal()

◆ lldpMgmtGetStatsFramesInTotal()

◆ lldpMgmtGetStatsFramesOutTotal()

◆ lldpMgmtGetStatsRemTablesAgeouts()

◆ lldpMgmtGetStatsRemTablesDeletes()

◆ lldpMgmtGetStatsRemTablesDrops()

◆ lldpMgmtGetStatsRemTablesInserts()

◆ lldpMgmtGetStatsRemTablesLastChangeTime()

◆ lldpMgmtGetStatsTLVsDiscardedTotal()

◆ lldpMgmtGetStatsTLVsUnrecognizedTotal()

◆ lldpMgmtGetTxDelay()

◆ lldpMgmtLock()

◆ lldpMgmtSetAdminStatus()

◆ lldpMgmtSetBasicTlvFilter()

◆ lldpMgmtSetMsgTxHold()

◆ lldpMgmtSetMsgTxInterval()

◆ lldpMgmtSetNotificationEnable()

◆ lldpMgmtSetNotificationInterval()

◆ lldpMgmtSetReinitDelay()

◆ lldpMgmtSetTxDelay()

◆ lldpMgmtUnlock()