-import fnmatch
import os
import time
from collections import deque
-from six import moves
+from six import moves, iteritems
from vpp_papi import VPP, mac_pton
from hook import Hook
from vpp_l2 import L2_PORT_TYPE
INFO = 6
DBG = 7
+#
+# Dictionary keyed on message name to override default values for
+# named parameters
+#
+defaultmapping = {'map_add_domain': {'mtu': 1280},
+ 'syslog_set_sender': {'collector_port': 514,
+ 'max_msg_size': 480}}
+
class UnexpectedApiReturnValueError(Exception):
""" exception raised when the API return value is unexpected """
_zero, _negative = range(2)
def __init__(self, name, shm_prefix, test_class, read_timeout):
- self.hook = Hook("vpp-papi-provider")
+ self.hook = Hook(test_class)
self.name = name
self.shm_prefix = shm_prefix
self.test_class = test_class
self.test_class.logger.debug("New event: %s: %s" % (name, event))
self._events.append(event)
+ def factory(self, name, apifn):
+ def f(*a, **ka):
+ fields = apifn._func.msg.fields
+
+ # add positional and kw arguments
+ d = ka
+ for i, o in enumerate(fields[3:]):
+ try:
+ d[o] = a[i]
+ except:
+ break
+
+ # Default override
+ if name in defaultmapping:
+ for k, v in iteritems(defaultmapping[name]):
+ if k in d:
+ continue
+ d[k] = v
+ return self.api(apifn, d)
+ return f
+
+ def __getattr__(self, name):
+ try:
+ return getattr(self, name)
+ except:
+ return self.factory(name, getattr(self.papi, name))
+
def connect(self):
"""Connect the API to VPP"""
self.vpp.connect(self.name, self.shm_prefix)
return self.api(self.papi.ip_unnumbered_dump,
{'sw_if_index': sw_if_index})
- def sw_interface_enable_disable_mpls(self, sw_if_index,
- is_enable=1):
+ def sw_interface_set_mpls_enable(self, sw_if_index,
+ is_enable=1):
"""
Enable/Disable MPLS on the interface
:param sw_if_index:
{'sw_if_index': sw_if_index,
'enable': is_enable})
- def sw_interface_ra_suppress(self, sw_if_index, suppress=1):
- return self.api(self.papi.sw_interface_ip6nd_ra_config,
- {'sw_if_index': sw_if_index,
- 'suppress': suppress})
-
def set_ip_flow_hash(self,
table_id,
src=1,
'reverse': reverse,
'is_ipv6': is_ip6})
- def ip6_nd_proxy(self, address, sw_if_index, is_del=0):
+ def ip6nd_proxy_add_del(self, ip, sw_if_index, is_del=0):
return self.api(self.papi.ip6nd_proxy_add_del,
- {'address': address,
+ {'ip': ip,
'sw_if_index': sw_if_index,
'is_del': is_del})
- def ip6_sw_interface_ra_config(self, sw_if_index,
- no,
- suppress,
- send_unicast):
- return self.api(self.papi.sw_interface_ip6nd_ra_config,
- {'sw_if_index': sw_if_index,
- 'is_no': no,
- 'suppress': suppress,
- 'send_unicast': send_unicast})
-
- def ip6_sw_interface_ra_prefix(self,
- sw_if_index,
- address,
- address_length,
- use_default=0,
- no_advertise=0,
- off_link=0,
- no_autoconfig=0,
- no_onlink=0,
- is_no=0,
- val_lifetime=0xffffffff,
- pref_lifetime=0xffffffff):
+ def sw_interface_ip6nd_ra_prefix(self,
+ sw_if_index,
+ address,
+ address_length,
+ use_default=0,
+ no_advertise=0,
+ off_link=0,
+ no_autoconfig=0,
+ no_onlink=0,
+ is_no=0,
+ val_lifetime=0xffffffff,
+ pref_lifetime=0xffffffff):
return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
{'sw_if_index': sw_if_index,
- 'address': address,
- 'address_length': address_length,
+ 'prefix': {
+ 'address': address,
+ 'address_length': address_length,
+ },
'use_default': use_default,
'no_advertise': no_advertise,
'off_link': off_link,
'val_lifetime': val_lifetime,
'pref_lifetime': pref_lifetime})
- def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
+ def sw_interface_ip6_enable_disable(self, sw_if_index, enable):
"""
Enable/Disable An interface for IPv6
"""
return self.api(self.papi.bd_ip_mac_dump,
{'bd_id': bd_id})
- def want_ip4_arp_events(self, enable_disable=1, address=0):
+ def want_ip4_arp_events(self, enable_disable=1, ip="0.0.0.0"):
return self.api(self.papi.want_ip4_arp_events,
{'enable_disable': enable_disable,
- 'address': address,
+ 'ip': ip,
'pid': os.getpid(), })
- def want_ip6_nd_events(self, enable_disable=1, address=0):
+ def want_ip6_nd_events(self, enable_disable=1, ip="::"):
return self.api(self.papi.want_ip6_nd_events,
{'enable_disable': enable_disable,
- 'address': address,
+ 'ip': ip,
'pid': os.getpid(), })
def want_ip6_ra_events(self, enable_disable=1):
{'enable_disable': enable_disable,
'pid': os.getpid(), })
- def want_macs_learn_events(self, enable_disable=1, scan_delay=0,
- max_macs_in_event=0, learn_limit=0):
+ def want_l2_macs_events(self, enable_disable=1, scan_delay=0,
+ max_macs_in_event=0, learn_limit=0):
return self.api(self.papi.want_l2_macs_events,
{'enable_disable': enable_disable,
'scan_delay': scan_delay,
'tx_sw_if_index': tx_sw_if_index,
'enable': enable})
- def sw_interface_set_l2_tag_rewrite(
+ def l2_interface_vlan_tag_rewrite(
self,
sw_if_index,
vtr_oper,
'tag1': tag1,
'tag2': tag2})
- def sw_interface_set_l2_emulation(
+ def l2_emulation(
self,
sw_if_index,
enable=1):
{'sw_if_index': sw_if_index,
'mtu': mtu})
- def sw_interface_set_promiscuous(self, sw_if_index, enable):
- """
- :param sw_if_index:
- :param enable:
-
- """
- return self.api(self.papi.sw_interface_set_promiscuous,
- {'sw_if_index': sw_if_index,
- 'enable': enable})
-
def sw_interface_set_mac_address(self, sw_if_index, mac):
return self.api(self.papi.sw_interface_set_mac_address,
{'sw_if_index': sw_if_index,
'outer_vlan_id': outer_vlan,
'inner_vlan_id': inner_vlan})
- def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
+ def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id):
"""Create p2p ethernet subinterface
:param sw_if_index: main (parent) interface
return self.api(self.papi.delete_subif,
{'sw_if_index': sw_if_index})
- def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
+ def p2p_ethernet_del(self, sw_if_index, remote_mac):
"""Delete p2p ethernet subinterface
:param sw_if_index: main (parent) interface
def ip_neighbor_add_del(self,
sw_if_index,
mac_address,
- dst_address,
+ ip_address,
is_add=1,
- is_ipv6=0,
- is_static=0,
- is_no_adj_fib=0,
- ):
+ flags=0):
""" Add neighbor MAC to IPv4 or IPv6 address.
:param sw_if_index:
:param mac_address:
:param dst_address:
:param is_add: (Default value = 1)
- :param is_ipv6: (Default value = 0)
- :param is_static: (Default value = 0)
- :param is_no_adj_fib: (Default value = 0)
+ :param flags: (Default value = 0/NONE)
"""
return self.api(
self.papi.ip_neighbor_add_del,
- {'sw_if_index': sw_if_index,
- 'is_add': is_add,
- 'is_ipv6': is_ipv6,
- 'is_static': is_static,
- 'is_no_adj_fib': is_no_adj_fib,
- 'mac_address': mac_address,
- 'dst_address': dst_address
- }
+ {
+ 'is_add': is_add,
+ 'neighbor': {
+ 'sw_if_index': sw_if_index,
+ 'flags': flags,
+ 'mac_address': mac_address,
+ 'ip_address': ip_address
+ }
+ }
)
def ip_neighbor_dump(self,
)
def proxy_arp_add_del(self,
- low_address,
- hi_address,
- vrf_id=0,
+ low,
+ hi,
+ table_id=0,
is_add=1):
""" Config Proxy Arp Range.
self.papi.proxy_arp_add_del,
{'proxy':
{
- 'vrf_id': vrf_id,
- 'low_address': low_address,
- 'hi_address': hi_address,
+ 'table_id': table_id,
+ 'low': low,
+ 'hi': hi,
},
'is_add': is_add})
}
)
- def reset_vrf(self,
- vrf_id,
- is_ipv6=0,
- ):
- """ Reset VRF (remove all routes etc.) request.
-
- :param int vrf_id: ID of the FIB table / VRF to reset.
- :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
- """
-
- return self.api(
- self.papi.reset_vrf,
- {'vrf_id': vrf_id,
- 'is_ipv6': is_ipv6,
- }
- )
-
def reset_fib(self,
vrf_id,
is_ipv6=0,
'is_l2': is_l2,
})
- def gre_tunnel_add_del(self,
+ def gre_add_del_tunnel(self,
src_address,
dst_address,
outer_fib_id=0,
def udp_encap_dump(self):
return self.api(self.papi.udp_encap_dump, {})
- def want_udp_encap_stats(self, enable=1):
- return self.api(self.papi.want_udp_encap_stats,
- {'enable': enable,
- 'pid': os.getpid()})
-
def mpls_fib_dump(self):
return self.api(self.papi.mpls_fib_dump, {})
"""
return self.api(self.papi.nat_show_config, {})
- def nat44_add_interface_addr(
+ def nat44_add_del_interface_addr(
self,
sw_if_index,
twice_nat=0,
"""
return self.api(self.papi.nat44_interface_addr_dump, {})
- def nat_ipfix(
+ def nat_ipfix_enable_disable(
self,
domain_id=1,
src_port=4739,
"""
return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
- def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
- tcp_incoming_syn=6):
- """Set values of timeouts for NAT64 (in seconds)
-
- :param udpi: UDP timeout (Default value = 300)
- :param icmp: ICMP timeout (Default value = 60)
- :param tcp_trans: TCP transitory timeout (Default value = 240)
- :param tcp_est: TCP established timeout (Default value = 7440)
- :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
- """
- return self.api(
- self.papi.nat64_set_timeouts,
- {'udp': udp,
- 'icmp': icmp,
- 'tcp_trans': tcp_trans,
- 'tcp_est': tcp_est,
- 'tcp_incoming_syn': tcp_incoming_syn})
-
- def nat64_get_timeouts(self):
- """Get values of timeouts for NAT64
-
- :return: Timeouts for NAT64 (in seconds)
- """
- return self.api(self.papi.nat64_get_timeouts, {})
-
def nat64_st_dump(self, protocol=255):
"""Dump NAT64 session table
"""
return self.api(self.papi.nat64_prefix_dump, {})
- def nat64_add_interface_addr(
+ def nat64_add_del_interface_addr(
self,
sw_if_index,
is_add=1):
"""
return self.api(self.papi.nat66_static_mapping_dump, {})
+ def nat_ha_set_listener(self, addr, port, path_mtu=512):
+ """Set HA listener (local settings)
+
+ :param addr: local IP4 address
+ :param port: local UDP port number
+ :param path_mtu: path MTU (Default value = 512)
+ """
+ return self.api(self.papi.nat_ha_set_listener,
+ {'ip_address': addr,
+ 'port': port,
+ 'path_mtu': path_mtu})
+
+ def nat_ha_get_listener(self):
+ """Get HA listener/local configuration"""
+ return self.api(self.papi.nat_ha_get_listener, {})
+
+ def nat_ha_set_failover(self, addr, port, refresh=10):
+ """Set HA failover (remote settings)
+
+ :param addr: failover IP4 address
+ :param port: failvoer UDP port number
+ :param refresh: number of seconds after which to send session refresh
+ """
+ return self.api(self.papi.nat_ha_set_failover,
+ {'ip_address': addr,
+ 'port': port,
+ 'session_refresh_interval': refresh})
+
+ def nat_ha_get_failover(self):
+ """Get HA failover/remote settings reply"""
+ return self.api(self.papi.nat_ha_get_failover, {})
+
+ def nat_ha_flush(self):
+ """Flush the current HA data"""
+ return self.api(self.papi.nat_ha_flush, {})
+
+ def nat_ha_resync(self, want_resync_event=1):
+ """Resync HA (resend existing sessions to new failover)
+ :param want_resync_event: if non-zero resync completed event sent
+ """
+ return self.api(self.papi.nat_ha_resync,
+ {'want_resync_event': want_resync_event,
+ 'pid': os.getpid()})
+
def control_ping(self):
self.api(self.papi.control_ping)
def dhcp_client_dump(self):
return self.api(self.papi.dhcp_client_dump, {})
- def dhcp_client(self,
- sw_if_index,
- hostname,
- client_id='',
- is_add=1,
- set_broadcast_flag=1,
- want_dhcp_events=0):
+ def dhcp_client_config(self,
+ sw_if_index,
+ hostname,
+ client_id='',
+ is_add=1,
+ set_broadcast_flag=1,
+ want_dhcp_events=0):
return self.api(
self.papi.dhcp_client_config,
{
'is_en': is_enabled,
})
- def lisp_locator_set(self,
- ls_name,
- is_add=1):
+ def lisp_add_del_locator_set(self,
+ ls_name,
+ is_add=1):
return self.api(
self.papi.lisp_add_del_locator_set,
{
def lisp_locator_set_dump(self):
return self.api(self.papi.lisp_locator_set_dump, {})
- def lisp_locator(self,
- ls_name,
- sw_if_index,
- priority=1,
- weight=1,
- is_add=1):
+ def lisp_add_del_locator(self,
+ ls_name,
+ sw_if_index,
+ priority=1,
+ weight=1,
+ is_add=1):
return self.api(
self.papi.lisp_add_del_locator,
{
'ls_index': ls_index,
})
- def lisp_local_mapping(self,
- ls_name,
- eid_type,
- eid,
- prefix_len,
- vni=0,
- key_id=0,
- key="",
- is_add=1):
+ def lisp_add_del_local_eid(self,
+ ls_name,
+ eid_type,
+ eid,
+ prefix_len,
+ vni=0,
+ key_id=0,
+ key="",
+ is_add=1):
return self.api(
self.papi.lisp_add_del_local_eid,
{
'filter': filter_opt,
})
- def lisp_remote_mapping(self,
- eid_type,
- eid,
- eid_prefix_len=0,
- vni=0,
- rlocs=[],
- rlocs_num=0,
- is_src_dst=0,
- is_add=1):
+ def lisp_add_del_remote_mapping(self,
+ eid_type,
+ eid,
+ eid_prefix_len=0,
+ vni=0,
+ rlocs=[],
+ rlocs_num=0,
+ is_src_dst=0,
+ is_add=1):
return self.api(
self.papi.lisp_add_del_remote_mapping,
{
'is_src_dst': is_src_dst,
})
- def lisp_adjacency(self,
- leid,
- reid,
- leid_len,
- reid_len,
- eid_type,
- is_add=1,
- vni=0):
+ def lisp_add_del_adjacency(self,
+ leid,
+ reid,
+ leid_len,
+ reid_len,
+ eid_type,
+ is_add=1,
+ vni=0):
return self.api(
self.papi.lisp_add_del_adjacency,
{
'vni': vni
})
- def map_add_domain(self,
- ip6_prefix,
- ip6_src,
- ip4_prefix,
- ea_bits_len=0,
- psid_offset=0,
- psid_length=0,
- mtu=1280):
-
- return self.api(
- self.papi.map_add_domain,
- {
- 'ip6_prefix': ip6_prefix,
- 'ip4_prefix': ip4_prefix,
- 'ip6_src': ip6_src,
- 'ea_bits_len': ea_bits_len,
- 'psid_offset': psid_offset,
- 'psid_length': psid_length,
- 'mtu': mtu
- })
-
- def map_if_enable_disable(self, is_enable, sw_if_index, is_translation):
- return self.api(
- self.papi.map_if_enable_disable,
- {
- 'is_enable': is_enable,
- 'sw_if_index': sw_if_index,
- 'is_translation': is_translation,
- })
-
- def map_param_set_tcp(self, tcp_mss):
- return self.api(
- self.papi.map_param_set_tcp,
- {
- 'tcp_mss': tcp_mss,
- })
-
def gtpu_add_del_tunnel(
self,
src_addr,
self.papi.ipsec_spd_add_del, {
'spd_id': spd_id, 'is_add': is_add})
+ def ipsec_spds_dump(self):
+ return self.api(self.papi.ipsec_spds_dump, {})
+
def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
""" IPSEC interface SPD add/del - \
Wrapper to associate/disassociate SPD to interface in VPP
self.papi.ipsec_interface_add_del_spd,
{'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add})
- def ipsec_sad_add_del_entry(self,
+ def ipsec_spd_interface_dump(self, spd_index=None):
+ return self.api(self.papi.ipsec_spd_interface_dump,
+ {'spd_index': spd_index if spd_index else 0,
+ 'spd_index_valid': 1 if spd_index else 0})
+
+ def ipsec_sad_entry_add_del(self,
sad_id,
spi,
integrity_algorithm,
protocol,
tunnel_src_address='',
tunnel_dst_address='',
- is_tunnel=1,
- is_tunnel_ipv6=0,
- is_add=1,
- udp_encap=0,
- use_anti_replay=0,
- use_extended_sequence_number=0):
+ flags=0,
+ is_add=1):
""" IPSEC SA add/del
:param sad_id: security association ID
:param spi: security param index of the SA in decimal
crypto and ipsec algorithms
"""
return self.api(
- self.papi.ipsec_sad_add_del_entry,
- {'sad_id': sad_id,
- 'spi': spi,
- 'tunnel_src_address': tunnel_src_address,
- 'tunnel_dst_address': tunnel_dst_address,
- 'protocol': protocol,
- 'integrity_algorithm': integrity_algorithm,
- 'integrity_key_length': len(integrity_key),
- 'integrity_key': integrity_key,
- 'crypto_algorithm': crypto_algorithm,
- 'crypto_key_length': len(crypto_key) if crypto_key is not None
- else 0,
- 'crypto_key': crypto_key,
- 'is_add': is_add,
- 'is_tunnel': is_tunnel,
- 'is_tunnel_ipv6': is_tunnel_ipv6,
- 'udp_encap': udp_encap,
- 'use_extended_sequence_number': use_extended_sequence_number,
- 'use_anti_replay': use_anti_replay})
+ self.papi.ipsec_sad_entry_add_del,
+ {
+ 'is_add': is_add,
+ 'entry':
+ {
+ 'sad_id': sad_id,
+ 'spi': spi,
+ 'tunnel_src': tunnel_src_address,
+ 'tunnel_dst': tunnel_dst_address,
+ 'protocol': protocol,
+ 'integrity_algorithm': integrity_algorithm,
+ 'integrity_key': {
+ 'length': len(integrity_key),
+ 'data': integrity_key,
+ },
+ 'crypto_algorithm': crypto_algorithm,
+ 'crypto_key': {
+ 'length': len(crypto_key),
+ 'data': crypto_key,
+ },
+ 'flags': flags,
+ }
+ })
- def ipsec_spd_add_del_entry(self,
+ def ipsec_sa_dump(self, sa_id=None):
+ return self.api(self.papi.ipsec_sa_dump,
+ {'sa_id': sa_id if sa_id else 0xffffffff})
+
+ def ipsec_spd_entry_add_del(self,
spd_id,
sa_id,
local_address_start,
:param is_add: (Default value = 1)
"""
return self.api(
- self.papi.ipsec_spd_add_del_entry,
- {'spd_id': spd_id,
- 'sa_id': sa_id,
- 'local_address_start': local_address_start,
- 'local_address_stop': local_address_stop,
- 'remote_address_start': remote_address_start,
- 'remote_address_stop': remote_address_stop,
- 'local_port_start': local_port_start,
- 'local_port_stop': local_port_stop,
- 'remote_port_start': remote_port_start,
- 'remote_port_stop': remote_port_stop,
- 'is_add': is_add,
- 'protocol': protocol,
- 'policy': policy,
- 'priority': priority,
- 'is_outbound': is_outbound,
- 'is_ipv6': is_ipv6,
- 'is_ip_any': is_ip_any})
+ self.papi.ipsec_spd_entry_add_del,
+ {
+ 'is_add': is_add,
+ 'entry':
+ {
+ 'spd_id': spd_id,
+ 'sa_id': sa_id,
+ 'local_address_start': local_address_start,
+ 'local_address_stop': local_address_stop,
+ 'remote_address_start': remote_address_start,
+ 'remote_address_stop': remote_address_stop,
+ 'local_port_start': local_port_start,
+ 'local_port_stop': local_port_stop,
+ 'remote_port_start': remote_port_start,
+ 'remote_port_stop': remote_port_stop,
+ 'protocol': protocol,
+ 'policy': policy,
+ 'priority': priority,
+ 'is_outbound': is_outbound,
+ 'is_ip_any': is_ip_any
+ }
+ })
+
+ def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff):
+ return self.api(self.papi.ipsec_spd_dump,
+ {'spd_id': spd_id,
+ 'sa_id': sa_id})
def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi,
remote_spi, crypto_alg, local_crypto_key,
def ipsec_backend_dump(self):
return self.api(self.papi.ipsec_backend_dump, {})
- def app_namespace_add(self,
- namespace_id,
- ip4_fib_id=0,
- ip6_fib_id=0,
- sw_if_index=0xFFFFFFFF,
- secret=0):
+ def app_namespace_add_del(self,
+ namespace_id,
+ ip4_fib_id=0,
+ ip6_fib_id=0,
+ sw_if_index=0xFFFFFFFF,
+ secret=0):
return self.api(
self.papi.app_namespace_add_del,
{'secret': secret,
{'_no_type_conversion': True})
def gbp_endpoint_group_add(self, epg, sclass, bd,
- rd, uplink_sw_if_index):
+ rd, uplink_sw_if_index,
+ retention):
""" GBP endpoint group Add """
return self.api(self.papi.gbp_endpoint_group_add,
{'epg':
'bd_id': bd,
'rd_id': rd,
'epg_id': epg,
- 'sclass': sclass
+ 'sclass': sclass,
+ 'retention': retention
}})
def gbp_endpoint_group_del(self, epg):
""" GBP contract Dump """
return self.api(self.papi.gbp_contract_dump, {})
- def gbp_endpoint_learn_set_inactive_threshold(self, threshold):
- """ GBP set inactive threshold """
- return self.api(self.papi.gbp_endpoint_learn_set_inactive_threshold,
- {'threshold': threshold})
-
def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode):
""" GBP VXLAN tunnel add """
return self.api(self.papi.gbp_vxlan_tunnel_add,
def svs_dump(self):
return self.api(self.papi.svs_dump, {})
-
- def syslog_set_sender(
- self,
- collector,
- src,
- collector_port=514,
- vrf_id=0,
- max_msg_size=480):
- """Set syslog sender configuration
-
- :param collector: colector IP address
- :param src: source IP address
- :param collector_port: collector UDP port (Default value = 514)
- :param vrf_id: VRF id (Default value = 0)
- :param max_msg_size: maximum message length (Default value = 480)
- """
- return self.api(self.papi.syslog_set_sender,
- {'collector_address': collector,
- 'src_address': src,
- 'collector_port': collector_port,
- 'vrf_id': vrf_id,
- 'max_msg_size': max_msg_size})
-
- def syslog_get_sender(self):
- """Return syslog sender configuration"""
- return self.api(self.papi.syslog_get_sender, {})
-
- def syslog_set_filter(self, severity):
- """Set syslog filter parameters
-
- :param severity: severity filter (specified severity and greater match)
- """
- return self.api(self.papi.syslog_set_filter, {'severity': severity})
-
- def syslog_get_filter(self):
- """Return syslog filter parameters"""
- return self.api(self.papi.syslog_get_filter, {})