Repository navigation
Expand file tree
/
Copy pathip_availability.py
More file actions
172 lines (150 loc) · 5.6 KB
/
Copy pathip_availability.py
File metadata and controls
172 lines (150 loc) · 5.6 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
# 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.
#
"""IP Availability Info implementations"""
import argparse
from collections.abc import Iterable, Sequence
from typing import Any
from openstack.network.v2 import network_ip_availability as _ip_availability
from osc_lib.cli import format_columns
from osc_lib import utils
from openstackclient import command
from openstackclient.common import pagination
from openstackclient.i18n import _
from openstackclient.identity import common as identity_common
_formatters = {
'subnet_ip_availability': format_columns.ListDictColumn,
'ip_availability_details': format_columns.DictColumn,
}
# Keys of the 'ip_availability_details' attribute, added by the
# 'network-ip-availability-details' extension.
_DETAIL_FIELDS = (
'total_ips_in_subnet',
'total_ips_in_allocation_pool',
'used_ips_in_subnet',
'used_ips_in_allocation_pool',
)
def _get_columns(
item: _ip_availability.NetworkIPAvailability,
) -> tuple[tuple[str, ...], tuple[str, ...]]:
hidden_columns = ['id', 'name', 'location', 'tenant_id']
return utils.get_osc_show_columns_for_sdk_resource(
item, {}, hidden_columns
)
def _get_detail(
item: _ip_availability.NetworkIPAvailability, field: str
) -> Any:
"""Return a single key of the 'ip_availability_details' attribute.
The attribute is only set when the 'network-ip-availability-details'
extension is enabled, so fall back to an empty value.
"""
details = item.ip_availability_details or {}
return details.get(field, '')
class ListIPAvailability(command.Lister):
_description = _("List IP availability for network")
def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
parser = super().get_parser(prog_name)
parser.add_argument(
'--ip-version',
type=int,
default=4,
choices=[4, 6],
metavar='<ip-version>',
dest='ip_version',
help=_(
"List only IP availability with the specified IP version "
"networks (4 or 6, default is 4)"
),
)
parser.add_argument(
'--project',
metavar='<project>',
help=_(
"List only IP availability with the specified project "
"(name or ID)"
),
)
identity_common.add_project_domain_option_to_parser(parser)
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 = (
'network_id',
'network_name',
'total_ips',
'used_ips',
)
column_headers = (
'Network ID',
'Network Name',
'Total IPs',
'Used IPs',
'Total IPs in Subnet',
'Total IPs in Allocation Pool',
'Used IPs in Subnet',
'Used IPs in Allocation Pool',
)
filters = {}
if parsed_args.ip_version:
filters['ip_version'] = parsed_args.ip_version
if parsed_args.project:
identity_client = self.app.client_manager.sdk_connection.identity
project_id = identity_common.find_project_id_sdk(
identity_client,
parsed_args.project,
parsed_args.project_domain,
)
filters['project_id'] = project_id
if parsed_args.marker is not None:
filters['marker'] = parsed_args.marker
if parsed_args.limit is not None:
filters['limit'] = parsed_args.limit
if parsed_args.max_items is not None:
filters['max_items'] = parsed_args.max_items
data = client.network_ip_availabilities(**filters)
return (
column_headers,
(
utils.get_item_properties(
s,
columns,
)
+ tuple(_get_detail(s, field) for field in _DETAIL_FIELDS)
for s in data
),
)
class ShowIPAvailability(command.ShowOne):
_description = _("Show network IP availability details")
def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
parser = super().get_parser(prog_name)
parser.add_argument(
'network',
metavar="<network>",
help=_("Show IP availability for a specific network (name or ID)"),
)
return parser
def take_action(
self, parsed_args: argparse.Namespace
) -> tuple[Sequence[str], Iterable[Any]]:
client = self.app.client_manager.network
network_id = client.find_network(
parsed_args.network, ignore_missing=False
).id
obj = client.find_network_ip_availability(
network_id, ignore_missing=False
)
display_columns, columns = _get_columns(obj)
data = utils.get_item_properties(obj, columns, formatters=_formatters)
return (display_columns, data)