taf.testlib.ui_iss_cli

Submodules

taf.testlib.ui_iss_cli.ui_iss_cli

ui_iss_cli.py

ISS CLI UI wrappers

class taf.testlib.ui_iss_cli.ui_iss_cli.UiIssCli(switch)

Bases: testlib.ui_helpers.UiHelperMixin, testlib.ui_wrapper.UiInterface

Abstract class to store UI wrapper interface methods.

__init__(switch)

Initialize UiIssCli Class.

check_device_state()

Attempts to connect to the shell retries number of times.

check_device_status(dev=None, dev_status=None)

Check_device_status.

Parameters:

• dev (str) – port/switch name.
• dev_status (str) – specify the state to which device must be checked.

Returns:

True if the dev_status matches actual status of device

Return type:

bool

Examples:

env.switch[1].ui.check_device_status(['fm0-0', ], "up")

clear_config()

Clear device configuration.

clear_l2_multicast()

Clear L2Multicast table.

Returns:None

Examples:

env.switch[1].ui.clear_l2_multicast()

clear_statistics()

Clear Statistics.

Returns:None

Examples

env.switch[1].ui.clear_statistics()

clear_table_fdb()

Clear Fdb table.

Returns:None

Examples:

env.switch[1].ui.clear_table_fdb()

cli_get_all(commands, timeout=10)

cli_set(commands, timeout=10, fail_message='Fail to configure')

configure_application(application, loglevel)

Set application loglevel.

Parameters:

• application (str) – Application Name.
• loglevel (str) – Application loglevel.

Returns:

None

Examples:

env.switch[1].ui.configure_application('L1PortControlApp', 'Debug')

configure_application_priority_rules(ports, app_prio_rules)

Configure Application Priority rules.

Parameters:

• ports (list[int]) – list of ports
• app_prio_rules (list[dict]) – list of rules dictionaries

Returns:

None

Examples:

env.switch[1].ui.configure_application_priority_rules([1, 2], [{"selector": 1, "protocol": 2, "priority":1}, ])

configure_arp(garp=None, refresh_period=None, delay=None, secure_mode=None, age_time=None, attemptes=None)

Configure ARPConfig table.

Parameters:

• garp (str) – AcceptGARP value. ‘True’|’False’
• refresh_period (int) – RefreshPeriod value
• delay (int) – RequestDelay value
• secure_mode (str) – SecureMode value. ‘True’|’False’
• age_time (int) – AgeTime value
• attemptes (int) – NumAttempts value

Returns:

None

Examples:

env.switch[1].ui.configure_arp(garp='Enabled')

configure_bgp_router(asn=65501, enabled='Enabled')

Modify BGPRouter record.

Parameters:

• asn (int) – AS number
• enabled (str) – enabled status

Returns:

None

Examples:

env.switch[1].ui.configure_bgp_router(asn=65501, enabled='Enabled')

configure_cos_global(**kwargs)

Configure global mapping of ingress VLAN priority to CoS per port or per switch (PortsDot1p2CoS records).

Parameters:**kwargs (dict) – parameters to be modified Returns:None

Examples:

env.switch[1].ui.configure_cos_global(dotp2CoS=6)

configure_dcbx_app(ports, **kwargs)

Configure DCBx APP parameter for the ports list.

Parameters:

• ports (list[int]) – list of ports
• **kwargs (dict) – parameters to be modified.

Returns:

None

Examples:

env.switch[1].ui.configure_dcbx_app([1, 2])

configure_dcbx_cn(ports, **kwargs)

Configure DCBx CN parameter for the ports list.

Parameters:

• ports (list[int]) – list of ports
• **kwargs (dict) – parameters to be modified.

Returns:

None

Examples:

env.switch[1].ui.configure_dcbx_cn([1, 2], cnpvSupported='Enabled')

configure_dcbx_ets(ports, **kwargs)

Configure DCBx ETS Conf/Reco parameter for ports list.

Parameters:

• ports (list[int]) – list of ports
• **kwargs (dict) – parameters to be modified.

Returns:

None

Examples:

env.switch[1].ui.configure_dcbx_ets([1, 2], confBandwidth=100)

configure_dcbx_pfc(ports, **kwargs)

Configure DCBx PFC parameter for the ports list.

Parameters:

• ports (list[int]) – list of ports
• **kwargs (dict) – parameters to be modified.

Returns:

None

Examples:

env.switch[1].ui.configure_dcbx_pfc([1, 2])

configure_global_lldp_parameters(**kwargs)

Configure global LLDP parameters.

Parameters:**kwargs (dict) – parameters to be modified. Returns:None

Examples:

env.switch[1].ui.configure_global_lldp_parameters(messageTxInterval=5)

configure_igmp_global(mode='Enabled', router_alert=None, unknown_igmp_behavior=None, query_interval=None, querier_robustness=None)

Modify IGMPSnoopingGlobalAdmin table.

Parameters:

• mode (str) – mode parameter value. ‘Enabled’|’Disabled’
• router_alert (str) – routerAlertEnforced parameter value. ‘Enabled’|’Disabled’
• unknown_igmp_behavior (str) – unknownIgmpBehavior parameter value. ‘Broadcast’|’Drop’
• query_interval (int) – queryInterval parameter value
• querier_robustness (int) – querierRobustness parameter value

Returns:

None

Examples:

env.switch[1].ui.configure_igmp_global(mode='Enabled')

configure_igmp_per_ports(ports, mode='Enabled', router_port_mode=None)

Modify IGMPSnoopingPortsAdmin table.

Parameters:

• ports (list[int]) – list of ports
• mode (str) – igmpEnabled parameter value. ‘Enabled’|’Disabled’
• router_port_mode (str) – routerPortMode parameter value. ‘Auto’|’Always’

Returns:

None

Examples:

env.switch[1].ui.configure_igmp_per_ports([1, 2], mode='Enabled')

configure_lldp_ports(ports, **kwargs)

Configure LldpPorts records.

Parameters:

• ports (list[int]) – list of ports.
• **kwargs (dict) – parameters to be modified.

Returns:

None

Examples:

env.switch[1].ui.configure_lldp_ports([1, 2], adminStatus='Disabled')

configure_ospf_router(**kwargs)

Configure OSPFRouter table.

Parameters:**kwargs (dict) – parameters to be modified Returns:None

Examples:

env.switch[1].ui.configure_ospf_router(routerId='1.1.1.1')

configure_ovs_resources(**kwargs)

Configure OvsResources table.

Parameters:**kwargs (dict) – parameters to be configured Returns:None

Examples:

env.switch[1].ui.configure_ovs_resources(rulesLimit=2000)

configure_port_cos(ports=None, **kwargs)

Configure PortsQoS records.

Parameters:

• ports (list[int]) – list of ports to be modified
• **kwargs (dict) – parameters to be modified

Returns:

None

Examples:

env.switch[1].ui.configure_port_cos([1, ], trustMode='Dot1p')

