1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
# Copyright (c) 2019 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""COP utilities library."""
from resources.libraries.python.PapiExecutor import PapiSocketExecutor
from resources.libraries.python.topology import Topology
class Cop(object):
"""COP utilities."""
@staticmethod
def cop_add_whitelist_entry(
node, interface, ip_version, fib_id, default_cop=0):
"""Add cop whitelisted entry.
:param node: Node to add COP whitelist on.
:param interface: Interface of the node where the COP is added.
:param ip_version: IP version. 'ip4' and 'ip6' are valid values.
:param fib_id: Specify the fib table ID.
:param default_cop: 1 => enable non-ip4, non-ip6 filtration,
0 => disable it.
:type node: dict
:type interface: str
:type ip_version: str
:type fib_id: int
:type default_cop: int
:raises ValueError: If parameter 'ip_version' has incorrect value.
"""
if ip_version not in ('ip4', 'ip6'):
raise ValueError('IP version is not in correct format')
cmd = 'cop_whitelist_enable_disable'
err_msg = 'Failed to add COP whitelist on interface {ifc} on host' \
' {host}'.format(ifc=interface, host=node['host'])
args = dict(
sw_if_index=Topology.get_interface_sw_index(node, interface),
fib_id=int(fib_id),
ip4=True if ip_version == 'ip4' else False,
ip6=True if ip_version == 'ip6' else False,
default_cop=default_cop
)
with PapiSocketExecutor(node) as papi_exec:
papi_exec.add(cmd, **args).get_reply(err_msg)
@staticmethod
def cop_interface_enable_or_disable(node, interface, state):
"""Enable or disable COP on the interface.
:param node: Node to add COP whitelist on.
:param interface: Interface of the node where the COP is added.
:param state: Enable or disable COP on the interface.
:type node: dict
:type interface: str
:type state: str
:raises ValueError: If parameter 'state' has incorrect value.
"""
state = state.lower()
if state in ('enable', 'disable'):
enable = True if state == 'enable' else False
else:
raise ValueError("Possible state values are 'enable' or 'disable'")
cmd = 'cop_interface_enable_disable'
err_msg = 'Failed to enable/disable COP on interface {ifc} on host' \
' {host}'.format(ifc=interface, host=node['host'])
args = dict(
sw_if_index=Topology.get_interface_sw_index(node, interface),
enable_disable=enable
)
with PapiSocketExecutor(node) as papi_exec:
papi_exec.add(cmd, **args).get_reply(err_msg)
|
