ixnetwork package

Subpackages

• ixnetwork.api package
  • Submodules
  • ixnetwork.api.ixn_python module
  • ixnetwork.api.ixn_tcl module
  • Module contents
• ixnetwork.test package
  • Submodules
  • ixnetwork.test.ixn_samples
  • ixnetwork.test.test_base module
  • ixnetwork.test.test_offline module
  • ixnetwork.test.test_online module
  • Module contents

Submodules

ixnetwork.ixn_app module

Classes and utilities to manage IXN application.

@author yoram@ignissoft.com

class ixnetwork.ixn_app.IxnApp(logger, api_wrapper=None)

Bases: trafficgenerator.trafficgenerator.TrafficGenerator

IxNetwork driver. Equivalent to IxNetwork Application.

commit()

connect(tcl_server='localhost', tcl_port=8009)

disconnect()

Disconnect from chassis and server.

getStatistics(view)

l23TrafficOperation(action)

l23_traffic_start(blocking=False)

l23_traffic_stop()

l47TrafficApply()

l47TrafficOperation(action)

l47TrafficStart()

l47TrafficStop()

load_config(config_file_name)

new_config()

protocol_abort(protocol)

Abort all protocols and wait for all protocols to stop.

Raises:

TgnError: if some protocol failed to stop.

protocol_action(protocol, action)

protocol_start(protocol)

Start a protocol and wait for all protocols to start.

Raises TgnError:  if some protocol failed to start.

protocol_stop(protocol)

Stop all protocols and wait for all protocols to stop.

Raises:

TgnError: if some protocol failed to stop.

protocols_start()

Start all protocols.

It is the calling function responsibility to wait for all protocols to start.

protocols_stop()

Stop all protocols.

It is the calling function responsibility to wait for all protocols to stop.

root = None

save_config(config_file_name)

send_arp_ns()

send_rs()

traffic_apply()

wait_traffic_state(state, timeout)

ixnetwork.ixn_hw module

Classes and utilities to manage IXN HW.

@author yoram@ignissoft.com

class ixnetwork.ixn_hw.IxnCard(**data)

Bases: ixnetwork.ixn_hw.IxnPhyBase

attributes_names = ('description',)

children_types = {'ports': ('port', 'portId', 'Port ')}

class ixnetwork.ixn_hw.IxnChassis(**data)

Bases: ixnetwork.ixn_hw.IxnPhyBase

attributes_names = ('chassisType', 'chassisVersion')

children_types = {'modules': ('card', 'cardId', 'Slot ')}

class ixnetwork.ixn_hw.IxnHw(**data)

Bases: ixnetwork.ixn_object.IxnObject

get_chassis(hostname)

class ixnetwork.ixn_hw.IxnPhyBase(**data)

Bases: ixnetwork.ixn_object.IxnObject

get_inventory()

class ixnetwork.ixn_hw.IxnPhyPort(**data)

Bases: ixnetwork.ixn_hw.IxnPhyBase

attributes_names = ('description',)

children_types = {}

ixnetwork.ixn_interface module

Classes and utilities to manage IXN protocol interface objects.

@author yoram@ignissoft.com

class ixnetwork.ixn_interface.IxnInterface(**data)

Bases: ixnetwork.ixn_object.IxnObject

get_name()

ping(ip)

send_arp_ns()

send_rs()

class ixnetwork.ixn_interface.IxnInterfaceL3(**data)

Bases: ixnetwork.ixn_object.IxnObject, trafficgenerator.tgn_object.TgnL3

ip()

num_ips()

ixnetwork.ixn_interface.filter_ints_based_on_vlan(interfaces, vlan, count=1)

Filter list of interfaces based on VLAN presence or absence criteria.

Parameters:

• interfaces – list of interfaces to filter.
• vlan – boolean indicating whether to filter interfaces with or without VLAN.
• vlan – number of expected VLANs (note that when vlanEnable == False, vlanCount == 1)

Returns:

interfaces with VLAN(s) if vlan == True and vlanCount == count else interfaces without VLAN(s).

Todo:

add vlanEnable and vlanCount to interface/range/deviceGroup classes.

ixnetwork.ixn_object module

Base classes and utilities to manage IxNetwork (IXN).

author:yoram@ignissoft.com

class ixnetwork.ixn_object.IxnObject(**data)

Bases: trafficgenerator.tgn_object.TgnObject

Base class for all IXN classes.

api = None

execute(command, *arguments)

get_all_attributes(objRef)

get_all_child_types(objRef)

get_attribute(attribute)