configure_qinq_ports(ports, **kwargs)

Configure QinQ Ports.

Parameters:

• ports (list[int]) – list of ports
• **kwargs (dict) – parameters to be modified.

Returns:

None

Examples:

env.switch[1].ui.configure_qinq_ports([1, ], tpid=2)

configure_qinq_vlan_mapping(ports, customer_vlan_id, customer_vlan_priority, provider_vlan_id, provider_vlan_priority)

Configure QinQCustomerVlanMapping and QinQProviderVlanMapping.

Parameters:

• ports (list[int]) – list of ports
• customer_vlan_id (int) – customer vlan Id
• customer_vlan_priority (int) – customer vlan priority
• provider_vlan_id (int) – provider vlan Id
• provider_vlan_priority (int) – provider vlan priority

Returns:

None

Examples:

env.switch[1].ui.configure_qinq_vlan_mapping([1, ], 2, 7, 5, 6)

configure_qinq_vlan_stacking(ports, provider_vlan_id, provider_vlan_priority)

Configure QinQVlanStacking.

Parameters:

• ports (list[int]) – list of ports
• provider_vlan_id (int) – provider vlan Id
• provider_vlan_priority (int) – provider vlan priority

Returns:

None

Examples:

env.switch[1].ui.configure_qinq_vlan_stacking([1, ], 2, 7)

configure_routing(routing='Enabled', ospf=None)

Configure L3 routing.

Parameters:

• routing (str) – enable L3 routing
• ospf (str|None) – enable OSPF. None|’Enabled’

Returns:

None

Examples:

env.switch[1].ui.configure_routing(routing='Enabled', ospf='Enabled')

configure_spanning_tree(**kwargs)

Configure ‘SpanningTree’ table

Parameters:**kwargs (dict) – Possible parameters from ‘SpanningTree’ table to configure. Returns:None

Examples:

env.switch[1].ui.configure_spanning_tree(mode='MSTP')

configure_stp_instance(instance, **kwargs)

Configure existing STP instance.

Parameters:

• instance (int) – Instance number.
• **kwargs (dict) – Possible parameters to configure.

Returns:

None

Examples:

env.switch[1].ui.configure_stp_instance(instance=3, priority=2)  # change instance priority
env.switch[1].ui.configure_stp_instance(instance=3, vlan=10)  # assign instance to the existed vlan

configure_tunneling_global(**kwargs)

Configure TunnelingGlobalAdmin table.

Parameters:**kwargs (dict) – parameters to be modified. Returns:None

Examples:

env.switch[1].ui.configure_tunneling_global()

configure_ufd(enable='Enabled', hold_on_time=None)

Modify UFDConfig table.

Parameters:

• enable (str) – Enable or disable UFD
• hold_on_time (int) – hold on time

Returns:

None

Examples:

env.switch[1].ui.configure_ufd(enable='Enabled')

connect()

Mandatory method for UI wrapper connection.

create_acl(ports=None, expressions=None, actions=None, rules=None)

Create ACLs.

Parameters:

• ports (list[int]) – list of ports where ACLs will be created.
• expressions (list[list]) – list of ACL expressions.
• actions (list[list]) – list of ACL actions.
• rules (list[list]) – list of ACL rules.

Returns:

None

Examples:

env.switch[1].ui.create_acl(ports=[1, 2], expressions=[[1, 'SrcMac', 'FF:FF:FF:FF:FF:FF', '00:00:00:11:11:11'], ],
                            actions=[[1, 'Drop', ''], ], [[1, 1, 1, 'Ingress', 'Enabled', 0], ])

create_area_ranges(area, range_ip, range_mask, substitute_ip, substitute_mask)

Create OSPFAreas2Ranges record.

Parameters:

• area (int) – Area Id
• range_ip (str) – IP address
• range_mask (str) – mask
• substitute_ip (str) – IP address
• substitute_mask (str) – mask

Returns:

None

Examples:

env.switch[1].ui.create_area_ranges("0.0.0.0", "10.0.2.0", "255.255.255.0", "11.0.2.0", "255.255.255.0")

create_area_virtual_link(area, link)

Create OSPFInterface record.

Parameters:

• area (str) – OSPF Area
• link (str) – Virtual link IP

Returns:

None

Examples:

env.switch[1].ui.create_area_virtual_link("0.0.0.0", "1.1.1.2")

create_arp(ip, mac, network, mode='arp')

Create StaticARP record.

Parameters:

• ip (str) – ARP ip address
• mac (str) – ARP mac address
• network (str) – RouteInterface network
• mode (str) – ‘arp’ or ‘ipv6 neigbor’

Returns:

None

Examples:

env.switch[1].ui.create_arp('10.0.5.102', '00:00:22:22:22', '10.0.5.101/24')

create_bgp_aggregate_address(asn=65501, ip='22.10.10.0', mask='255.255.255.0')

Create BGPAggregateAddress record

Parameters:

• asn (int) – AS number
• ip (str) – IP address
• mask (str) – IP address mask

Returns:

None

Examples:

env.switch[1].ui.create_bgp_aggregate_address(asn=65501, ip='10.0.0.0', mask='255.255.255.0')

create_bgp_bgp(asn=65501, router_id='1.1.1.1')

Create BGPBgp record.

Parameters:

• asn (int) – AS number
• router_id (str) – OSPF router Id

Returns:

None

Examples:

env.switch[1].ui.create_bgp_bgp(asn=65501, router_id="1.1.1.1")

create_bgp_confederation_peers(asn=65501, peers=70000)

Create BGPBgpConfederationPeers record.

Parameters:

• asn (int) – AS number
• peers (int) – peers number

Returns:

None

Examples:

env.switch[1].ui.create_bgp_confederation_peers(asn=65501, peers=70000)

create_bgp_distance_admin(asn=65501, ext_distance=100, int_distance=200, local_distance=50)

Create BGPDistanceAdmin record.

Parameters:

• asn (int) – AS number
• ext_distance (int) – external distance
• int_distance (int) – internal distance
• local_distance (int) – local distance

Returns:

None

Examples:

env.switch[1].ui.create_bgp_distance_admin(asn=65501, ext_distance=100, int_distance=200, local_distance=50)

create_bgp_distance_network(asn=65501, ip='40.0.0.0/24', mask='255.255.255.0', distance=100, route_map='routeMap')

Create BGPDistanceNetwork record.

Parameters:

• asn (int) – AS number
• ip (str) – IP address
• mask (str) – IP address mask
• distance (int) – IP address distance
• route_map (str) – route map name

Returns:

None

Examples:

env.switch[1].ui.create_bgp_distance_network(asn=65501, ip="40.0.0.0", mask='255.255.255.0', distance=100, route_map='routeMap')

create_bgp_neighbor(asn=65501, ip='192.168.0.1')

Create BGPNeighbor record.

Parameters:

• asn (int) – AS number
• ip (str) – IP address

Returns:

None

Examples:

