API Interface Description
From Msamir projects
Documentation for Interface Description API. This documentation file is maintained at http://www.msamir.net/wiki/index.php?title=API_Interface_Description and exported to other formats. This documentation is purposly maintained rigorously as to aid all client developers of Dbcfg.
Contents |
Minimal Required Fields
name
Name of the customer it will be used as UserName to login to MRTG page
name=cocacola
name=feisal
name=cairostock
name=americana_Pizza
Optional Arguments
cid
simply it's an integer to identify the the interface (circuit identifier)
cid=32424
cid=4536363
cid=132451
cname
co
central office
co=almaza
co=ramsis
co=nasr3
speed
Speed of the link in Kilobyte.case it's omitted speed will be auto calculate examples:
speed=1024
speed=512
speed=256
speed=2048
interval
Time interval in minute to pool the interface data
interval=10
interval=20
interval=30
test
stype
service type
note
Any text is valid in this key
note=Never send a human to do a machine's job.
note=There is a difference between knowing the path and walking the path.
status
Status is the key the represent the customer status to the company it can be
| o | Operational |
| s | Suspend |
| m | Keep it under monitoring |
| t | Terminated |
admin
The administrator who create this interface
admin=msamir
admin=abader
utl
utalization and after it send alarm
