SNMP Agent specific values. This class stores values to access SNMP version 3
agents.
Pass this class with your request data (Pdu) to the request method of the target class to make
a request.
Based on the information in this class, an appropriate request will be made by the request class.
Following request types are generated:
* if EngineBoots and EngineTime are integer value 0 or if EngineId value is length 0, Discovery
request is made and passed instance of the SecureAgentParameters is updated with returned values.
* in all other cases, SNMP request is made to the agent
Namespace:
SnmpSharpNetAssembly: SnmpSharpNet (in SnmpSharpNet.dll) Version: 0.5.0.0 (0.5.0.0)
Syntax
| C# | Visual Basic | Visual C++ |
public class SecureAgentParameters : IAgentParameters
Public Class SecureAgentParameters _ Implements IAgentParameters
public ref class SecureAgentParameters : IAgentParameters
Members
| All Members | Constructors | Properties | Methods |
| Member | Description | |
|---|---|---|
| SecureAgentParameters()()() |
Constructor
| |
| SecureAgentParameters(SecureAgentParameters) |
Copy constructor. Initialize the class with the values of the parameter class values.
| |
| Authentication |
Authentication method. Acceptable values are members of AuthenticationDigests enum.
| |
| AuthenticationSecret |
Authentication secret. Secret length depends on the hash algorithm selected.
| |
| Clone()()() |
Clone current object
| |
| ContextEngineId |
Get SNMP version 3 context engine id. By default, this value will be set
to the same engine id as authoritative engine id (EngineId). I haven't see a
scenario where this value needs to be different by a manager but now there
is an option to do it.
To use the default operation, do not set this value or, if you've already set it,
reset it to null (object.ContextEngineId.Reset()).
| |
| ContextName |
Get SNMP version 3 context name
| |
| EngineBoots |
SNMP version 3 agent engine boots value
| |
| EngineId |
Agent authoritative engine id
| |
| EngineTime |
SNMP version 3 agent engine time value.
| |
| Equals(Object) | (Inherited from Object.) | |
| GetCurrentEngineTime()()() |
Calculates and returns current agents engine time. ValidateEngineTime()()() is called
prior to calculation to make sure current engine time is timely enough to use.
EngineTime is calculated as last received engine time + difference in seconds between the time
stamp saved when last time value was received and current time (using the internal GMT clock).
| |
| GetHashCode()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
| GetType()()() |
Gets the Type of the current instance.
(Inherited from Object.) | |
| InitializePacket(SnmpPacket) |
InitializePacket SNMP packet with values from this class. Works only on SNMP version 3 packets.
| |
| MaxMessageSize |
Get SNMP version 3 maximum message size object
| |
| Privacy |
Privacy protocol used. Acceptable values are members of PrivacyProtocols enum.
| |
| PrivacySecret |
Privacy secret. Length of the secret is dependent on the selected privacy method.
| |
| Reportable |
Get/Set reportable flag status in the SNMP version 3 packet.
| |
| Reset()()() |
Reset the class. Initialize all member values to class defaults.
| |
| SecurityName |
Security or user name configured on the SNMP version 3 agent.
| |
| ToString()()() | (Inherited from Object.) | |
| UpdateDiscoveryValues(SnmpPacket) |
Update class values with SNMP version 3 discovery values from the supplied SnmpV3Packet
class. Values updated are EngineId, EngineTime and EngineBoots.
| |
| UpdateTimeStamp()()() |
Updates engine time timestamp. This value is used to determine if agents engine time stored
in this class is valid.
Timestamp is saved as DateTime class by default initialized to DateTime.MinValue. Timestamp value
is stored in GMT to make it portable (if it is saved on one computer and loaded on another that uses
a different time zone).
| |
| UpdateValues(SnmpPacket) |
Copy all relevant values from the SnmpV3Packet class. Do not use this class for
updating the SNMP version 3 discovery process results because secret name, authentication
and privacy values are updated as well which discovery process doesn't use.
| |
| Valid()()() |
Checks validity of the class.
| |
| ValidateEngineTime()()() |
Validate agents engine time. Valid engine time value is time that has been initialized to
a value other then default (DateTime.MinValue is default set in the constructor) and that
has been updated in the last 10 times the SNMP v3 timely window (150 seconds). In other words,
valid time is any time value in the last 1500 seconds (or 25 minutes).
| |
| ValidateIncomingPacket(SnmpV3Packet) |
Validate that incoming packet has arrived from the correct engine id and is using a correct
combination of privacy and authentication values.
| |
| Version |
SNMP version. Only acceptable version is Ver3 |