env.switch[1].ui.create_bgp_neighbor(asn=65501, ip='192.168.0.1')

create_bgp_neighbor_2_as(asn, ip, remote_as)

Create BGPNeighbor2As record.

Parameters:

• asn (int) – AS number
• ip (str) – IP address
• remote_as (int) – Remote AS number

Returns:

None

Examples:

env.switch[1].ui.create_bgp_neighbor_2_as(65501, '10.0.5.102', 65502)

create_bgp_neighbor_connection(asn=65501, ip='192.168.0.1', port=179)

Create BGPNeighborConnection record.

Parameters:

• asn (int) – AS number
• ip (str) – IP address
• port (int) – connection port

Returns:

None

Examples:

env.switch[1].ui.create_bgp_neighbor_connection(asn=65501, ip='192.168.0.1', port=179)

create_bgp_network(asn=65501, ip='10.0.0.0', mask='255.255.255.0', route_map='routeMap')

Create BGPNetwork record.

Parameters:

• asn (int) – AS number
• ip (str) – IP address
• mask (str) – IP address mask
• route_map (str) – route map name

Returns:

None

Examples:

env.switch[1].ui.create_bgp_network(asn=65501, ip='10.0.0.0', mask='255.255.255.0', route_map='routeMap')

create_bgp_peer_group(asn=65501, name='mypeergroup')

Create BGPPeerGroups record.

Parameters:

• asn (int) – AS number
• name (str) – peer group name

Returns:

None

Examples:

env.switch[1].ui.create_bgp_peer_group(65501, "test_name")

create_bgp_peer_group_member(asn=65501, name='mypeergroup', ip='12.1.0.2')

Create BGPPeerGroupMembers record.

Parameters:

• asn (int) – AS number
• name (str) – peer group name
• ip (str) – IP address

Returns:

None

Examples:

env.switch[1].ui.create_bgp_peer_group_member(65501, "test_name", "12.1.0.2")

create_bgp_redistribute(asn=65501, rtype='OSPF')

Create BGPRedistribute record.

Parameters:

• asn (int) – AS number
• rtype (str) – redistribute type

Returns:

None

Examples:

env.switch[1].ui.create_bgp_redistribute(65501, "OSPF")

create_dhcp_relay(iface_name='global', server_ip=None, fwd_iface_name=None)

Configure DhcpRelayAdmin or DhcpRelayV6Admin table.

Parameters:

• iface_name (str) – VLAN inteface name
• server_ip (str) – DHCP Server IP address
• fwd_iface_name (str) – VLAN forward interface name (for IPv6 config only)

Returns:

None

Examples:

env.switch[1].ui.create_dhcp_relay(iface_name='global', server_ip='10.10.0.2')

create_dot1p_to_cos_mapping(ports, **kwargs)

Create PortsDot1p2CoS mapping.

Parameters:

• ports (list[int]) – list of ports to be modified
• **kwargs (dict) – parameters to be modified

Returns:

None

Examples:

env.switch[1].ui.create_dot1p_to_cos_mapping([1, ], dotp7CoS=6)

create_interface_md5_key(vlan, network, key_id, key)

Create OSPFInterfaceMD5Keys record.

Parameters:

• vlan (int) – Vlan Id
• network (str) – Route Interface network
• key_id (int) – key Id
• key (str) – key

Returns:

None

Examples:

env.switch[1].ui.create_interface_md5_key(10, "10.0.5.101/24", 1, "Key1")

create_lag(lag=None, key=None, lag_type='Static', hash_mode='None')

Create LAG instance.

Parameters:

• lag (int) – LAG id
• key (int) – LAG key
• lag_type (str) – LAG type. ‘Static’|’Dynamic’
• hash_mode (str) – LAG hash type

Returns:

None

Examples:

env.switch[1].ui.create_lag(3800, 1, 'Static', 'None')

create_lag_ports(ports, lag, priority=1, key=None, aggregation='Multiple', lag_mode='Passive', timeout='Long', synchronization=False, collecting=False, distributing=False, defaulting=False, expired=False, partner_system='00:00:00:00:00:00', partner_syspri=32768, partner_number=1, partner_key=0, partner_pri=32768)

Add ports into created LAG.

Parameters:

• ports (list[int]) – list of ports to be added into LAG
• lag (int) – LAG Id
• priority (int) – LAG priority
• key (int) – LAG key
• aggregation (str) – LAG aggregation
• lag_mode (str) – LAG mode
• timeout (str) – LAG timeout
• synchronization (bool) – LAG synchronization
• collecting (bool) – LAG collecting
• distributing (bool) – LAG distributing
• defaulting (bool) – LAG defaulting
• expired (bool) – LAG expired
• partner_system (str) – LAG partner system MAC address
• partner_syspri (int) – LAG partner system priority
• partner_number (int) – LAG partner number
• partner_key (int) – LAG partner key
• partner_pri (int) – LAG partner priority

Returns:

None

Examples:

env.switch[1].ui.create_lag_ports([1, ], 3800, priority=1, key=5)

create_mirror_session(port, target, mode)

Configure PortsMirroring table.

Parameters:

• port (int) – source port Id
• target (int) – target port Id
• mode (str) – mirroring mode

Returns:

None

Examples:

env.switch[1].ui.create_mirror_session(1, 2, 'Redirect')

create_multicast(port, vlans, macs)

Create StaticL2Multicast record.

Parameters:

• port (int) – port Id
• vlans (list[int]) – list of vlans
• macs (list[str]) – list of multicast MACs

Returns:

None

Examples:

env.switch[1].ui.create_multicast(10, [5, ], ['01:00:05:11:11:11', ])

create_network_2_area(network, area, mode)

Create OSPFNetworks2Area record.

Parameters:

• network (str) – RouteInterface network
• area (int) – Area Id
• mode (str) – Area mode

Returns:

None

Examples:

env.switch[1].ui.create_network_2_area('10.0.5.101/24', "0.0.0.0", 'Disabled')

create_ospf_area(area, **kwargs)

Create OSPFAreas record.

Parameters:

• area (int) – Area Id to be created
• **kwargs (dict) – parameters to be added

Returns:

None

Examples:

env.switch[1].ui.create_ospf_area("0.0.0.0")

create_ospf_interface(vlan, network, dead_interval=40, hello_interval=5, network_type='Broadcast', hello_multiplier=3, minimal='Enabled', priority=-1, retransmit_interval=-1)

Create OSPFInterface record.

Parameters:

• vlan (int) – Vlan Id
• network (str) – Route Interface network
• dead_interval (int) – dead interval
• hello_interval (int) – hello interval
• network_type (str) – network type
• hello_multiplier (int) – hello multiplier
• minimal (str) – minimal
• priority (int) – priority
• retransmit_interval (int) – retransmit interval

Returns:

None

Examples:

env.switch[1].ui.create_ospf_interface(vlan_id, "10.0.5.101/24", 40, 5, network_type='Broadcast', minimal='Enabled', priority=1, retransmit_interval=3)

