avalanche.api package

Submodules

avalanche.api.avl_tcl module

author:yoram@ignissoft.com
class avalanche.api.avl_tcl.AvlTclWrapper(logger, tcl_lib_install_dir, avl_install_dir, tcl_interp=None)

Bases: trafficgenerator.tgn_tcl.TgnTclWrapper

STC Python API over Tcl interpreter.

avl_command(command, *attributes, **key_attributes)
config(obj_ref, **attributes)

Set or modifies one or more object attributes, or a relation.

Parameters:
  • obj_ref – requested object reference.
  • attributes – dictionary of {attributes: values} to configure.
create(obj_type, parent, **attributes)

Creates Avalanche objects.

Parameters:
  • obj_type – object type.
  • parent (str or AvlObject) – object parent - object will be created under this parent.
  • attributes – additional attributes.
Returns:

Avalanche object reference.
delete(obj_ref)

Delete the specified object.

Parameters:obj_ref – object reference of the object to delete.
get(obj_ref, attribute=None)

Returns the value(s) of one or more object attributes or a set of object handles.

Parameters:
  • obj_ref – requested object reference.
  • attribute – requested attribute. If empty - return values of all object attributes.
Returns:

requested value(s) as returned by get command. If all attributes were requested the return value is dictionary {attrib_name:attrib_val, attrib_name:attrib_val, ..} If single attribute was requested, the returned value is simple str.
getList(obj_ref, attribute)
perform(command, **arguments)

Execute a command.

Parameters:
  • command – requested command.
  • arguments – additional arguments.
Returns:

value returned by ‘perform command’.