Parameters:attribute – requested attributes. Returns:attribute value. Raises TgnError:  if invalid attribute.

get_attributes(*attributes)

get_child_static(objType, seq_number=None)

Returns IxnObject representing the requested child without reading it from the IXN.

Statically build the child object reference based on the requested object type and sequence number and build the IxnObject with this calculated object reference. Ideally we would prefer to never use this function and always read the child dynamically but this has huge impact on performance so we use the static approach wherever possible.

get_children(*types)

Read (getList) children from IXN.

Use this method to align with current IXN configuration.

Parameters:types – list of requested children. Returns:list of all children objects of the requested types.

get_enabled()

get_list_attribute(attribute)

Returns:attribute value as Python list.

get_name()

get_obj_class(obj_type)

Returns the object class based on parent and object types.

In most cases the object class can be derived from object type alone but sometimes the same object type name is used for different object types so the parent (or even grandparent) type is required in order to determine the exact object type. For example, interface object type can be child of vport or router (ospf etc.). In the first case the required class is IxnInterface while in the later case it is IxnObject.

Parameters:obj_type – IXN object type. Returns:object class if specific class else IxnObject.

help(objRef)

logger = None

root = None

set_attributes(commit=False, **attributes)

set_enabled(enabled)

str_2_class = {}

ixnetwork.ixn_object.extract_ixn_obj_type_from_obj_ref(obj_ref)

ixnetwork.ixn_port module

Classes and utilities to manage IXN port (vport) objects.

@author yoram@ignissoft.com

class ixnetwork.ixn_port.IxnPort(**data)

Bases: ixnetwork.ixn_object.IxnObject

get_interfaces()

Returns:dictionary {name: object} of all interfaces of the port.

is_online()

Returns:Port link status. True - port is up. False - port is offline.

location = None

release()

reserve(location=None, force=False, wait_for_up=True, timeout=80)

Reserve port and optionally wait for port to come up.

Parameters:

• location – port location as ‘ip/module/port’. If None, the location will be taken from the configuration.
• force – whether to revoke existing reservation (True) or not (False) - NOT SUPPORTED YET.
• wait_for_up – True - wait for port to come up, False - return immediately.
• timeout – how long (seconds) to wait for port to come up.

send_arp_ns()

send_rs()

wait_for_states(timeout=40, *states)

ixnetwork.ixn_port.get_port(obj_ref)

Parameters:obj_ref – port/deviceGroup child object reference. Returns:the ancestor port object of the obj_ref.

ixnetwork.ixn_protocol module

Classes and utilities to manage IXN classical protocols objects.

@author yoram@ignissoft.com

class ixnetwork.ixn_protocol.IxnBgpRouteRange(**data)

Bases: ixnetwork.ixn_protocol.IxnRouteRange

Represents IXN BGP route range.

class ixnetwork.ixn_protocol.IxnBgpRouter(**data)

Bases: ixnetwork.ixn_protocol.IxnProtocolServer

Represents IXN BGP router.

get_endpoints()

class ixnetwork.ixn_protocol.IxnIgmpHost(**data)

Bases: ixnetwork.ixn_protocol.IxnProtocolServer

Represents IXN IGMP host.

get_endpoints()

class ixnetwork.ixn_protocol.IxnIgmpQuerier(**data)

Bases: ixnetwork.ixn_protocol.IxnProtocolServer

Represents IXN IGMP querier.

class ixnetwork.ixn_protocol.IxnIsisRouteRange(**data)

Bases: ixnetwork.ixn_protocol.IxnRouteRange

Represents IXN ISIS route range.

class ixnetwork.ixn_protocol.IxnIsisRouter(**data)

Bases: ixnetwork.ixn_protocol.IxnProtocolRouter

Represents IXN ISIS router.

interface_attribute = 'interfaceId'

objType = 'router'

class ixnetwork.ixn_protocol.IxnLacp(**data)

Bases: ixnetwork.ixn_object.IxnObject

Represents IXN LACP object.

class ixnetwork.ixn_protocol.IxnLdpRouteRange(**data)

Bases: ixnetwork.ixn_protocol.IxnRouteRange

Represents IXN LDP route range.

class ixnetwork.ixn_protocol.IxnLdpRouter(**data)

Bases: ixnetwork.ixn_protocol.IxnProtocolRouter

Represents IXN ISIS router.

interface_attribute = 'protocolInterface'

objType = 'router'

class ixnetwork.ixn_protocol.IxnOpenFlowDevice(**data)

Bases: ixnetwork.ixn_protocol.IxnProtocolRouter