create_ovs_bridge(bridge_name)

Create OvsBridges record.

Parameters:bridge_name (str) – OVS bridge name Returns:None

Examples:

env.switch[1].ui.create_ovs_bridge('spp0')

create_ovs_bridge_controller(bridge_name, controller)

Create OvsControllers record.

Parameters:

• bridge_name (str) – OVS bridge name
• controller (str) – controller address

Returns:

None

Examples:

env.switch[1].ui.create_ovs_bridge_controller("spp0", "tcp:127.0.0.1:6633")

create_ovs_flow_actions(bridge_id, table_id, flow_id, action, param, priority=2000)

Add row to OvsFlowActions table.

Parameters:

• bridge_id (int) – OVS bridge ID
• table_id (int) – Table ID
• flow_id (int) – Flow ID
• priority (int) – Rule priority
• action (str) – Action name
• param (str) – Action parameter

Returns:

None

Examples:

env.switch[1].ui.create_ovs_flow_actions(0, 0, 1, 'Output', str(1))

create_ovs_flow_qualifiers(bridge_id, table_id, flow_id, field, data, priority=2000)

Add row to OvsFlowQualifiers table.

Parameters:

• bridge_id (int) – OVS bridge ID
• table_id (int) – Table ID
• flow_id (int) – Flow ID
• priority (int) – Rule priority
• field (str) – Expression name
• data (str) – Expression data

Returns:

None

Examples:

env.switch[1].ui.create_ovs_flow_qualifiers(0, 0, i, 'EthSrc', '00:00:00:00:00:01')

create_ovs_flow_rules(bridge_id, table_id, flow_id, priority, enabled)

Create OvsFlowRules table.

Parameters:

• bridge_id (int) – OVS bridge ID
• table_id (int) – Table ID
• flow_id (int) – Flow ID
• priority (int) – Rule priority
• enabled (str) – Rule status

Returns:

None

Examples:

env.switch[1].ui.create_ovs_flow_rules(0, 0, 1, 2000, "Enabled")

create_ovs_port(port, bridge_name)

Create OvsPorts record.

Parameters:

• port (int) – port Id
• bridge_name (str) – OVS bridge name

Returns:

None

Examples:

env.switch[1].ui.create_ovs_port(1, 'spp0')

create_route_interface(vlan, ip, ip_type='InterVlan', bandwidth=1000, mtu=1500, status='Enabled', vrf=0, mode='ip')

Create Route Interface.

Parameters:

• vlan (int) – vlan Id
• ip (str) – Route Interface network
• ip_type (str) – Route interface type
• bandwidth (int) – Route interface bandwidth
• mtu (int) – Route interface mtu
• status (str) – Route interface status
• vrf (int) – Route interface vrf
• mode (str) – ‘ip’ or ‘ipv6’

Returns:

None

Examples:

