Module ocs_mib

Description
Function Index
Function Details

This library module implements the SNMP MIB for the ocs application.

Copyright © 2018 - 2026 SigScale Global Inc.

Description

This library module implements the SNMP MIB for the ocs application.

Function Index

load/0	Loads the SigScale OCS MIB.
load/1	Loads the SigScale OCS MIB.
unload/0	Unloads the SigScale OCS MIB.
unload/1	Unloads the SigScale OCS MIB.
client_table/3	Handle SNMP requests for the client table.
radius_auth_server/2	Get RADIUS authentication server identity".
radius_acct_server/2	Get RADIUS accounting server identity".
dbp_local_config/2	Get local DIAMETER configuration.
dbp_local_stats/2	Handle SNMP requests for `DIAMETER-BASE-PROTOCOL-MIB::dbpLocalStats`.
dcca_peer_info/3	Handle SNMP requests for the peer info table.
dcca_peer_stats/3	Handle SNMP requests for the peer stats table.
total_packets/1*	Get packet counts from service info.

Function Details

load/0

load() -> Result

Result = ok | {error, Reason}
Reason = term()

Loads the SigScale OCS MIB.

load/1

load(Agent) -> Result

Agent = pid() | atom()
Result = ok | {error, Reason}
Reason = term()

Loads the SigScale OCS MIB.

unload/0

unload() -> Result

Result = ok | {error, Reason}
Reason = term()

Unloads the SigScale OCS MIB.

unload/1

unload(Agent) -> Result

Agent = pid() | atom()
Result = ok | {error, Reason}
Reason = term()

Unloads the SigScale OCS MIB.

client_table/3

client_table(Operation, RowIndex, Columns) -> Result

Operation = get | get_next
RowIndex = ObjectId
ObjectId = [integer()]
Columns = [Column]
Column = integer()
Result = [Element] | {genErr, Column}
Element = {value, Value} | {ObjectId, Value}
Value = atom() | integer() | string() | [integer()]

Handle SNMP requests for the client table.

radius_auth_server/2

radius_auth_server(Operation, Item) -> Result

Operation = get
Item = ident
Result = {value, Value} | genErr
Value = atom() | integer() | string() | [integer()]

Get RADIUS authentication server identity"

radius_acct_server/2

radius_acct_server(Operation, Item) -> Result

Operation = get
Item = ident
Result = {value, Value} | genErr
Value = atom() | integer() | string() | [integer()]

Get RADIUS accounting server identity"

dbp_local_config/2

dbp_local_config(Operation, Item) -> Result

Operation = get
Item = 'Origin-Host' | 'Origin-Realm' | 'Product-Name'
Result = {value, Value} | genErr
Value = atom() | integer() | string() | [integer()]

Get local DIAMETER configuration.

dbp_local_stats/2

dbp_local_stats(Operation, Item) -> Result

Operation = get
Item = uptime
Result = {value, Value} | {noValue, noSuchInstance} | genErr
Value = atom() | integer() | string() | [integer()]

Handle SNMP requests for DIAMETER-BASE-PROTOCOL-MIB::dbpLocalStats.

dcca_peer_info/3

dcca_peer_info(Operation, RowIndex, Columns) -> Result

Operation = get | get_next
RowIndex = ObjectId
ObjectId = [integer()]
Columns = [Column]
Column = integer()
Result = [Element] | {genErr, Column}
Element = {value, Value} | {ObjectId, Value}
Value = atom() | integer() | string() | [integer()]

Handle SNMP requests for the peer info table.

dcca_peer_stats/3

dcca_peer_stats(Operation, RowIndex, Columns) -> Result

Operation = get | get_next
RowIndex = ObjectId
ObjectId = [integer()]
Columns = [Column]
Column = integer()
Result = [Element] | {genErr, Column}
Element = {value, Value} | {ObjectId, Value}
Value = atom() | integer() | string() | [integer()]

Handle SNMP requests for the peer stats table.

total_packets/1 *

total_packets(Info) -> Result

Info = [tuple()]
Result = {ok, {PacketsIn, PacketsOut}} | {error, Reason}
PacketsIn = integer()
PacketsOut = integer()
Reason = term()

Get packet counts from service info.

Generated by EDoc