python-neutronclient/neutronclient/osc/v2/fwaas/firewallgroup.py

380 lines
15 KiB
Python

# Copyright 2016-2017 FUJITSU 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.
#
from osc_lib.command import command
from osc_lib import exceptions
from osc_lib import utils
from oslo_log import log as logging
from neutronclient._i18n import _
from neutronclient.osc import utils as osc_utils
from neutronclient.osc.v2.fwaas import constants as const
from neutronclient.osc.v2 import utils as v2_utils
LOG = logging.getLogger(__name__)
_formatters = {
'admin_state_up': v2_utils.format_admin_state,
}
_attr_map = (
('id', 'ID', osc_utils.LIST_BOTH),
('name', 'Name', osc_utils.LIST_BOTH),
('ingress_firewall_policy_id', 'Ingress Policy ID', osc_utils.LIST_BOTH),
('egress_firewall_policy_id', 'Egress Policy ID', osc_utils.LIST_BOTH),
('description', 'Description', osc_utils.LIST_LONG_ONLY),
('status', 'Status', osc_utils.LIST_LONG_ONLY),
('ports', 'Ports', osc_utils.LIST_LONG_ONLY),
('admin_state_up', 'State', osc_utils.LIST_LONG_ONLY),
('public', 'Public', osc_utils.LIST_LONG_ONLY),
('tenant_id', 'Project', osc_utils.LIST_LONG_ONLY),
)
def _get_common_parser(parser):
parser.add_argument(
'--name',
help=_('Name for the firewall group'))
parser.add_argument(
'--description',
metavar='<description>',
help=_('Description of the firewall group'))
ingress_group = parser.add_mutually_exclusive_group()
ingress_group.add_argument(
'--ingress-firewall-policy',
metavar='<ingress-firewall-policy>',
dest='ingress_firewall_policy',
help=_('Ingress firewall policy (name or ID)'))
ingress_group.add_argument(
'--no-ingress-firewall-policy',
dest='no_ingress_firewall_policy',
action='store_true',
help=_('Detach ingress firewall policy from the firewall group'))
egress_group = parser.add_mutually_exclusive_group()
egress_group.add_argument(
'--egress-firewall-policy',
metavar='<egress-firewall-policy>',
dest='egress_firewall_policy',
help=_('Egress firewall policy (name or ID)'))
egress_group.add_argument(
'--no-egress-firewall-policy',
dest='no_egress_firewall_policy',
action='store_true',
help=_('Detach egress firewall policy from the firewall group'))
public_group = parser.add_mutually_exclusive_group()
public_group.add_argument(
'--public',
action='store_true',
help=_('Make the firewall group public, which allows it to be '
'used in all projects (as opposed to the default, '
'which is to restrict its use to the current project)'))
public_group.add_argument(
'--private',
action='store_true',
help=_('Restrict use of the firewall group to the '
'current project'))
admin_group = parser.add_mutually_exclusive_group()
admin_group.add_argument(
'--enable',
action='store_true',
help=_('Enable firewall group'))
admin_group.add_argument(
'--disable',
action='store_true',
help=_('Disable firewall group'))
return parser
def _get_common_attrs(client_manager, parsed_args, is_create=True):
attrs = {}
client = client_manager.neutronclient
if is_create:
if 'project' in parsed_args and parsed_args.project is not None:
attrs['tenant_id'] = osc_utils.find_project(
client_manager.identity,
parsed_args.project,
parsed_args.project_domain,
).id
if (parsed_args.ingress_firewall_policy and
parsed_args.no_ingress_firewall_policy):
attrs['ingress_firewall_policy_id'] = client.find_resource(
const.FWP, parsed_args.ingress_firewall_policy,
cmd_resource=const.CMD_FWP)['id']
elif parsed_args.ingress_firewall_policy:
attrs['ingress_firewall_policy_id'] = client.find_resource(
const.FWP, parsed_args.ingress_firewall_policy,
cmd_resource=const.CMD_FWP)['id']
elif parsed_args.no_ingress_firewall_policy:
attrs['ingress_firewall_policy_id'] = None
if (parsed_args.egress_firewall_policy and
parsed_args.no_egress_firewall_policy):
attrs['egress_firewall_policy_id'] = client.find_resource(
const.FWP, parsed_args.egress_firewall_policy,
cmd_resource=const.CMD_FWP)['id']
elif parsed_args.egress_firewall_policy:
attrs['egress_firewall_policy_id'] = client.find_resource(
const.FWP, parsed_args.egress_firewall_policy,
cmd_resource=const.CMD_FWP)['id']
elif parsed_args.no_egress_firewall_policy:
attrs['egress_firewall_policy_id'] = None
if parsed_args.public:
attrs['public'] = True
if parsed_args.private:
attrs['public'] = False
if parsed_args.enable:
attrs['admin_state_up'] = True
if parsed_args.disable:
attrs['admin_state_up'] = False
if parsed_args.name:
attrs['name'] = str(parsed_args.name)
if parsed_args.description:
attrs['description'] = str(parsed_args.description)
if parsed_args.port and parsed_args.no_port:
attrs['ports'] = sorted([client.find_resource(
'port', p)['id'] for p in set(parsed_args.port)])
elif parsed_args.port:
ports = []
for p in set(parsed_args.port):
ports.append(client.find_resource('port', p)['id'])
if not is_create:
ports += client.find_resource(
const.FWG, parsed_args.firewall_group,
cmd_resource=const.CMD_FWG)['ports']
attrs['ports'] = sorted(set(ports))
elif parsed_args.no_port:
attrs['ports'] = []
return attrs
class CreateFirewallGroup(command.ShowOne):
_description = _("Create a new firewall group")
def get_parser(self, prog_name):
parser = super(CreateFirewallGroup, self).get_parser(prog_name)
_get_common_parser(parser)
osc_utils.add_project_owner_option_to_parser(parser)
port_group = parser.add_mutually_exclusive_group()
port_group.add_argument(
'--port',
metavar='<port>',
action='append',
help=_('Port(s) (name or ID) to apply firewall group. This '
'option can be repeated'))
port_group.add_argument(
'--no-port',
dest='no_port',
action='store_true',
help=_('Detach all port from the firewall group'))
return parser
def take_action(self, parsed_args):
client = self.app.client_manager.neutronclient
attrs = _get_common_attrs(self.app.client_manager, parsed_args)
obj = client.create_fwaas_firewall_group(
{const.FWG: attrs})[const.FWG]
columns, display_columns = osc_utils.get_columns(obj, _attr_map)
data = utils.get_dict_properties(obj, columns, formatters=_formatters)
return (display_columns, data)
class DeleteFirewallGroup(command.Command):
_description = _("Delete firewall group(s)")
def get_parser(self, prog_name):
parser = super(DeleteFirewallGroup, self).get_parser(prog_name)
parser.add_argument(
const.FWG,
metavar='<firewall-group>',
nargs='+',
help=_('Firewall group(s) to delete (name or ID)'))
return parser
def take_action(self, parsed_args):
client = self.app.client_manager.neutronclient
result = 0
for fwg in parsed_args.firewall_group:
try:
fwg_id = client.find_resource(
const.FWG, fwg, cmd_resource=const.CMD_FWG)['id']
client.delete_fwaas_firewall_group(fwg_id)
except Exception as e:
result += 1
LOG.error(_("Failed to delete firewall group with "
"name or ID '%(firewall_group)s': %(e)s"),
{const.FWG: fwg, 'e': e})
if result > 0:
total = len(parsed_args.firewall_group)
msg = (_("%(result)s of %(total)s firewall group(s) "
"failed to delete.") % {'result': result, 'total': total})
raise exceptions.CommandError(msg)
class ListFirewallGroup(command.Lister):
_description = _("List firewall groups")
def get_parser(self, prog_name):
parser = super(ListFirewallGroup, 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
obj = client.list_fwaas_firewall_groups()[const.FWGS]
headers, columns = osc_utils.get_column_definitions(
_attr_map, long_listing=parsed_args.long)
return (headers, (utils.get_dict_properties(
s, columns, formatters=_formatters) for s in obj))
class SetFirewallGroup(command.Command):
_description = _("Set firewall group properties")
def get_parser(self, prog_name):
parser = super(SetFirewallGroup, self).get_parser(prog_name)
_get_common_parser(parser)
parser.add_argument(
const.FWG,
metavar='<firewall-group>',
help=_('Firewall group to update (name or ID)'))
parser.add_argument(
'--port',
metavar='<port>',
action='append',
help=_('Port(s) (name or ID) to apply firewall group. This '
'option can be repeated'))
parser.add_argument(
'--no-port',
dest='no_port',
action='store_true',
help=_('Detach all port from the firewall group'))
return parser
def take_action(self, parsed_args):
client = self.app.client_manager.neutronclient
fwg_id = client.find_resource(const.FWG, parsed_args.firewall_group,
cmd_resource=const.CMD_FWG)['id']
attrs = _get_common_attrs(self.app.client_manager, parsed_args,
is_create=False)
try:
client.update_fwaas_firewall_group(fwg_id, {const.FWG: attrs})
except Exception as e:
msg = (_("Failed to set firewall group '%(group)s': %(e)s")
% {'group': parsed_args.firewall_group, 'e': e})
raise exceptions.CommandError(msg)
class ShowFirewallGroup(command.ShowOne):
_description = _("Display firewall group details")
def get_parser(self, prog_name):
parser = super(ShowFirewallGroup, self).get_parser(prog_name)
parser.add_argument(
const.FWG,
metavar='<firewall-group>',
help=_('Firewall group to show (name or ID)'))
return parser
def take_action(self, parsed_args):
client = self.app.client_manager.neutronclient
fwg_id = client.find_resource(const.FWG, parsed_args.firewall_group,
cmd_resource=const.CMD_FWG)['id']
obj = client.show_fwaas_firewall_group(fwg_id)[const.FWG]
columns, display_columns = osc_utils.get_columns(obj, _attr_map)
data = utils.get_dict_properties(obj, columns, formatters=_formatters)
return (display_columns, data)
class UnsetFirewallGroup(command.Command):
_description = _("Unset firewall group properties")
def get_parser(self, prog_name):
parser = super(UnsetFirewallGroup, self).get_parser(prog_name)
parser.add_argument(
const.FWG,
metavar='<firewall-group>',
help=_('Firewall group to unset (name or ID)'))
port_group = parser.add_mutually_exclusive_group()
port_group.add_argument(
'--port',
metavar='<port>',
action='append',
help=_('Port(s) (name or ID) to apply firewall group. This '
'option can be repeated'))
port_group.add_argument(
'--all-port',
action='store_true',
help=_('Remove all ports for this firewall group'))
parser.add_argument(
'--ingress-firewall-policy',
action='store_true',
help=_('Ingress firewall policy (name or ID) to delete'))
parser.add_argument(
'--egress-firewall-policy',
action='store_true',
dest='egress_firewall_policy',
help=_('Egress firewall policy (name or ID) to delete'))
parser.add_argument(
'--public',
action='store_true',
help=_('Restrict use of the firewall group to the '
'current project'))
parser.add_argument(
'--enable',
action='store_true',
help=_('Disable firewall group'))
return parser
def _get_attrs(self, client_manager, parsed_args):
attrs = {}
client = client_manager.neutronclient
if parsed_args.ingress_firewall_policy:
attrs['ingress_firewall_policy_id'] = None
if parsed_args.egress_firewall_policy:
attrs['egress_firewall_policy_id'] = None
if parsed_args.public:
attrs['public'] = False
if parsed_args.enable:
attrs['admin_state_up'] = False
if parsed_args.port:
old = client.find_resource(
const.FWG, parsed_args.firewall_group,
cmd_resource=const.CMD_FWG)['ports']
new = [client.find_resource(
'port', r)['id'] for r in parsed_args.port]
attrs['ports'] = sorted(list(set(old) - set(new)))
if parsed_args.all_port:
attrs['ports'] = []
return attrs
def take_action(self, parsed_args):
client = self.app.client_manager.neutronclient
fwg_id = client.find_resource(const.FWG, parsed_args.firewall_group,
cmd_resource=const.CMD_FWG)['id']
attrs = self._get_attrs(self.app.client_manager, parsed_args)
try:
client.update_fwaas_firewall_group(fwg_id, {const.FWG: attrs})
except Exception as e:
msg = (_("Failed to unset firewall group '%(group)s': %(e)s")
% {'group': parsed_args.firewall_group, 'e': e})
raise exceptions.CommandError(msg)