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 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594
|
# 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 Floating action implementations"""
from openstack import exceptions as sdk_exceptions
from osc_lib import utils
from osc_lib.utils import tags as _tag
from openstackclient.api import compute_v2
from openstackclient.i18n import _
from openstackclient.identity import common as identity_common
from openstackclient.network import common
_formatters = {
'port_details': utils.format_dict,
}
def _get_network_columns(item):
column_map = {}
hidden_columns = ['location', 'tenant_id']
return utils.get_osc_show_columns_for_sdk_resource(
item, column_map, hidden_columns
)
def _get_columns(item):
columns = list(item.keys())
return tuple(sorted(columns))
def _get_attrs(client_manager, parsed_args):
attrs = {}
network_client = client_manager.network
# Name of a network could be empty string.
if parsed_args.network is not None:
network = network_client.find_network(
parsed_args.network, ignore_missing=False
)
attrs['floating_network_id'] = network.id
if parsed_args.subnet:
subnet = network_client.find_subnet(
parsed_args.subnet, ignore_missing=False
)
attrs['subnet_id'] = subnet.id
if parsed_args.port:
port = network_client.find_port(parsed_args.port, ignore_missing=False)
attrs['port_id'] = port.id
if parsed_args.floating_ip_address:
attrs['floating_ip_address'] = parsed_args.floating_ip_address
if parsed_args.fixed_ip_address:
attrs['fixed_ip_address'] = parsed_args.fixed_ip_address
if parsed_args.qos_policy:
attrs['qos_policy_id'] = network_client.find_qos_policy(
parsed_args.qos_policy, ignore_missing=False
).id
if parsed_args.description is not None:
attrs['description'] = parsed_args.description
if parsed_args.project:
identity_client = client_manager.identity
project_id = identity_common.find_project(
identity_client,
parsed_args.project,
parsed_args.project_domain,
).id
attrs['project_id'] = project_id
if parsed_args.dns_domain:
attrs['dns_domain'] = parsed_args.dns_domain
if parsed_args.dns_name:
attrs['dns_name'] = parsed_args.dns_name
return attrs
class CreateFloatingIP(
common.NetworkAndComputeShowOne, common.NeutronCommandWithExtraArgs
):
_description = _("Create floating IP")
def update_parser_common(self, parser):
# In Compute v2 network, floating IPs could be allocated from floating
# IP pools, which are actually external networks. So deprecate the
# parameter "pool", and use "network" instead.
parser.add_argument(
'network',
metavar='<network>',
help=_("Network to allocate floating IP from (name or ID)"),
)
return parser
def update_parser_network(self, parser):
parser.add_argument(
'--subnet',
metavar='<subnet>',
help=self.enhance_help_neutron(
_(
"Subnet on which you want to create the floating IP "
"(name or ID)"
)
),
)
parser.add_argument(
'--port',
metavar='<port>',
help=self.enhance_help_neutron(
_("Port to be associated with the floating IP " "(name or ID)")
),
)
parser.add_argument(
'--floating-ip-address',
metavar='<ip-address>',
dest='floating_ip_address',
help=self.enhance_help_neutron(_("Floating IP address")),
)
parser.add_argument(
'--fixed-ip-address',
metavar='<ip-address>',
dest='fixed_ip_address',
help=self.enhance_help_neutron(
_("Fixed IP address mapped to the floating IP")
),
)
parser.add_argument(
'--qos-policy',
metavar='<qos-policy>',
help=self.enhance_help_neutron(
_("Attach QoS policy to the floating IP (name or ID)")
),
)
parser.add_argument(
'--description',
metavar='<description>',
help=self.enhance_help_neutron(_('Set floating IP description')),
)
parser.add_argument(
'--project',
metavar='<project>',
help=self.enhance_help_neutron(_("Owner's project (name or ID)")),
)
parser.add_argument(
'--dns-domain',
metavar='<dns-domain>',
dest='dns_domain',
help=self.enhance_help_neutron(
_("Set DNS domain for this floating IP")
),
)
parser.add_argument(
'--dns-name',
metavar='<dns-name>',
dest='dns_name',
help=self.enhance_help_neutron(
_("Set DNS name for this floating IP")
),
)
identity_common.add_project_domain_option_to_parser(
parser, enhance_help=self.enhance_help_neutron
)
_tag.add_tag_option_to_parser_for_create(
parser, _('floating IP'), enhance_help=self.enhance_help_neutron
)
return parser
def take_action_network(self, client, parsed_args):
attrs = _get_attrs(self.app.client_manager, parsed_args)
attrs.update(
self._parse_extra_properties(parsed_args.extra_properties)
)
with common.check_missing_extension_if_error(
self.app.client_manager.network, attrs
):
obj = client.create_ip(**attrs)
# tags cannot be set when created, so tags need to be set later.
_tag.update_tags_for_set(client, obj, parsed_args)
display_columns, columns = _get_network_columns(obj)
data = utils.get_item_properties(obj, columns)
return (display_columns, data)
def take_action_compute(self, client, parsed_args):
obj = compute_v2.create_floating_ip(client, parsed_args.network)
columns = _get_columns(obj)
data = utils.get_dict_properties(obj, columns)
return (columns, data)
class DeleteFloatingIP(common.NetworkAndComputeDelete):
_description = _("Delete floating IP(s)")
# Used by base class to find resources in parsed_args.
resource = 'floating_ip'
r = None
def update_parser_common(self, parser):
parser.add_argument(
'floating_ip',
metavar="<floating-ip>",
nargs="+",
help=_("Floating IP(s) to delete (IP address or ID)"),
)
return parser
def take_action_network(self, client, parsed_args):
obj = client.find_ip(
self.r,
ignore_missing=False,
)
client.delete_ip(obj)
def take_action_compute(self, client, parsed_args):
compute_v2.delete_floating_ip(client, self.r)
class ListFloatingIP(common.NetworkAndComputeLister):
# TODO(songminglong): Use SDK resource mapped attribute names once
# the OSC minimum requirements include SDK 1.0
_description = _("List floating IP(s)")
def update_parser_network(self, parser):
parser.add_argument(
'--network',
metavar='<network>',
help=self.enhance_help_neutron(
_(
"List floating IP(s) according to "
"given network (name or ID)"
)
),
)
parser.add_argument(
'--port',
metavar='<port>',
help=self.enhance_help_neutron(
_("List floating IP(s) according to given port (name or ID)")
),
)
parser.add_argument(
'--fixed-ip-address',
metavar='<ip-address>',
help=self.enhance_help_neutron(
_("List floating IP(s) according to given fixed IP address")
),
)
parser.add_argument(
'--floating-ip-address',
metavar='<ip-address>',
help=self.enhance_help_neutron(
_(
"List floating IP(s) according to given floating IP "
"address"
)
),
)
parser.add_argument(
'--long',
action='store_true',
default=False,
help=self.enhance_help_neutron(
_("List additional fields in output")
),
)
parser.add_argument(
'--status',
metavar='<status>',
choices=['ACTIVE', 'DOWN'],
help=self.enhance_help_neutron(
_(
"List floating IP(s) according to given status ('ACTIVE', "
"'DOWN')"
)
),
)
parser.add_argument(
'--project',
metavar='<project>',
help=self.enhance_help_neutron(
_(
"List floating IP(s) according to given project (name or "
"ID)"
)
),
)
identity_common.add_project_domain_option_to_parser(parser)
parser.add_argument(
'--router',
metavar='<router>',
help=self.enhance_help_neutron(
_(
"List floating IP(s) according to given router (name or "
"ID)"
)
),
)
_tag.add_tag_filtering_option_to_parser(
parser, _('floating IP'), enhance_help=self.enhance_help_neutron
)
return parser
def take_action_network(self, client, parsed_args):
network_client = self.app.client_manager.network
identity_client = self.app.client_manager.identity
columns = (
'id',
'floating_ip_address',
'fixed_ip_address',
'port_id',
'floating_network_id',
'project_id',
)
headers = (
'ID',
'Floating IP Address',
'Fixed IP Address',
'Port',
'Floating Network',
'Project',
)
if parsed_args.long:
columns = columns + (
'router_id',
'status',
'description',
'tags',
'dns_name',
'dns_domain',
)
headers = headers + (
'Router',
'Status',
'Description',
'Tags',
'DNS Name',
'DNS Domain',
)
query = {}
if parsed_args.network is not None:
network = network_client.find_network(
parsed_args.network, ignore_missing=False
)
query['floating_network_id'] = network.id
if parsed_args.port is not None:
port = network_client.find_port(
parsed_args.port, ignore_missing=False
)
query['port_id'] = port.id
if parsed_args.fixed_ip_address is not None:
query['fixed_ip_address'] = parsed_args.fixed_ip_address
if parsed_args.floating_ip_address is not None:
query['floating_ip_address'] = parsed_args.floating_ip_address
if parsed_args.status:
query['status'] = parsed_args.status
if parsed_args.project is not None:
project = identity_common.find_project(
identity_client,
parsed_args.project,
parsed_args.project_domain,
)
query['project_id'] = project.id
if parsed_args.router is not None:
router = network_client.find_router(
parsed_args.router, ignore_missing=False
)
query['router_id'] = router.id
_tag.get_tag_filtering_args(parsed_args, query)
try:
data = list(client.ips(**query))
except sdk_exceptions.NotFoundException:
data = []
return (
headers,
(
utils.get_item_properties(
s,
columns,
formatters={},
)
for s in data
),
)
def take_action_compute(self, client, parsed_args):
columns = (
'ID',
'IP',
'Fixed IP',
'Instance ID',
'Pool',
)
headers = (
'ID',
'Floating IP Address',
'Fixed IP Address',
'Server',
'Pool',
)
objs = compute_v2.list_floating_ips(client)
return (
headers,
(
utils.get_dict_properties(
s,
columns,
formatters={},
)
for s in objs
),
)
class SetFloatingIP(common.NeutronCommandWithExtraArgs):
_description = _("Set floating IP Properties")
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
parser.add_argument(
'floating_ip',
metavar='<floating-ip>',
help=_("Floating IP to modify (IP address or ID)"),
)
parser.add_argument(
'--port',
metavar='<port>',
help=_("Associate the floating IP with port (name or ID)"),
)
parser.add_argument(
'--fixed-ip-address',
metavar='<ip-address>',
dest='fixed_ip_address',
help=_(
"Fixed IP of the port "
"(required only if port has multiple IPs)"
),
)
parser.add_argument(
'--description',
metavar='<description>',
help=_('Set floating IP description'),
)
qos_policy_group = parser.add_mutually_exclusive_group()
qos_policy_group.add_argument(
'--qos-policy',
metavar='<qos-policy>',
help=_("Attach QoS policy to the floating IP (name or ID)"),
)
qos_policy_group.add_argument(
'--no-qos-policy',
action='store_true',
help=_("Remove the QoS policy attached to the floating IP"),
)
_tag.add_tag_option_to_parser_for_set(parser, _('floating IP'))
return parser
def take_action(self, parsed_args):
client = self.app.client_manager.network
attrs = {}
obj = client.find_ip(
parsed_args.floating_ip,
ignore_missing=False,
)
if parsed_args.port:
port = client.find_port(parsed_args.port, ignore_missing=False)
attrs['port_id'] = port.id
if parsed_args.fixed_ip_address:
attrs['fixed_ip_address'] = parsed_args.fixed_ip_address
if parsed_args.description:
attrs['description'] = parsed_args.description
if parsed_args.qos_policy:
attrs['qos_policy_id'] = client.find_qos_policy(
parsed_args.qos_policy, ignore_missing=False
).id
if 'no_qos_policy' in parsed_args and parsed_args.no_qos_policy:
attrs['qos_policy_id'] = None
attrs.update(
self._parse_extra_properties(parsed_args.extra_properties)
)
if attrs:
client.update_ip(obj, **attrs)
# tags is a subresource and it needs to be updated separately.
_tag.update_tags_for_set(client, obj, parsed_args)
class ShowFloatingIP(common.NetworkAndComputeShowOne):
_description = _("Display floating IP details")
def update_parser_common(self, parser):
parser.add_argument(
'floating_ip',
metavar="<floating-ip>",
help=_("Floating IP to display (IP address or ID)"),
)
return parser
def take_action_network(self, client, parsed_args):
obj = client.find_ip(
parsed_args.floating_ip,
ignore_missing=False,
)
display_columns, columns = _get_network_columns(obj)
data = utils.get_item_properties(obj, columns, formatters=_formatters)
return (display_columns, data)
def take_action_compute(self, client, parsed_args):
obj = compute_v2.get_floating_ip(client, parsed_args.floating_ip)
columns = _get_columns(obj)
data = utils.get_dict_properties(obj, columns)
return (columns, data)
class UnsetFloatingIP(common.NeutronCommandWithExtraArgs):
_description = _("Unset floating IP Properties")
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
parser.add_argument(
'floating_ip',
metavar='<floating-ip>',
help=_("Floating IP to disassociate (IP address or ID)"),
)
parser.add_argument(
'--port',
action='store_true',
default=False,
help=_("Disassociate any port associated with the floating IP"),
)
parser.add_argument(
'--qos-policy',
action='store_true',
default=False,
help=_("Remove the QoS policy attached to the floating IP"),
)
_tag.add_tag_option_to_parser_for_unset(parser, _('floating IP'))
return parser
def take_action(self, parsed_args):
client = self.app.client_manager.network
obj = client.find_ip(
parsed_args.floating_ip,
ignore_missing=False,
)
attrs = {}
if parsed_args.port:
attrs['port_id'] = None
if parsed_args.qos_policy:
attrs['qos_policy_id'] = None
attrs.update(
self._parse_extra_properties(parsed_args.extra_properties)
)
if attrs:
client.update_ip(obj, **attrs)
# tags is a subresource and it needs to be updated separately.
_tag.update_tags_for_unset(client, obj, parsed_args)
|