env.switch[1].ui.create_route_interface(10, '10.0.5.101/24', 'InterVlan', 1000, 1500, 'Enabled, 0, 'ip')
env.switch[1].ui.create_route_interface(10, '2000::01/96', 'InterVlan', 1000, 1500, 'Enabled, 0, 'ipv6')

create_route_redistribute(mode)

Create OSPFRouteRedistribute record.

Parameters:mode (str) – redistribute mode Returns:None

Examples:

env.switch[1].ui.create_route_redistribute("Static")

create_static_macs(port=None, vlans=None, macs=None)

Create static FDB records.

Parameters:

• port (int) – port where static Fbds will be created (mandatory).
• vlans (list[int] | set(int)) – list of vlans where static Fbds will be created (mandatory).
• macs (list) – list of MACs to be added (mandatory).

Returns:

None

Examples:

env.switch[1].ui.create_static_macs(10, [1, 2], ['00:00:00:11:11:11', ])

create_static_route(ip, nexthop, network, distance=-1, mode='ip')

Create StaticRoute record.

Parameters:

• ip (str) – Route IP network
• nexthop (str) – Nexthop IP address
• network (str) – RouteInterface network
• distance (int) – Route distance
• mode (str) – ‘ip’ or ‘ipv6’

Returns:

None

Examples:

env.switch[1].ui.create_static_route('20.20.20.0/24', '10.0.5.102', '10.0.5.101/24')

create_stp_instance(instance, priority)

Create new STP instance in ‘STPInstances’ table.

Parameters:

• instance (int) – Instance number.
• priority (int) – Instance priority.

Returns:

None

Examples:

env.switch[1].ui.create_stp_instance(instance=3, priority=2)

create_syslog(syslog_proto, syslog_ip, syslog_port, syslog_localport, syslog_transport, syslog_facility, syslog_severity)

Configure Syslog settings.

Parameters:

• syslog_proto (str) – syslog host protocol Udp | Tcp
• syslog_ip (str) – syslog host IP address
• syslog_port (int) – syslog host port
• syslog_localport (int) – syslog host local port
• syslog_transport (str) – syslog host transport
• syslog_facility (int) – syslog host facility
• syslog_severity (str) – syslog host severity

create_tunnels(tunnel_id=None, destination_ip=None, vrf=0, encap_type=None)

Configure TunnelsAdmin table.

Parameters:

• tunnel_id (int) – Tunnel ID
• destination_ip (str) – Destination IP address
• vrf (int) – Tunnel VRF
• encap_type (str) – Tunnel encapsulation type

Returns:

None

Examples:

env.switch[1].ui.create_tunnels(tunnel_id=records_count, destination_ip=ip_list, encap_type='VXLAN')

create_ufd_group(group_id, threshold=None, enable='Enabled')

Create UFDGroups record.

Parameters:

• group_id (int) – UFD group ID
• threshold (int) – group threshold
• enable (str) – Enable or disable UFD group

Returns:

None

Examples:

env.switch[1].ui.create_ufd_group(1)

create_ufd_ports(ports, port_type, group_id)

Create UFDPorts2Groups record.

Parameters:

• ports (list[int]) – list of ports
• port_type (str) – type of port
• group_id (int) – UFD group Id

Returns:

None

Examples:

env.switch[1].ui.create_ufd_ports([1, ], 'LtM' 2)

create_vlan_ports(ports=None, vlans=None, tagged='Tagged')

Create new Ports2Vlans records.

Parameters:

• ports (list) – list of ports to be added to Vlans.
• vlans (list[int] | set(int)) – list of vlans.
• tagged (str) – information about ports tagging state.

Returns:

None

Examples:

Port 1 will be added into the vlans 3 and 4 as Untagged and port 2 will be added into the vlans 3 and 4 as Untagged
env.switch[1].ui.create_vlan_ports([1, 2], [3, 4], 'Untagged')

create_vlans(vlans=None)

Create new Vlans

Parameters:vlans (list[int] | set(int)) – list of vlans to be created. Returns:None

Examples:

env.switch[1].ui.create_vlans([2, 3])

delete_acl(ports=None, expression_ids=None, action_ids=None, rule_ids=None)

Delete ACLs.

Parameters:

• ports (list[int]) – list of ports where ACLs will be deleted (mandatory).
• expression_ids (list[int]) – list of ACL expression IDs to be deleted (optional).
• action_ids (list[int]) – list of ACL action IDs to be deleted (optional).
• rule_ids (list[int]) – list of ACL rule IDs to be deleted (optional).

Returns:

None

Examples:

env.switch[1].ui.delete_acl(ports=[1, 2], rule_ids=[1, 2])

delete_arp(ip, network, mode='arp')

Delete ARP record.

Parameters:

• ip (str) – ARP ip address
• network (str) – RouteInterface network
• mode (str) – ‘arp’ or ‘ipv6 neigbor’

Returns:

None

Examples:

env.switch[1].ui.delete_arp('10.0.5.102', '10.0.5.101/24')

delete_lag_ports(ports, lag)

Delete ports from created LAG.

Parameters:

• ports (list[int]) – list of ports to be added into LAG
• lag (int) – LAG Id

Returns:

None

Examples:

env.switch[1].ui.delete_lag_ports([1, ], 3800)

delete_lags(lags=None)

Delete LAG instance.

Parameters:lags (list[int]) – list of LAG Ids Returns:None

Examples:

env.switch[1].ui.delete_lags([3800, ])

delete_mirroring_session(port, target, mode)

Delete mirroring session from the PortsMirroring table.

Parameters:

• port (int) – source port Id
• target (int) – target port Id
• mode (str) – mirroring mode

Returns:

None

Examples:

env.switch[1].ui.delete_mirroring_session(1, 2, 'Redirect')

delete_ovs_bridge()

Delete OVS Bridge.

Returns:None

Examples:

env.switch[1].ui.delete_ovs_bridge()

delete_ovs_flow_actions(bridge_id, table_id, flow_id, action, priority=2000)

Delete row from OvsFlowActions table.

Parameters:

• bridge_id (int) – OVS bridge ID
• table_id (int) – Table ID
• flow_id (int) – Flow ID
• priority (int) – Rule priority
• action (str) – Action name

Returns:

None

Examples:

env.switch[1].ui.delete_ovs_flow_actions(bridgeId, tableId, flowId, action)

delete_ovs_flow_qualifiers(bridge_id, table_id, flow_id, field, priority=2000)

Delete row from OvsFlowQualifiers table.

Parameters:

• bridge_id (int) – OVS bridge ID
• table_id (int) – Table ID
• flow_id (int) – Flow ID
• priority (int) – Rule priority
• field (str) – Expression name

Returns:

None

Examples:

env.switch[1].ui.delete_ovs_flow_qualifiers(bridgeId, tableId, flowId, field)

delete_ovs_flow_rules(bridge_id, table_id, flow_id, priority)

Delete row from OvsFlowRules table.

Parameters:

• bridge_id (int) – OVS bridge ID
• table_id (int) – Table ID
• flow_id (int) – Flow ID
• priority (int) – Rule priority

Returns:

None

Examples:

env.switch[1].ui.delete_ovs_flow_rules(bridgeId, tableId, flowId, priority)

delete_route_interface(vlan, ip, bandwith=1000, mtu=1500, vrf=0, mode='ip')

Delete Route Interface.

Parameters:

• vlan (int) – vlan Id
• ip (str) – Route Interface network
• bandwith (int) – Route interface bandwidth
• mtu (int) – Route interface mtu
• vrf (int) – Route interface vrf
• mode (str) – ‘ip’ or ‘ipv6’

Returns:

None

Examples:

env.switch[1].ui.delete_route_interface(10, '10.0.5.101/24', 1000, 1500, 0, 'ip')
env.switch[1].ui.create_route_interface(10, '2000::01/96', 1000, 1500, 0, 'ipv6')

delete_static_mac(port=None, vlan=None, mac=None)

Delete static FDB records.

Parameters:

• port (int) – port where static Fbds will be deleted.
• vlan (list[int]) – list of vlans where static Fbds will be deleted (mandatory).
• mac (list[str]) – list of MACs to be deleted (mandatory).

Returns:

None

Examples:

env.switch[1].ui.delete_static_mac([1, 2], ['00:00:00:11:11:11', ])

delete_static_route(network)

Delete StaticRoute record.

Parameters:network (str) – RouteInterface network Returns:None

Examples:

env.switch[1].ui.delete_static_route('10.0.5.101/24')

delete_ufd_group(group_id)

Delete UFDGroups record.

Parameters:group_id (int) – UFD group ID Returns:None

Examples:

env.switch[1].ui.delete_ufd_group(2)

delete_ufd_ports(ports, port_type, group_id)

Delete UFDPorts2Groups record.

Parameters:

• ports (list[int]) – list of ports
• port_type (str) – type of port
• group_id (int) – UFD group Id

Returns:

None

Examples:

env.switch[1].ui.delete_ufd_ports([1, ], 'LtM' 2)

delete_vlan_ports(ports=None, vlans=None)

Delete Ports2Vlans records.

Parameters:

• ports (list) – list of ports to be added to Vlans.
• vlans (list[int] | set(int)) – list of vlans.

Returns:

None

Examples:

Ports 1 and 2 will be removed from the vlan 3:
env.switch[1].ui.delete_vlan_ports([1, 2], [3, ])

delete_vlans(vlans=None)

Delete existing Vlans.

Parameters:vlans (list[int] | set(int)) – list of vlans to be deleted. Returns:None

Examples:

env.switch[1].ui.delete_vlans([2, 3])

disable_lldp_on_device_ports(ports=None)

Disable Lldp on device ports (if port=None Lldp should be disabled on all ports).

Parameters:ports (list[int]) – list of ports Returns:None

Examples:

env.switch[1].ui.disable_lldp_on_device_ports()

disconnect()

Mandatory method for UI wrapper disconnection.

enable_dcbx_tlv_transmission(ports, dcbx_tlvs='all', mode='Enabled')

Enable/Disable the transmission of all Type-Length-Value messages.

Parameters:

• ports (list[int]) – list of ports
• dcbx_tlvs (str) – TLV message types
• mode (str) – “Enabled” or ‘Disabled’

Returns:

None

Examples:

env.switch[1].ui.enable_dcbx_tlv_transmission([1, 2], dcbx_tlvs="all", mode="Enabled")

enter_config_mode()

exit_config_mode()

generate_port_name_mapping()

get_cpu()

Returns cpu utilization from switch.

Returns:cpu utilization from switch Return type:float

get_errdisable_ports(port=None, app_name=None, app_error=None, param=None)

Get ErrdisablePorts table.

Parameters:

• port (int) – port Id (optional)
• app_name (str) – application name (optional)
• app_error (str) – application error (optional)
• param (str) – parameter name (optional)

Returns:

table (list of dictionaries) or value

Return type:

list[dict]|int|str

Examples:

env.switch[1].ui.get_errdisable_ports()

get_memory(mem_type='usedMemory')

Returns free cached/buffered memory from switch.

Parameters:mem_type (str) – memory type Returns:float:: memory size

get_mirroring_sessions()

Get PortsMirroring table.

Returns:table (list of dictionaries) or value Return type:list[dict]|int|str

Examples:

env.switch[1].ui.get_mirroring_sessions()

get_table_acl(table)

Get ACL table.

Parameters:table (list(dict)) – ACL table name to be returned Returns:table (list of dictionaries) Return type:list(dict)

Examples:

env.switch[1].ui.get_table_acl('ACLStatistics')

get_table_applications()

Get ‘Applications’ table.

get_table_area_ranges()

Get OSPFAreas2Ranges table.

Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_area_ranges()

get_table_arp(mode='arp')

Get ARP table.

Parameters:mode (str) – ‘arp’ or ‘ipv6 neigbor’ Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_arp()

get_table_arp_config()

Get ARPConfig table.

Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_arp_config()

get_table_bgp_aggregate_address()

Get BGPAggregateAddress table.

Returns:table Return type:list[dict]

Examples:

env.switch[1].ui.get_table_bgp_aggregate_address()

get_table_bgp_confederation_peers()

Get BGPBgpConfederationPeers table.

Returns:list[dict] table

Examples:

env.switch[1].ui.get_table_bgp_confederation_peers()

get_table_bgp_distance_admin()

Get BGPDistanceAdmin table.

Returns:table Return type:list[dict]

Examples:

env.switch[1].ui.get_table_bgp_distance_admin()

get_table_bgp_distance_network()

Get BGPDistanceNetwork table.

Returns:table Return type:list[dict]

Examples:

env.switch[1].ui.get_table_bgp_distance_network()

get_table_bgp_neighbor()

Get BGPNeighbour table.

Returns:table Return type:list[dict]

Examples:

env.switch[1].ui.get_table_bgp_neighbor()

get_table_bgp_neighbor_connections()

Get BGPNeighborConnection table.

Returns:table Return type:list[dict]

Examples:

env.switch[1].ui.get_table_bgp_neighbor_connections()

get_table_bgp_network()

Get BGPNetwork table.

Returns:table Return type:list[dict]

Examples:

env.switch[1].ui.get_table_bgp_network()

get_table_bgp_peer_group_members()

Get BGPPeerGroupMembers table.

Returns:table Return type:list[dict]

Examples:

env.switch[1].ui.get_table_bgp_peer_group_members()

get_table_bgp_peer_groups()

Get BGPPeerGroups table

Returns:table Return type:list[dict]

Examples

env.switch[1].ui.get_table_bgp_peer_groups()

get_table_bgp_redistribute()

Get BGPRedistribute table.

Returns:table Return type:list[dict]

Examples:

env.switch[1].ui.get_table_bgp_redistribute()

get_table_bridge_info(param=None, port=None)

Get Bridge Info table or specific parameter value in Bridge Info table

Parameters:

• param (str) – parameter name (optional)
• port (int) – port ID (optional)

Returns:

table (list of dictionaries) or value

Return type:

list[dict]|str|int

Examples:

env.switch[1].ui.get_table_bridge_info()
env.switch[1].ui.get_table_bridge_info('agingTime')

get_table_dcbx_app_maps(table_type='Admin', port=None)

Get DcbxAppMaps* table

Parameters:

• table_type (str) – “Admin”, “Local” or “Remote”
• port (int) – port Id (optional)

Returns:

table (list of dictionaries)

Return type:

list[dict]

Examples:

env.switch[1].ui.get_table_dcbx_app_maps("Admin", 1)

get_table_dcbx_pfc(table_type='Local', port=None)

Get DcbxRemotes* table.

Parameters:

• port (int) – port Id (optional)
• table_type (str) – Table types “Admin”| “Local”| “Remote”

Returns:

table (list of dictionaries) or value

Return type:

list[dict]|int|str

Examples:

env.switch[1].ui.get_table_dcbx_pfc()

get_table_dcbx_ports(port=None, param=None)

Get DcbxPorts table.

Parameters:

• port (int) – port Id (optional)
• param (str) – parameter name (optional)

Returns:

table (list of dictionaries) or value

Return type:

list[dict]

Examples:

env.switch[1].ui.get_table_dcbx_ports()

get_table_dcbx_remotes(port=None, param=None)

Get DcbxRemotes* table.

Parameters:

• port (int) – port Id (optional)
• param (str) – parameter name (optional)

Returns:

table (list of dictionaries) or value

Return type:

list[dict]|int|str

Examples:

env.switch[1].ui.get_table_dcbx_remotes(1)

get_table_dhcp_relay(dhcp_relay_ipv6=False)

Return DhcpRelayAdmin or DhcpRelayV6Admin table

Parameters:dhcp_relay_ipv6 (bool) – is IPv6 config defined Returns:None

Examples:

env.switch[1].ui.get_table_dhcp_relay(dhcp_relay_ipv6=False)

get_table_errdisable_config()

Get ErrdisableConfig table.

Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_errdisable_config()

get_table_errdisable_errors_config(app_name=None, app_error=None)

Get ErrdisableErrorsConfig table.

Parameters:

• app_name (str) – application name
• app_error (str) – application error

Returns:

table (list of dictionaries) or value

Return type:

list[dict]|str

Examples:

env.switch[1].ui.get_table_errdisable_errors_config()

get_table_fdb(table='Fdb')

Get Fbd table.

Parameters:table (str) – Fbd record type to be returned (‘Fbd’ or ‘Static’) Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_fdb()
env.switch[1].ui.get_table_fdb('Static')

get_table_igmp_snooping_global_admin(param=None)

Get IGMPSnoopingGlobalAdmin table.

Parameters:param (str) – parameter name Returns:table (list of dictionaries) or value Return type:list[dict]|int|str

Examples:

env.switch[1].ui.get_table_igmp_snooping_global_admin()
env.switch[1].ui.get_table_igmp_snooping_global_admin('queryInterval')

get_table_igmp_snooping_port_oper(port, param=None)

Get IGMPSnoopingPortsOper table.

Parameters:

• port (int) – port Id
• param (str) – parameter name

Returns:

table (list of dictionaries) or value

Return type:

list[dict]|int|str

Examples:

env.switch[1].ui.get_table_igmp_snooping_port_oper()
env.switch[1].ui.get_table_igmp_snooping_port_oper('queryInterval')

get_table_interface_authentication()

Get OSPFInterfaceMD5Keys table.

Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_interface_authentication()

get_table_l2_multicast()

Get L2Multicast table.

Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_l2_multicast()

get_table_lags()

Get LagsAdmin table.

Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_lags()

get_table_lags_local(lag=None)

Get LagsLocal table.

Parameters:lag (int) – LAG Id Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_lags_local()
env.switch[1].ui.get_table_lags_local(3800)

get_table_lags_local_ports(lag=None)

Get Ports2LagLocal table.

Parameters:lag (int) – LAG Id Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_lags_local_ports()
env.switch[1].ui.get_table_lags_local_ports(3800)

get_table_link_aggregation()

Get LinkAggregation table.

Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_link_aggregation()

get_table_lldp(param=None)

Get Lldp table.

Parameters:param (str) – parameter name (optional) Returns:table (list of dictionaries) Return type:list[dict]|int|str

Examples:

env.switch[1].ui.get_table_lldp()

get_table_lldp_ports(port=None, param=None)

Get LldpPorts table.

Parameters:

• port (int) – port Id (optional)
• param (str) – parameter name (optional)

Returns:

table (list of dictionaries) or value

Return type:

list[dict]|int|str

Examples:

env.switch[1].ui.get_table_lldp_ports(1)

get_table_lldp_ports_stats(port=None, param=None)

Get LldpPorts table statistics.

Parameters:

• port (int) – port Id (optional)
• param (str) – parameter name (optional)

Returns:

table (list of dictionaries) or value

Return type:

list[dict]|int|str

Examples:

env.switch[1].ui.get_table_lldp_ports_stats(1)

get_table_lldp_remotes(port=None)

Get LldpRemotes table.

Parameters:port (int) – port Id (optional) Returns:table (list of dictionaries) or value Return type:list[dict]

Examples:

env.switch[1].ui.get_table_lldp_remotes(1)

get_table_mstp_ports(ports=None, instance=None)

Get ‘MSTPPorts’ table.

Notes

Return all table or information about particular ports and STP instance.

Parameters:

• ports (list) – list of ports.
• instance (int) – Instance number(int).

Returns:

table (list of dictionaries)

Return type:

list(dict)

Examples:

env.switch[1].ui.get_table_mstp_ports()
env.switch[1].ui.get_table_mstp_ports([1, 2])
env.switch[1].ui.get_table_mstp_ports([1, 2], instance=3)

get_table_network_2_area()

Get OSPFNetworks2Area table.

Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_network_2_area()

get_table_ospf_area()

Get OSPFAreas table.

Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_ospf_area()

get_table_ospf_interface()

Get OSPFInterface table.

Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_interface_authentication()

get_table_ospf_router()

Get OSPFRouter table.

Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_ospf_router()

get_table_ovs_bridges()

Get OvsBridges table.

Returns:table (list of dictionaries)) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_ovs_bridges()

get_table_ovs_controllers()

Get OvsControllers table.

Returns:table (list of dictionaries)) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_ovs_controllers()

