Docs For Class docsis_snmp_v3

Description

DOCSIS SNMP v3 Notification Receiver

Located in /docsis_config/docsis_snmp_v3.php (line 78)

docsis_encoder
   |
   --docsis_encoder_complex
      |
      --docsis_snmp_v3_trap

Method Summary

docsis_snmp_v3_trap docsis_snmp_v3_trap ([int $code = DOCSIS_SNMP_V3_TRAP], [array $value = array()])

void set_address (string $ip)

void set_filter (string $oid)

void set_port (int $port)

void set_retries (int $value)

void set_security_name (string $value)

void set_timeout (int $value, int $value )

Variables

Inherited Variables

Inherited from docsis_encoder

docsis_encoder::$code
docsis_encoder::$value

Methods

Constructor docsis_snmp_v3_trap (line 86)

Constructor

docsis_snmp_v3_trap docsis_snmp_v3_trap ([int $code = DOCSIS_SNMP_V3_TRAP], [array $value = array()])

int $code: docsis code
array $value: predefined values

set_address (line 96)

Set IP Address

void set_address (string $ip)

string $ip

set_filter (line 163)

Set Filtering Parameters

Specifies the OID of the snmpTrapOID value that is the root of the MIB subtree that defines all of the notifications to be sent to the Notification Receiver.

void set_filter (string $oid)

string $oid

set_port (line 106)

Set UDP Port Number

void set_port (int $port)

int $port

set_retries (line 149)

Set Receiver Retries

Defines the number of times to retry an Inform after the first Inform transmission. Defaults to 3.

void set_retries (int $value)

int $value

set_security_name (line 181)

Set Reciever Security Name

When Trap of Type value field is set to 1, 2, or 3, this value should not be intrepreted (has no meaning) and Informs messages will be sent with community string "public". In the case of Trap of Type 4 or 5, two situations happent:

If the Security Name is not set, the V3 Notification will be sent in the NoAuthNoPriv security level using security name "@config".
If the Security Name is set, $value must be the same as set in the DH Kickstart procedure. The notifications will be sent using the Authenficiation and Privacy Keys calculated by the modem during the DH Kickstart procedure.

void set_security_name (string $value)

string $value

set_timeout (line 137)

Set Type

1 SNMP v1 trap in an SNMP v1 packet
2 SNMP v2c trap in an SNMP v2c packet
3 SNMP v2c inform in an SNMP v2c packet
4 SNMP v2c trap in an SNMP v3 packet
4 SNMP inform in an SNMP v3 packet

void set_timeout (int $value, int $value )

int $value :
Set Receiver Timeout
This specifies the round trip timeout used to wait before sending a retry of an inform notification if sender does not get an acknowledgement from the receiver. Defaults to 15000 if not set.
int $value: in milliseconds

Inherited Methods

Inherited From docsis_encoder_complex

docsis_encoder_complex::docis_encoder_complex()
docsis_encoder_complex::encode()

Inherited From docsis_encoder

docsis_encoder::docsis_encoder()
docsis_encoder::encode()