Files
python-neutronclient/neutronclient/osc/v2/sfc/sfc_port_pair.py
Akihiro Motoki 4914b4e3b5 Consume column utils from osc-lib
get_column_definitions() and get_columns() in neutronclient.osc.utils
have been migrated to osc-lib 1.8.0 (or later), so we no longer need
to maintain our own versions. This commit consumes osc-lib versions.

The workaround in firewallrule.py is no longer needed with
osc-lib 1.8.0 as the original bug has been fixed in osc-lib 1.8.0
(osc-lib commit 8cbdcde6076fa1df40e00d3e16bf140a59aa6273).

Change-Id: I4b9243b0fdb4ca744cc3f85371cb066a456f1d42
2018-01-29 11:07:22 +09:00

229 lines
8.3 KiB
Python
Executable File

# Copyright (c) 2017 Huawei Technologies India Pvt.Limited.
# All Rights Reserved.
#
# 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.
import logging
from osc_lib.cli import parseractions
from osc_lib.command import command
from osc_lib import exceptions
from osc_lib import utils
from osc_lib.utils import columns as column_util
from neutronclient._i18n import _
LOG = logging.getLogger(__name__)
resource = 'port_pair'
_attr_map = (
('id', 'ID', column_util.LIST_BOTH),
('name', 'Name', column_util.LIST_BOTH),
('ingress', 'Ingress Logical Port', column_util.LIST_BOTH),
('egress', 'Egress Logical Port', column_util.LIST_BOTH),
('service_function_parameters', 'Service Function Parameters',
column_util.LIST_LONG_ONLY),
('description', 'Description', column_util.LIST_LONG_ONLY),
('project_id', 'Project', column_util.LIST_LONG_ONLY),
)
class CreateSfcPortPair(command.ShowOne):
_description = _("Create a port pair")
def get_parser(self, prog_name):
parser = super(CreateSfcPortPair, self).get_parser(prog_name)
parser.add_argument(
'name',
metavar='<name>',
help=_('Name of the port pair'))
parser.add_argument(
'--description',
metavar='<description>',
help=_('Description for the port pair'))
parser.add_argument(
'--service-function-parameters',
metavar='correlation=<correlation-type>,weight=<weight>',
action=parseractions.MultiKeyValueAction,
optional_keys=['correlation', 'weight'],
help=_('Dictionary of service function parameters. '
'Currently, correlation=(None|mpls|nsh) and weight '
'are supported. Weight is an integer that influences '
'the selection of a port pair within a port pair group '
'for a flow. The higher the weight, the more flows will '
'hash to the port pair. The default weight is 1.'))
parser.add_argument(
'--ingress',
metavar='<ingress>',
required=True,
help=_('Ingress neutron port (name or ID)'))
parser.add_argument(
'--egress',
metavar='<egress>',
required=True,
help=_('Egress neutron port (name or ID)'))
return parser
def take_action(self, parsed_args):
client = self.app.client_manager.neutronclient
attrs = _get_common_attrs(self.app.client_manager, parsed_args)
body = {resource: attrs}
obj = client.create_sfc_port_pair(body)[resource]
columns, display_columns = column_util.get_columns(obj, _attr_map)
data = utils.get_dict_properties(obj, columns)
return display_columns, data
class DeleteSfcPortPair(command.Command):
_description = _("Delete a given port pair")
def get_parser(self, prog_name):
parser = super(DeleteSfcPortPair, self).get_parser(prog_name)
parser.add_argument(
'port_pair',
metavar="<port-pair>",
help=_("Port pair to delete (name or ID)")
)
return parser
def take_action(self, parsed_args):
# TODO(mohan): Add support for deleting multiple resources.
client = self.app.client_manager.neutronclient
port_pair_id = _get_id(client, parsed_args.port_pair, resource)
try:
client.delete_sfc_port_pair(port_pair_id)
except Exception as e:
msg = (_("Failed to delete port pair with name "
"or ID '%(port_pair)s': %(e)s")
% {'port_pair': parsed_args.port_pair, 'e': e})
raise exceptions.CommandError(msg)
class ListSfcPortPair(command.Lister):
_description = _("List port pairs")
def get_parser(self, prog_name):
parser = super(ListSfcPortPair, self).get_parser(prog_name)
parser.add_argument(
'--long',
action='store_true',
help=_("List additional fields in output")
)
return parser
def take_action(self, parsed_args):
client = self.app.client_manager.neutronclient
data = client.list_sfc_port_pairs()
headers, columns = column_util.get_column_definitions(
_attr_map, long_listing=parsed_args.long)
return (headers,
(utils.get_dict_properties(
s, columns,
) for s in data['port_pairs']))
class SetSfcPortPair(command.Command):
_description = _("Set port pair properties")
def get_parser(self, prog_name):
parser = super(SetSfcPortPair, self).get_parser(prog_name)
parser.add_argument(
'--name',
metavar='<name>',
help=_('Name of the port pair'))
parser.add_argument(
'--description',
metavar='<description>',
help=_('Description for the port pair'))
parser.add_argument(
'port_pair',
metavar='<port-pair>',
help=_("Port pair to modify (name or ID)")
)
return parser
def take_action(self, parsed_args):
client = self.app.client_manager.neutronclient
port_pair_id = _get_id(client, parsed_args.port_pair, resource)
attrs = _get_common_attrs(self.app.client_manager, parsed_args,
is_create=False)
body = {resource: attrs}
try:
client.update_sfc_port_pair(port_pair_id, body)
except Exception as e:
msg = (_("Failed to update port pair '%(port_pair)s': %(e)s")
% {'port_pair': parsed_args.port_pair, 'e': e})
raise exceptions.CommandError(msg)
class ShowSfcPortPair(command.ShowOne):
_description = _("Display port pair details")
def get_parser(self, prog_name):
parser = super(ShowSfcPortPair, self).get_parser(prog_name)
parser.add_argument(
'port_pair',
metavar='<port-pair>',
help=_("Port pair to display (name or ID)")
)
return parser
def take_action(self, parsed_args):
client = self.app.client_manager.neutronclient
port_pair_id = _get_id(client, parsed_args.port_pair, resource)
obj = client.show_sfc_port_pair(port_pair_id)[resource]
columns, display_columns = column_util.get_columns(obj, _attr_map)
data = utils.get_dict_properties(obj, columns)
return display_columns, data
def _get_common_attrs(client_manager, parsed_args, is_create=True):
attrs = {}
if parsed_args.name is not None:
attrs['name'] = parsed_args.name
if parsed_args.description is not None:
attrs['description'] = parsed_args.description
if is_create:
_get_attrs(client_manager, attrs, parsed_args)
return attrs
def _get_attrs(client_manager, attrs, parsed_args):
if parsed_args.ingress is not None:
attrs['ingress'] = _get_id(client_manager.neutronclient,
parsed_args.ingress, 'port')
if parsed_args.egress is not None:
attrs['egress'] = _get_id(client_manager.neutronclient,
parsed_args.egress, 'port')
if parsed_args.service_function_parameters is not None:
attrs['service_function_parameters'] = _get_service_function_params(
parsed_args.service_function_parameters)
def _get_service_function_params(sf_params):
attrs = {}
for sf_param in sf_params:
if 'correlation' in sf_param:
if sf_param['correlation'] == 'None':
attrs['correlation'] = None
else:
attrs['correlation'] = sf_param['correlation']
if 'weight' in sf_param:
attrs['weight'] = sf_param['weight']
return attrs
def _get_id(client, id_or_name, resource):
return client.find_resource(resource, id_or_name)['id']