get_table_ovs_flow_actions()

Get OvsFlowActions table.

Returns:table (list of dictionaries)) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_ovs_flow_actions()

get_table_ovs_flow_qualifiers()

Get OvsFlowQualifiers table.

Returns:table (list of dictionaries)) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_ovs_flow_qualifiers()

get_table_ovs_ports()

Get OvsPorts table.

Returns:table (list of dictionaries)) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_ovs_ports()

get_table_ovs_rules()

Get OvsFlowRules table.

Returns:table (list of dictionaries)) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_ovs_rules()

get_table_platform()

Get ‘Platform’ table.

get_table_ports(ports=None, all_params=False)

Get ‘Ports’ table.

Parameters:

• ports (list) – list of port IDs.
• all_params (bool) – get additional port properties

Returns:

table (list of dictionaries)

Return type:

list(dict)

Notes

Return all table or information about particular ports.

Examples:

env.switch[1].ui.get_table_ports()
env.switch[1].ui.get_table_ports([1, 2])

get_table_ports2lag()

Get Ports2LagAdmin table.

Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_ports2lag()

get_table_ports2vlans()

Get ‘Ports2Vlans’ table.

Returns:table (list of dictionaries) Return type:list(dict)

Examples:

env.switch[1].ui.get_table_ports2vlans()

get_table_ports_dot1p2cos(port=None, rx_attr_flag=True)