Represents IXN OpenFlow device.

interface_attribute = 'protocolInterfaces'

objType = 'device'

class ixnetwork.ixn_protocol.IxnOspfRouteRange(**data)

Bases: ixnetwork.ixn_protocol.IxnRouteRange

Represents IXN OSPF route range.

class ixnetwork.ixn_protocol.IxnOspfRouter(**data)

Bases: ixnetwork.ixn_protocol.IxnProtocolRouter

Represents IXN OSPF router.

objType = 'router'

class ixnetwork.ixn_protocol.IxnOspfV3Router(**data)

Bases: ixnetwork.ixn_protocol.IxnProtocolRouter

Represents IXN OSPFv3 router.

objType = 'router'

class ixnetwork.ixn_protocol.IxnPimsmRouter(**data)

Bases: ixnetwork.ixn_protocol.IxnProtocolRouter

Represents IXN PIM-SM router.

get_endpoints()

objType = 'router'

class ixnetwork.ixn_protocol.IxnPimsmSource(**data)

Bases: ixnetwork.ixn_protocol.IxnRouteRange

Represents IXN BGP route range.

class ixnetwork.ixn_protocol.IxnProtocol(**data)

Bases: ixnetwork.ixn_object.IxnObject

Base class for IXN classical protocol objects (e.g. OSPF router, IGMP Querier, MLD Host etc.).

classmethod get_protocols_with_int(ixn_int)

classmethod get_protocols_with_port(ixn_port, l3, vlan=None)

ixn_ints = {}

class ixnetwork.ixn_protocol.IxnProtocolRouter(**data)

Bases: ixnetwork.ixn_protocol.IxnProtocol

Base class for IXN router (e.g. OSPF router etc.).

get_endpoints()

interface_attribute = 'interfaces'

class ixnetwork.ixn_protocol.IxnProtocolServer(**data)

Bases: ixnetwork.ixn_protocol.IxnProtocol

Base class for IXN protocol server (e.g. IGMP Querier, MLD Host etc.).

get_endpoints()

class ixnetwork.ixn_protocol.IxnRouteRange(**data)

Bases: ixnetwork.ixn_object.IxnObject, trafficgenerator.tgn_object.TgnL3

Base class for IXN route ranges.

ip()

num_ips()

class ixnetwork.ixn_protocol.IxnStpBridge(**data)

Bases: ixnetwork.ixn_protocol.IxnProtocolRouter

Represents IXN STP bridge.

interface_attribute = 'interfaceId'

objType = 'bridge'

ixnetwork.ixn_protocol_stack module

Classes and utilities to manage IXN protocol stack objects.

@author yoram@ignissoft.com

class ixnetwork.ixn_protocol_stack.IxnDcbxEndpoint(**data)

Bases: ixnetwork.ixn_protocol_stack.IxnProtocolEndpoint

class ixnetwork.ixn_protocol_stack.IxnEthernetEndpoint(**data)

Bases: ixnetwork.ixn_protocol_stack.IxnProtocolEndpoint

class ixnetwork.ixn_protocol_stack.IxnFcoeClientEndpoint(**data)

Bases: ixnetwork.ixn_protocol_stack.IxnProtocolEndpoint

class ixnetwork.ixn_protocol_stack.IxnFcoeForwarderEndpoint(**data)

Bases: ixnetwork.ixn_protocol_stack.IxnProtocolEndpoint

class ixnetwork.ixn_protocol_stack.IxnProtocolEndpoint(**data)

Bases: ixnetwork.ixn_protocol_stack.IxnProtocolStack

class ixnetwork.ixn_protocol_stack.IxnProtocolStack(**data)

Bases: ixnetwork.ixn_object.IxnObject

action(oper)

start()

stop()

class ixnetwork.ixn_protocol_stack.IxnRange(**data)

Bases: ixnetwork.ixn_protocol_stack.IxnProtocolStack

ixnetwork.ixn_root module

@author yoram@ignissoft.com

class ixnetwork.ixn_root.IxnRoot(**data)

Bases: ixnetwork.ixn_object.IxnObject

get_ports()

Returns:dictionary {name: object} of all vport.

get_topologies()

Returns:dictionary {name: object} of all topologies.

get_traffic_items()

Returns:dictionary {name: object} of all traffic items.

regenerate(*traffic_items)

ixnetwork.ixn_statistics_view module

@author yoram@ignissoft.com

class ixnetwork.ixn_statistics_view.IxnFlowStatistics

Bases: ixnetwork.ixn_statistics_view.IxnStatisticsView

