SNMP Version 3 Scoped Protocol Data Unit. ScopedPdu extends the Pdu class by adding SNMP version 3 specific Context Engine Id and Context Name variables to the beginning of the packet. Context engine id is retrieved from the agent using the SNMP version 3 standard defined discovery process. Context name is used to define which subsection of the agents MIB user is allowed (or wants) to access. When creating a new ScopedPdu, for a valid request, ContextEngineId value has to be set for a valid reply to be received. Context value is implementation specific (depends on the configuration of the agent) and might not be required for a successful request.

Namespace: SnmpSharpNet
Assembly: SnmpSharpNet (in SnmpSharpNet.dll) Version: 0.5.0.0 (0.5.0.0)

Syntax


	C#			Visual Basic			Visual C++

public class ScopedPdu : Pdu

Public Class ScopedPdu _
	Inherits Pdu

public ref class ScopedPdu : public Pdu

Members


	All Members			Constructors			Properties			Methods

 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

	Member	Description
	ScopedPdu()()()	Standard constructor. Intializes the ScopedPdu type to SNMP-GET. For details see base class Pdu standard constructor definition. Context engine id and name variables are initialized to 0 length values.
	ScopedPdu(Pdu)	Constructor.
	ScopedPdu(Byte)	Standard constructor that sets ScopedPdu request type. Valid request types are: GET, GETNEXT, GETBULK, and SET
	ScopedPdu(Byte, Int32)	Standard constructor that sets ScopedPdu request type and request id. Valid request types are: GET, GETNEXT, GETBULK, and SET. By default, requestId value is set to a random value. Second argument allows caller to specify request id for this packet
	Clone()()()	Clone this object (Inherited from Pdu.)
	ContextEngineId	Get/Set context engine id value.
	ContextName	Get/Set context name value
	decode(array<Byte>[]()[], Int32)	Decode BER encoded ScopedPdu values. This method does not perform SNMP v3 privacy operations and is not aware of privacy requirements. To decode a privacy protected SNMP v3 packet, you will need to a) extract OctetString value holding encrypted ScopedPdu data, b) decrypt the encrypted ScopedPdu data into an unecrypted byte array, c) pass unencrypted ScopedPdu and BER encoded byte array to this method for final data conversion from BER into individual sequences and variables. (Overrides Pdu..::.decode(array<Byte>[]()[], Int32).)
	DeleteVb(Int32)	Delete VB from the specified location in the VarBind list (Inherited from Pdu.)
	encode(MutableByte)	Convert ScopedPdu into a BER encoded byte array. Resulting byte array is appended to the argument specified MutableByte class. Privacy operations are not performed by this method. Value encoded and returned by this method is suitable for sending in NoAuthNoPriv or AuthNoPriv security configurations. If privacy is required, caller will have to perform encryption and decryption operations after BER encoding is performed. In privacy protected SNMP version 3 packets, ScopedPdu is 1) encrypted using configured encryption method, 2) added to a OctetString field, and 3) appended to the data buffer. Because privacy operation is intrusive, it is recommended that BER encoding of the ScopedPdu packet is stored in a temporary MutableByte class, where it can be privacy protected and added to the OctetString class for final encoding into the target SNMP v3 packet. (Overrides Pdu..::.encode(MutableByte).)
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	ErrorIndex	ErrorIndex Pdu value (Inherited from Pdu.)
	ErrorStatus	ErrorStatus Pdu value (Inherited from Pdu.)
	GetHashCode()()()	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType()()()	Gets the Type of the current instance. (Inherited from Object.)
	GetVb(Int32)	Get VB from VarBind list at the specified index (Inherited from Pdu.)
	MaxRepetitions	Tells SNMP Agent how many VBs to include in a single request. Only valid on GETBULK requests. (Inherited from Pdu.)
	NonRepeaters	Get/Set GET-BULK NonRepeaters value (Inherited from Pdu.)
	RequestId	SNMP packet request id that is sent to the SNMP agent. SET this value before making SNMP requests. (Inherited from Pdu.)
	Reset()()()	Reset VbList. (Inherited from Pdu.)
	Set(AsnType)	Copy values from another Pdu class. (Inherited from Pdu.)
	SetVbList(VbCollection)	Set VbList (Inherited from Pdu.)
	ToString()()()	Returns a String that represents the current Object. (Inherited from Object.)
	TrapObjectID	Get TRAP ObjectID class from SNMPv2 TRAP and INFORM PDUs (Inherited from Pdu.)
	TrapSysUpTime	Get TRAP TimeStamp class from SNMPv2 TRAP and INFORM PDUs (Inherited from Pdu.)
	Type	Get or SET the PDU type. Available types are GET, GETNEXT, SET, GETBULK. PDU types are defined in Pdu class. (Inherited from Pdu.)
	VbCount	Return the number of VB entries in the VarBind list (Inherited from Pdu.)
	VbList	VarBind list (Inherited from Pdu.)

Inheritance Hierarchy

System..::.Object
  SnmpSharpNet..::.AsnType
    SnmpSharpNet..::.Pdu
      SnmpSharpNet..::.ScopedPdu

Syntax

Members

Inheritance Hierarchy

See Also