Get PortsDot1p2CoS table.

Parameters:

• port (str|int) – port Id to get info about (‘All’ or port id)
• rx_attr_flag (bool) – whether get rx or tx attribute information

Returns:

table (list of dictionaries)

Return type:

list[dict]

Examples:

env.switch[1].ui.get_table_ports_dot1p2cos(1)
env.switch[1].ui.get_table_ports_dot1p2cos('All')

get_table_ports_qos_scheduling(port=None, param=None)

Get PortsQoS scheduling information.

Parameters:

• port (int) – port Id to get info about
• param (str) – param name to get info about

Returns:

table (list of dictionaries) or dictionary or param value

Return type:

list[dict] | str | int

Examples:

env.switch[1].ui.get_table_ports_qos_scheduling(port=1, param='schedMode')
env.switch[1].ui.get_table_ports_qos_scheduling('Static')

get_table_qinq_customer_vlan_mapping()

Get QinQCustomerVlanMapping table.

Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_qinq_customer_vlan_mapping()

get_table_qinq_ports(port=None, param=None)

Get QinQPorts table.

Parameters:

• port (int) – port Id (optional)
• param (str) – parameter name (optional)

Returns:

table (list of dictionaries) or value

Return type:

list[dict]|int|str

Examples:

env.switch[1].ui.get_table_qinq_ports()

get_table_qinq_provider_vlan_mapping()

Get QinQProviderVlanMapping table.

Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_qinq_provider_vlan_mapping()

get_table_qinq_vlan_stacking()

Get QinQVlanStacking table.

Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_qinq_vlan_stacking()

get_table_remotes_mgmt_addresses(port=None)

Get LldpRemotesMgmtAddresses table.

Parameters:port (int) – port Id (optional) Returns:table (list of dictionaries) or value Return type:list[dict]

Examples:

env.switch[1].ui.get_table_remotes_mgmt_addresses(1)

get_table_route(mode='ip')

Get Route table.

Parameters:mode (str) – ‘ip’ or ‘ipv6’ Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_route()

get_table_route_interface()

Get RouteInterface table.

Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_route_interface()

get_table_route_redistribute()

Get OSPFRouteRedistribute table.

Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_route_redistribute()

get_table_rstp_ports(ports=None)

Get ‘MSTPPorts’ table.

Notes

Return all table or information about particular ports.

Parameters:ports (list) – list of ports. Returns:table (list of dictionaries) Return type:list(dict)

Examples:

env.switch[1].ui.get_table_rstp_ports()
env.switch[1].ui.get_table_rstp_ports([1, 2])

get_table_spanning_tree()

Get ‘SpanningTree’ table.

Returns:table (list of dictionaries) Return type:list(dict)

Examples:

env.switch[1].ui.get_table_spanning_tree()

get_table_static_route(mode='ip')

Get StaticRoute table.

Parameters:mode (str) – ‘ip’ or ‘ipv6’ Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_static_route()

get_table_statistics(port=None, stat_name=None)

Get Statistics table.

Parameters:

• port (str|int|None) – port Id to get info about (‘cpu’ or port id) (optional)
• stat_name (str) – name of statistics parameter (optional)

Returns:

table (list of dictionaries)

Return type:

list[dict]|int