read_stats()

Reads the statistics view from IXN and saves it in statistics dictionary.

Flow statistics require special implementation as the statistics name is dynamic and changes based on the configuration.

class ixnetwork.ixn_statistics_view.IxnPortStatistics

Bases: ixnetwork.ixn_statistics_view.IxnStatisticsView

class ixnetwork.ixn_statistics_view.IxnStatisticsView(view)

Bases: object

Base class for all statistics view.

Note that Flow Statistics are poorly supported in this version as the object name spans over multiple column.

get_counter(obj_name, counter_name)

Parameters:

• counter_name – requested counter name.
• stat_name – requested statistics name.

Returns:

int, the value of the requested counter for the requested object.

get_counters(counter_name)

Parameters:stat_name – requested counter name. Returns:ints, all values of the requested counter for all objects.

get_object_stats(obj_name)

Parameters:obj_name – requested object name Returns:all statistics values for the requested object.

get_stat(obj_name, stat_name)

Parameters:

• obj_name – requested object name.
• stat_name – requested statistics name.

Returns:

str, the value of the requested statics for the requested object.

get_stats(stat_name)

Parameters:stat_name – requested statistics name. Returns:all values of the requested statistic for all objects.

read_stats()

Reads the statistics view from IXN and saves it in statistics dictionary.

class ixnetwork.ixn_statistics_view.IxnTrafficItemStatistics

Bases: ixnetwork.ixn_statistics_view.IxnStatisticsView

ixnetwork.ixn_topology module

@author yoram@ignissoft.com

class ixnetwork.ixn_topology.IxnDeviceGroup(**data)

Bases: ixnetwork.ixn_topology.IxnTopologyBaseClass

Represents IXN device group.

class ixnetwork.ixn_topology.IxnMultivalueBase(**data)

Bases: ixnetwork.ixn_topology.IxnTopologyBaseClass

Represents IXN device group.

class ixnetwork.ixn_topology.IxnNextGenProtocol(**data)

Bases: ixnetwork.ixn_topology.IxnTopologyBaseClass

Represents IXN device group.

getProtocolItems()

class ixnetwork.ixn_topology.IxnNextGenProtocolItem(**data)

Bases: ixnetwork.ixn_topology.IxnTopologyBaseClass

class ixnetwork.ixn_topology.IxnNgpfEthernet(**data)

Bases: ixnetwork.ixn_topology.IxnNextGenProtocol

protocol = 'ethernet'

class ixnetwork.ixn_topology.IxnNgpfIpv4(**data)

Bases: ixnetwork.ixn_topology.IxnNextGenProtocol

protocol = 'ipv4'

class ixnetwork.ixn_topology.IxnTopology(**data)

Bases: ixnetwork.ixn_topology.IxnTopologyBaseClass

Represents IXN topology.

Currently supports topology under single port only.

class ixnetwork.ixn_topology.IxnTopologyBaseClass(**data)

Bases: ixnetwork.ixn_object.IxnObject

action(action, timeout=64, *arguments)

action_2_status = {'start': 'started', 'stop': 'notStarted'}

get_device_groups()

Returns:dictionary {name: object} of all device groups.

start()

Start the protocol.

The function will return after the protocol is started.

stop()

Stop the protocol.

The function will return after the protocol is stopped.

ixnetwork.ixn_traffic module

@author yoram@ignissoft.com

class ixnetwork.ixn_traffic.IxnFlowGroup(**data)

Bases: ixnetwork.ixn_object.IxnObject

Base class for all IXN flow groups.

class ixnetwork.ixn_traffic.IxnL23FlowGroup(**data)

Bases: ixnetwork.ixn_traffic.IxnFlowGroup

L23 flow group

class ixnetwork.ixn_traffic.IxnL23QuickFlowGroup(**data)

Bases: ixnetwork.ixn_traffic.IxnFlowGroup

L23 quick flow group

generate()

class ixnetwork.ixn_traffic.IxnL23TrafficItem(**data)

Bases: ixnetwork.ixn_traffic.IxnTrafficItem

L23 traffic item.

class ixnetwork.ixn_traffic.IxnQuickTrafficItem(**data)

Bases: ixnetwork.ixn_traffic.IxnTrafficItem

L23 traffic item.

class ixnetwork.ixn_traffic.IxnTrafficItem(**data)

Bases: ixnetwork.ixn_object.IxnObject

Base class for all traffic items

generate()

get_flow_groups()

Returns:dictionary {name: object} of all flow groups.

start()

stop()

Module contents

@author yoram@ignissoft.com