Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • id(string) identiier for OSAM GW
  • Ip address(String) ip IP address of the OSAM GW

ACCESS POD:

...

  • device_id (string): Identifier of the connected device

  • port_no (int): Identifier of the connected port.

PMCONFIGS

PmConfigs object represents an array of PmConfig or PmGroupConfig objects. 

  • freq : Sample rate
  • grouped :  Represents whether it is a grouped configuration or not.

PMGROUPCONFIG 

PmGroupConfig object consists of PmConfig objects with this additional properties : 

  • group_name : Name of the grouped configuration
  • group_freq : Sample rate for the group measurement 
  • enabled : Represents whether this group configuration is enabled or not.

PMCONFIG

PmConfig object represents a performance measurement metric with properties :  

  • type : (counter, gauge, state, context) type can be a counter value (to track how many times something has happened), a gauge (for instantaneous measurement types) a state or a context. 
  • sample_freq : Frequency of the performance measurement
  • name : The name of the measurement
  • enabled : This value shows if the config is enabled or not. 

SUBSCRIBER:

Subscriber is a model object that allows us to provision customer. It will be kept in OSAM DB.

...

  • Id -property refers to a serial number of OLT device
  • hardwareIdentifier -refers a mac address of OLT device
  • ipAddress -indicates an IP address of OLT device
  • nasId -indicates a radius server.

PMCONFIGS

PmConfigs object represents an array of PmConfig or PmGroupConfig objects. 

  • freq : Sample rate
  • grouped :  Represents whether it is a grouped configuration or not.

PMGROUPCONFIG 

PmGroupConfig object consists of PmConfig objects with this additional properties : 

  • group_name : Name of the grouped configuration
  • group_freq : Sample rate for the group measurement 
  • enabled : Represents whether this group configuration is enabled or not.

PMCONFIG

PmConfig object represents a performance measurement metric with properties :  

  • type : (counter, gauge, state, context) type can be a counter value (to track how many times something has happened), a gauge (for instantaneous measurement types) a state or a context. 
  • sample_freq : Frequency of the performance measurement
  • name : The name of the measurement
  • enabled : This value shows if the config is enabled or not.