Repository navigation
Expand file tree
/
Copy pathl3_conntrack_helper.py
More file actions
304 lines (262 loc) · 9.59 KB
/
Copy pathl3_conntrack_helper.py
File metadata and controls
304 lines (262 loc) · 9.59 KB
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
# 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.
#
"""L3 Conntrack Helper action implementations"""
import argparse
import logging
from collections.abc import Iterable, Sequence
from typing import Any
from openstack.network.v2 import l3_conntrack_helper as _l3_conntrack_helper
from osc_lib import exceptions
from osc_lib import utils
from openstackclient import command
from openstackclient.common import pagination
from openstackclient.i18n import _
LOG = logging.getLogger(__name__)
def _get_columns(
item: _l3_conntrack_helper.ConntrackHelper,
) -> tuple[tuple[str, ...], tuple[str, ...]]:
hidden_columns = ['location', 'tenant_id']
return utils.get_osc_show_columns_for_sdk_resource(
item, {}, hidden_columns
)
def _get_attrs(client: Any, parsed_args: argparse.Namespace) -> dict[str, Any]:
router = client.find_router(parsed_args.router, ignore_missing=False)
attrs: dict[str, Any] = {'router_id': router.id}
if parsed_args.helper:
attrs['helper'] = parsed_args.helper
if parsed_args.protocol:
attrs['protocol'] = parsed_args.protocol
if parsed_args.port:
attrs['port'] = parsed_args.port
return attrs
class CreateConntrackHelper(command.ShowOne):
_description = _("Create a new L3 conntrack helper")
def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
parser = super().get_parser(prog_name)
parser.add_argument(
'router',
metavar='<router>',
help=_('Router for which conntrack helper will be created'),
)
parser.add_argument(
'--helper',
required=True,
metavar='<helper>',
help=_('The netfilter conntrack helper module'),
)
parser.add_argument(
'--protocol',
required=True,
metavar='<protocol>',
help=_(
'The network protocol for the netfilter conntrack target rule'
),
)
parser.add_argument(
'--port',
required=True,
metavar='<port>',
type=int,
help=_('The network port for the netfilter conntrack target rule'),
)
return parser
def take_action(
self, parsed_args: argparse.Namespace
) -> tuple[Sequence[str], Iterable[Any]]:
client = self.app.client_manager.network
attrs = _get_attrs(client, parsed_args)
obj = client.create_conntrack_helper(attrs.pop('router_id'), **attrs)
display_columns, columns = _get_columns(obj)
data = utils.get_item_properties(obj, columns, formatters={})
return (display_columns, data)
class DeleteConntrackHelper(command.Command):
_description = _("Delete L3 conntrack helper")
def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
parser = super().get_parser(prog_name)
parser.add_argument(
'router',
metavar='<router>',
help=_('Router that the conntrack helper belongs to'),
)
parser.add_argument(
'conntrack_helper_id',
metavar='<conntrack-helper-id>',
nargs='+',
help=_('The ID of the conntrack helper(s) to delete'),
)
return parser
def take_action(self, parsed_args: argparse.Namespace) -> None:
client = self.app.client_manager.network
result = 0
router = client.find_router(parsed_args.router, ignore_missing=False)
for ct_helper in parsed_args.conntrack_helper_id:
try:
client.delete_conntrack_helper(
ct_helper, router.id, ignore_missing=False
)
except Exception as e:
result += 1
LOG.error(
_(
"Failed to delete L3 conntrack helper with "
"ID '%(ct_helper)s': %(e)s"
),
{'ct_helper': ct_helper, 'e': e},
)
if result > 0:
total = len(parsed_args.conntrack_helper_id)
msg = _(
"%(result)s of %(total)s L3 conntrack helpers failed "
"to delete."
) % {'result': result, 'total': total}
raise exceptions.CommandError(msg)
class ListConntrackHelper(command.Lister):
_description = _("List L3 conntrack helpers")
def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
parser = super().get_parser(prog_name)
parser.add_argument(
'router',
metavar='<router>',
help=_('Router that the conntrack helper belongs to'),
)
parser.add_argument(
'--helper',
metavar='<helper>',
help=_(
'List only helpers using the specified netfilter conntrack '
'helper module'
),
)
parser.add_argument(
'--protocol',
metavar='<protocol>',
help=_(
'List only helpers with the specified network protocol for '
'the netfilter conntrack target rule'
),
)
parser.add_argument(
'--port',
metavar='<port>',
help=_(
'List only helpers with the specified network port for '
'the netfilter conntrack target rule (name or ID)'
),
)
pagination.add_marker_pagination_option_to_parser(parser)
return parser
def take_action(
self, parsed_args: argparse.Namespace
) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
client = self.app.client_manager.network
columns = (
'id',
'router_id',
'helper',
'protocol',
'port',
)
column_headers = (
'ID',
'Router ID',
'Helper',
'Protocol',
'Port',
)
attrs = _get_attrs(client, parsed_args)
if parsed_args.marker is not None:
attrs['marker'] = parsed_args.marker
if parsed_args.limit is not None:
attrs['limit'] = parsed_args.limit
if parsed_args.max_items is not None:
attrs['max_items'] = parsed_args.max_items
data = client.conntrack_helpers(attrs.pop('router_id'), **attrs)
return (
column_headers,
(
utils.get_item_properties(
s,
columns,
formatters={},
)
for s in data
),
)
class SetConntrackHelper(command.Command):
_description = _("Set L3 conntrack helper properties")
def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
parser = super().get_parser(prog_name)
parser.add_argument(
'router',
metavar='<router>',
help=_('Router that the conntrack helper belongs to'),
)
parser.add_argument(
'conntrack_helper_id',
metavar='<conntrack-helper-id>',
help=_('The ID of the conntrack helper(s)'),
)
parser.add_argument(
'--helper',
metavar='<helper>',
help=_('The netfilter conntrack helper module'),
)
parser.add_argument(
'--protocol',
metavar='<protocol>',
help=_(
'The network protocol for the netfilter conntrack target rule'
),
)
parser.add_argument(
'--port',
metavar='<port>',
type=int,
help=_('The network port for the netfilter conntrack target rule'),
)
return parser
def take_action(self, parsed_args: argparse.Namespace) -> None:
client = self.app.client_manager.network
attrs = _get_attrs(client, parsed_args)
if attrs:
client.update_conntrack_helper(
parsed_args.conntrack_helper_id,
attrs.pop('router_id'),
**attrs,
)
class ShowConntrackHelper(command.ShowOne):
_description = _("Display L3 conntrack helper details")
def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
parser = super().get_parser(prog_name)
parser.add_argument(
'router',
metavar='<router>',
help=_('Router that the conntrack helper belongs to'),
)
parser.add_argument(
'conntrack_helper_id',
metavar='<conntrack-helper-id>',
help=_('The ID of the conntrack helper'),
)
return parser
def take_action(
self, parsed_args: argparse.Namespace
) -> tuple[Sequence[str], Iterable[Any]]:
client = self.app.client_manager.network
router = client.find_router(parsed_args.router, ignore_missing=False)
obj = client.get_conntrack_helper(
parsed_args.conntrack_helper_id, router.id
)
display_columns, columns = _get_columns(obj)
data = utils.get_item_properties(obj, columns, formatters={})
return (display_columns, data)