Using Functions for Backbone Congestion Point Classification Scripts

SRC ACP provides the following functions to use in backbone congestion point classification scripts:

• getNicProxy(name)—Get the NIC proxy defined under the current SRC ACP configuration group.
  • name—The name of the NIC proxy as defined under the SRC ACP configuration group.
• nicLookupSingle(name, nicKey, constraints)—Perform a NIC lookup using the specified NIC key and constraints with the NIC proxy defined under the current SRC ACP shared configuration group. The NIC key must uniquely identify a NIC value. If more than one result matches the same key, this function will raise the AmbiguousKeyException exception.
  • name—Name of the NIC proxy.
  • nicKey—String used as key for NIC lookup.
  • constraints (optional)—Map of NIC constraint information associated with the NIC key.

  This function returns the lookup result as (nicValue, intermediateValues), where intermediateValues is a map of the intermediate name and value pair.

• nicLookup(name, nicKey, constraints)—Perform a NIC lookup using the specified NIC key and constraints for the NIC proxy defined under the current SRC ACP shared configuration group.
  • name—Name of the NIC proxy.
  • nicKey—String used as key for NIC lookup.
  • constraints (optional)—Map of NIC constraint information associated with the NIC key.

  This function returns the lookup result as an array of (nicValue, intermediateValues), where intermediateValues is a map of the intermediate name and value pair.

• nicInvalidateLookup(name, nicKey, nicValue, constraints)--Used to signal to a NIC proxy that a key/value pair (returned from one of the lookup methods) resulted in a failure when the value was used. If the NIC proxy has this result cached, it will be removed from the cache.
  • name—Name of the NIC proxy.
  • nicKey—A string used as NIC key that was passed to the previous lookup operation.
  • nicValue—The NIC value returned from the previous lookup operation.
  • constraints(optional)—Map of NIC constraint information associated with the NIC key.
• slot(nasPortId)—Collects the slot number from the nasPortId or interfaceName.
• port(nasPortId)—Collects the port number from the nasPortId or interfaceName.
• l2id(nasPortId)—Collects the layer 2 ID from the nasPortId (VLAN id or ATM vpi.vci).
• escape(string)—Replaces any slash with the escape sequence \/.