Examples:

env.switch[1].ui.get_table_statistics()
env.switch[1].ui.get_table_statistics(port=1)
env.switch[1].ui.get_table_statistics(port='cpu')

get_table_tunnels_admin()

Return TunnelsAdmin table.

Returns:table Return type:list[dict]

Examples:

env.switch[1].ui.get_table_tunnels_admin()

get_table_ufd_config()

Get UFDConfig table.

Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_ufd_config()

get_table_ufd_groups()

Get UFDGroups table.

Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_ufd_groups()

get_table_ufd_ports()

Get UFDPorts2Groups table.

Returns:table (list of dictionaries) Return type:list[dict]

Examples:

env.switch[1].ui.get_table_ufd_ports()

get_table_vlans()

Get ‘Vlans’ table.

Returns:table (list of dictionaries) Return type:list(dict)

Examples:

env.switch[1].ui.get_table_vlans()

get_temperature()

Get temperature from Sensors table.

Returns:CPU temperature information (Sensors table) Return type:dict

logs_add_message(level, message)

Add message into device logs.

Parameters:

• level (str) – log severity
• message (str) – log message

modify_bridge_info(**kwargs)

Modify BridgeInfo table.

Parameters:**kwargs (dict) – Parameters to be modified. Returns:None

Examples:

env.switch[1].ui.modify_bridge_info(agingTime=5)

modify_dot1p_to_cos_mapping(ports, **kwargs)

Modify PortsDot1p2CoS mapping.

Parameters:

• ports (list[int]) – list of ports to be modified
• **kwargs (dict) – parameters to be modified

Returns:

None

Examples:

env.switch[1].ui.modify_dot1p_to_cos_mapping([1, ], dotp7CoS=6)

modify_errdisable_config(interval=None)

Configure ErrdisableConfig table.

Parameters:interval (int) – recovery interval Returns:None

Examples:

env.switch[1].ui.modify_errdisable_config(10)

modify_errdisable_errors_config(detect=None, recovery=None, app_name=None, app_error=None)

Configure ErrdisableErrorsConfig table.

Parameters:

• detect (str) – detect status
• recovery (str) – recovery status
• app_name (str) – application name
• app_error (str) – application error

Returns:

None

Examples:

env.switch[1].ui.modify_errdisable_errors_config(detect="Enabled", app_name='L2UfdControlApp', app_error='ufd')

modify_link_aggregation(globalenable=None, collectormaxdelay=None, globalhashmode=None, priority=None, lacpenable=None)

Modify LinkAggregation table.

Parameters:

• globalenable (str) – globalEnable parameter value
• collectormaxdelay (int) – collectorMaxDelay parameter value
• globalhashmode (str) – globalHashMode parameter value
• priority (int) – priority parameter value
• lacpenable (str) – lacpEnable parameter value

Returns:

None

Examples:

env.switch[1].ui.modify_link_aggregation(globalhashmode='SrcMac')

modify_mstp_ports(ports, instance=0, **kwargs)

Modify records in ‘MSTPPorts’ table.

Parameters:

• ports (list) – list of ports.
• instance (int) – Instance number.
• **kwargs (dict) – Parameters to be modified. Parameters names should be the same as in XMLRPC nb.MSTPPorts.set.* calls

Returns:

None

Examples:

env.switch[1].ui.modify_mstp_ports([1, 2], instance=3, adminState='Enabled')

modify_ports(ports, **kwargs)

Modify records in ‘Ports’ table.

Parameters:

• ports (list(int)) – list of ports.
• **kwargs (dict) – Parameters to be modified. Parameters names should be the same as in XMLRPC nb.Ports.set.* calls

Returns:

None

Examples:

env.switch[1].ui.modify_ports([1, 2], adminMode='Down')

modify_route_interface(vlan, ip, **kwargs)

Modify Route Interface.

Parameters:

• vlan (int) – vlan Id
• ip (str) – Route Interface network
• **kwargs (dict) – parameters to be modified: “adminMode” - set adminMode value.

Returns:

None

Examples:

env.switch[1].ui.modify_route_interface(10, '10.0.5.101/24', adminMode='Disabled')

modify_rstp_ports(ports, **kwargs)

Modify records in ‘RSTPPorts’ table.

Parameters:

• ports (list) – list of ports.
• **kwargs (dict) – Parameters to be modified. Parameters names should be the same as in XMLRPC nb.RSTPPorts.set.* calls

Returns:

None

Examples:

env.switch[1].ui.modify_rstp_ports([1, 2], adminState='Enabled')

modify_ufd_group(group_id, threshold=None, enable=None)

Modify UFDGroups record.

Parameters:

• group_id (int) – UFD group ID
• threshold (int) – group threshold
• enable (str) – Enable or disable UFD group

Returns:

None

Examples:

env.switch[1].ui.modify_ufd_group(1, enable='Disabled')

modify_vlan_ports(ports=None, vlans=None, tagged='Tagged')

Modify Ports2Vlans records.

Parameters:

• ports (list) – list of ports to be added to Vlans.
• vlans (list[int] | set(int)) – list of vlans.
• tagged – information about ports tagging state.

Examples:

Port 1 will be modified in the vlans 3 and 4 as Tagged
env.switch[1].ui.create_vlan_ports([1, ], [3, 4], 'Tagged')

process_table_data(show_command, data, table_keys_mapping, header_rows=1)

process_vertical_table_data(show_command, data, table_keys_mapping)

read_ports(port, **kwargs)

Reads Port Attribute values from sysfs device files.

Parameters:

• port (int) – port name to read from the list.
• **kwargs (dict) – Tag Parameter to identify the Port Config Attribute.

Returns:

Port Config Attribute value

Examples:

env.switch[1].ui.modify_ports(['fm0-0', ], getAttr='def_cfi')

restart()

Perform device reboot via User Interface.

restore_config()

Restore device configuration.

save_config()

Save device configuration.

set_all_ports_admin_disabled()

Set all ports into admin Down state.

Notes

This method is used in helpers.set_all_ports_admin_disabled() for all functional test case.

Returns:None

set_dcb_admin_mode(ports, mode='Enabled')

Enable/Disable DCB on ports.

Parameters:

• ports (list[int]) – list of ports
• mode (str) – “Enabled” or ‘Disabled’

Returns:

None

Examples:

env.switch[1].ui.set_dcb_admin_mode([1, 2], "Enabled")

start_ustack_with_given_mesh_ports(mesh_ports=(), dbglevel=0)

Start ustack with given mesh ports on command line.

Parameters:

• mesh_ports (list) – List of mesh ports given by command line user
• dbglevel (int) – dbglevel value

Returns:

Success or failure report.

Examples:

env.switch[1].ui.start_ustack_with_given_mesh_ports('sw0p1,sw0p2')

wait_all_ports_admin_disabled()

Wait for all ports into admin Down state.

Notes

This method is used in helpers.set_all_ports_admin_disabled() for all functional test case.

Returns:None