python-openstackclient 8.2.0__py3-none-any.whl → 8.3.0__py3-none-any.whl

openstackclient/network/v2/subnet.py

@@ -20,11 +20,11 @@ import typing as ty
 from cliff import columns as cliff_columns
 from osc_lib.cli import format_columns
 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 tags as _tag
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 from openstackclient.network import common
@@ -44,7 +44,7 @@ def _update_arguments(obj_list, parsed_args_list, option):
             raise exceptions.CommandError(msg)
 
 
-class AllocationPoolsColumn(cliff_columns.FormattableColumn):
+class AllocationPoolsColumn(cliff_columns.FormattableColumn[ty.Any]):
     def human_readable(self):
         pool_formatted = [
             '{}-{}'.format(pool.get('start', ''), pool.get('end', ''))
@@ -53,7 +53,7 @@ class AllocationPoolsColumn(cliff_columns.FormattableColumn):
         return ','.join(pool_formatted)
 
 
-class HostRoutesColumn(cliff_columns.FormattableColumn):
+class HostRoutesColumn(cliff_columns.FormattableColumn[ty.Any]):
     def human_readable(self):
         # Map the host route keys to match --host-route option.
         return utils.format_list_of_dicts(
@@ -61,7 +61,7 @@ class HostRoutesColumn(cliff_columns.FormattableColumn):
         )
 
 
-class UnsortedListColumn(cliff_columns.FormattableColumn):
+class UnsortedListColumn(cliff_columns.FormattableColumn[list[ty.Any]]):
     # format_columns.ListColumn sorts the output, but for things like
     # DNS server addresses the order matters
     def human_readable(self):
@@ -493,7 +493,7 @@ class ListSubnet(command.Lister):
             metavar='<ip-version>',
             dest='ip_version',
             help=_(
-                "List only subnets of given IP version in output. "
+                "List only subnets with the specified IP version. "
                 "Allowed values for IP version are 4 and 6."
             ),
         )
@@ -501,12 +501,12 @@ class ListSubnet(command.Lister):
         dhcp_enable_group.add_argument(
             '--dhcp',
             action='store_true',
-            help=_("List subnets which have DHCP enabled"),
+            help=_("List only subnets which have DHCP enabled"),
         )
         dhcp_enable_group.add_argument(
             '--no-dhcp',
             action='store_true',
-            help=_("List subnets which have DHCP disabled"),
+            help=_("List only subnets which have DHCP disabled"),
         )
         parser.add_argument(
             '--service-type',
@@ -514,7 +514,7 @@ class ListSubnet(command.Lister):
             action='append',
             dest='service_types',
             help=_(
-                "List only subnets of a given service type in output, "
+                "List only subnets with the specified service type, "
                 "for example, network:floatingip_agent_gateway. "
                 "Must be a valid device owner value for a network port "
                 "(repeat option to list multiple service types)."
@@ -524,8 +524,7 @@ class ListSubnet(command.Lister):
             '--project',
             metavar='<project>',
             help=_(
-                "List only subnets which belong to a given project "
-                "in output (name or ID)"
+                "List only subnets with the specified project (name or ID)"
             ),
         )
         identity_common.add_project_domain_option_to_parser(parser)
@@ -533,26 +532,26 @@ class ListSubnet(command.Lister):
             '--network',
             metavar='<network>',
             help=_(
-                "List only subnets which belong to a given network "
-                "in output (name or ID)"
+                "List only subnets which belong to the specified network "
+                "(name or ID)"
             ),
         )
         parser.add_argument(
             '--gateway',
             metavar='<gateway>',
-            help=_("List only subnets of given gateway IP in output"),
+            help=_("List only subnets with the specified gateway IP"),
         )
         parser.add_argument(
             '--name',
             metavar='<name>',
-            help=_("List only subnets of given name in output"),
+            help=_("List only subnets with the specified name"),
         )
         parser.add_argument(
             '--subnet-range',
             metavar='<subnet-range>',
             help=_(
-                "List only subnets of given subnet range "
-                "(in CIDR notation) in output. "
+                "List only subnets with the specified subnet range "
+                "(in CIDR notation). "
                 "For example, --subnet-range 10.10.0.0/16"
             ),
         )
@@ -560,8 +559,8 @@ class ListSubnet(command.Lister):
             '--subnet-pool',
             metavar='<subnet-pool>',
             help=_(
-                "List only subnets which belong to a given subnet pool "
-                "in output (name or ID)"
+                "List only subnets which belong to the specified subnet pool "
+                "(name or ID)"
             ),
         )
         _tag.add_tag_filtering_option_to_parser(parser, _('subnets'))

openstackclient/network/v2/subnet_pool.py

@@ -17,11 +17,11 @@ import logging
 
 from osc_lib.cli import format_columns
 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 tags as _tag
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 from openstackclient.network import common
@@ -278,26 +278,27 @@ class ListSubnetPool(command.Lister):
         shared_group.add_argument(
             '--share',
             action='store_true',
-            help=_("List subnet pools shared between projects"),
+            help=_("List only subnet pools shared between projects"),
         )
         shared_group.add_argument(
             '--no-share',
             action='store_true',
-            help=_("List subnet pools not shared between projects"),
+            help=_("List only subnet pools not shared between projects"),
         )
         default_group = parser.add_mutually_exclusive_group()
         default_group.add_argument(
             '--default',
             action='store_true',
             help=_(
-                "List subnet pools used as the default external subnet pool"
+                "List only subnet pools used as the default external "
+                "subnet pool"
             ),
         )
         default_group.add_argument(
             '--no-default',
             action='store_true',
             help=_(
-                "List subnet pools not used as the default external "
+                "List only subnet pools not used as the default external "
                 "subnet pool"
             ),
         )
@@ -305,21 +306,22 @@ class ListSubnetPool(command.Lister):
             '--project',
             metavar='<project>',
             help=_(
-                "List subnet pools according to their project (name or ID)"
+                "List only subnet pools with the specified project "
+                "(name or ID)"
             ),
         )
         identity_common.add_project_domain_option_to_parser(parser)
         parser.add_argument(
             '--name',
             metavar='<name>',
-            help=_("List only subnet pools of given name in output"),
+            help=_("List only subnet pools with the specified name"),
         )
         parser.add_argument(
             '--address-scope',
             metavar='<address-scope>',
             help=_(
-                "List only subnet pools of given address scope "
-                "in output (name or ID)"
+                "List only subnet pools with the specified address scope "
+                "(name or ID)"
             ),
         )
         _tag.add_tag_filtering_option_to_parser(parser, _('subnet pools'))

openstackclient/network/v2/taas/tap_flow.py

@@ -0,0 +1,245 @@
+# All Rights Reserved 2020
+#
+#    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 format_columns
+from osc_lib.cli import identity as identity_utils
+from osc_lib import exceptions
+from osc_lib import utils as osc_utils
+from osc_lib.utils import columns as column_util
+
+from openstackclient import command
+from openstackclient.i18n import _
+from openstackclient.identity import common
+from openstackclient.network.v2.taas import tap_service
+
+LOG = logging.getLogger(__name__)
+
+TAP_FLOW = 'tap_flow'
+TAP_FLOWS = f'{TAP_FLOW}s'
+
+_attr_map = [
+    ('id', 'ID', column_util.LIST_BOTH),
+    ('tenant_id', 'Tenant', column_util.LIST_LONG_ONLY),
+    ('name', 'Name', column_util.LIST_BOTH),
+    ('status', 'Status', column_util.LIST_BOTH),
+    ('source_port', 'source_port', column_util.LIST_BOTH),
+    ('tap_service_id', 'tap_service_id', column_util.LIST_BOTH),
+    ('direction', 'Direction', column_util.LIST_BOTH),
+]
+
+_formatters = {
+    'vlan_filter': format_columns.ListColumn,
+}
+
+
+def _add_updatable_args(parser):
+    parser.add_argument('--name', help=_('Name of the tap flow.'))
+    parser.add_argument(
+        '--description', help=_('Description of the tap flow.')
+    )
+
+
+class CreateTapFlow(command.ShowOne):
+    _description = _("Create a new tap flow.")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        identity_utils.add_project_owner_option_to_parser(parser)
+        _add_updatable_args(parser)
+        parser.add_argument(
+            '--port',
+            required=True,
+            metavar="SOURCE_PORT",
+            help=_('Source port (name or ID) to monitor.'),
+        )
+        parser.add_argument(
+            '--tap-service',
+            required=True,
+            metavar="TAP_SERVICE",
+            help=_(
+                'Tap service (name or ID) to associate with this tap flow.'
+            ),
+        )
+        parser.add_argument(
+            '--direction',
+            required=True,
+            metavar="DIRECTION",
+            choices=['IN', 'OUT', 'BOTH'],
+            type=lambda s: s.upper(),
+            help=_(
+                'Direction of the Tap flow. Valid options are: '
+                'IN, OUT and BOTH'
+            ),
+        )
+        parser.add_argument(
+            '--vlan-filter',
+            required=False,
+            metavar="VLAN_FILTER",
+            help=_('VLAN IDs to mirror in the form of range string.'),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        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 parsed_args.port is not None:
+            source_port = client.find_port(
+                parsed_args.port, ignore_missing=False
+            ).id
+            attrs['source_port'] = source_port
+        if parsed_args.tap_service is not None:
+            tap_service_id = client.find_tap_service(
+                parsed_args.tap_service, ignore_missing=False
+            ).id
+            attrs['tap_service_id'] = tap_service_id
+        if parsed_args.direction is not None:
+            attrs['direction'] = parsed_args.direction
+        if parsed_args.vlan_filter is not None:
+            attrs['vlan_filter'] = parsed_args.vlan_filter
+        if 'project' in parsed_args and parsed_args.project is not None:
+            attrs['project_id'] = common.find_project(
+                self.app.client_manager.identity,
+                parsed_args.project,
+                parsed_args.project_domain,
+            ).id
+        obj = client.create_tap_flow(**attrs)
+        display_columns, columns = tap_service._get_columns(obj)
+        data = osc_utils.get_dict_properties(obj, columns)
+        return display_columns, data
+
+
+class ListTapFlow(command.Lister):
+    _description = _("List tap flows.")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        identity_utils.add_project_owner_option_to_parser(parser)
+
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        params = {}
+        if parsed_args.project is not None:
+            params['project_id'] = common.find_project(
+                self.app.client_manager.identity,
+                parsed_args.project,
+                parsed_args.project_domain,
+            ).id
+        objs = client.tap_flows(retrieve_all=True, params=params)
+        headers, columns = column_util.get_column_definitions(
+            _attr_map, long_listing=True
+        )
+        return (
+            headers,
+            (
+                osc_utils.get_dict_properties(
+                    s, columns, formatters=_formatters
+                )
+                for s in objs
+            ),
+        )
+
+
+class ShowTapFlow(command.ShowOne):
+    _description = _("Show tap flow details.")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            TAP_FLOW,
+            metavar=f"<{TAP_FLOW}>",
+            help=_("Tap flow to display (name or ID)."),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        id = client.find_tap_flow(
+            parsed_args.tap_flow, ignore_missing=False
+        ).id
+        obj = client.get_tap_flow(id)
+        display_columns, columns = tap_service._get_columns(obj)
+        data = osc_utils.get_dict_properties(obj, columns)
+        return display_columns, data
+
+
+class DeleteTapFlow(command.Command):
+    _description = _("Delete a tap flow.")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            TAP_FLOW,
+            metavar=f"<{TAP_FLOW}>",
+            nargs="+",
+            help=_("Tap flow to delete (name or ID)."),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        fails = 0
+        for id_or_name in parsed_args.tap_flow:
+            try:
+                id = client.find_tap_flow(id_or_name, ignore_missing=False).id
+                client.delete_tap_flow(id)
+            except Exception as e:
+                fails += 1
+                LOG.error(
+                    "Failed to delete tap flow with name or ID "
+                    "'%(id_or_name)s': %(e)s",
+                    {'id_or_name': id_or_name, 'e': e},
+                )
+        if fails > 0:
+            msg = _("Failed to delete %(fails)s of %(total)s tap flow.") % {
+                'fails': fails,
+                'total': len(parsed_args.tap_flow),
+            }
+            raise exceptions.CommandError(msg)
+
+
+class UpdateTapFlow(command.ShowOne):
+    _description = _("Update a tap flow.")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            TAP_FLOW,
+            metavar=f"<{TAP_FLOW}>",
+            help=_("Tap flow to modify (name or ID)."),
+        )
+        _add_updatable_args(parser)
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        original_t_f = client.find_tap_flow(
+            parsed_args.tap_flow, ignore_missing=False
+        ).id
+        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
+        obj = client.update_tap_flow(original_t_f, **attrs)
+        columns, display_columns = column_util.get_columns(obj, _attr_map)
+        data = osc_utils.get_dict_properties(obj, columns)
+        return display_columns, data

openstackclient/network/v2/taas/tap_mirror.py

@@ -0,0 +1,237 @@
+#    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 identity as identity_utils
+from osc_lib import exceptions
+from osc_lib import utils as osc_utils
+from osc_lib.utils import columns as column_util
+
+from openstackclient import command
+from openstackclient.i18n import _
+from openstackclient.identity import common
+from openstackclient.network.v2 import port as osc_port
+from openstackclient.network.v2.taas import tap_service
+
+LOG = logging.getLogger(__name__)
+
+TAP_MIRROR = 'tap_mirror'
+TAP_MIRRORS = f'{TAP_MIRROR}s'
+
+_attr_map = [
+    ('id', 'ID', column_util.LIST_BOTH),
+    ('tenant_id', 'Tenant', column_util.LIST_LONG_ONLY),
+    ('name', 'Name', column_util.LIST_BOTH),
+    ('port_id', 'Port', column_util.LIST_BOTH),
+    ('directions', 'Directions', column_util.LIST_LONG_ONLY),
+    ('remote_ip', 'Remote IP', column_util.LIST_BOTH),
+    ('mirror_type', 'Mirror Type', column_util.LIST_LONG_ONLY),
+]
+
+
+def _get_columns(item):
+    column_map: dict[str, str] = {}
+    hidden_columns = ['location', 'tenant_id']
+    return osc_utils.get_osc_show_columns_for_sdk_resource(
+        item, column_map, hidden_columns
+    )
+
+
+class CreateTapMirror(command.ShowOne):
+    _description = _("Create a new tap mirror.")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        identity_utils.add_project_owner_option_to_parser(parser)
+        tap_service._add_updatable_args(parser)
+        parser.add_argument(
+            '--port',
+            dest='port_id',
+            required=True,
+            metavar="PORT",
+            help=_('Port (name or ID) to which the Tap Mirror is connected.'),
+        )
+        parser.add_argument(
+            '--directions',
+            dest='directions',
+            action=osc_port.JSONKeyValueAction,
+            required=True,
+            help=_(
+                'Dictionary of direction and tunnel_id. Valid directions are: '
+                'IN and OUT.'
+            ),
+        )
+        parser.add_argument(
+            '--remote-ip',
+            dest='remote_ip',
+            required=True,
+            help=_(
+                'Remote IP address for the tap mirror (remote end of the '
+                'GRE or ERSPAN v1 tunnel).'
+            ),
+        )
+        parser.add_argument(
+            '--mirror-type',
+            dest='mirror_type',
+            required=True,
+            help=_('Mirror type. Valid values are: gre and erspanv1.'),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        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 parsed_args.port_id is not None:
+            port_id = client.find_port(
+                parsed_args.port_id, ignore_missing=False
+            ).id
+            attrs['port_id'] = port_id
+        if parsed_args.directions is not None:
+            attrs['directions'] = parsed_args.directions
+        if parsed_args.remote_ip is not None:
+            attrs['remote_ip'] = parsed_args.remote_ip
+        if parsed_args.mirror_type is not None:
+            attrs['mirror_type'] = parsed_args.mirror_type
+        if 'project' in parsed_args and parsed_args.project is not None:
+            attrs['project_id'] = common.find_project(
+                self.app.client_manager.identity,
+                parsed_args.project,
+                parsed_args.project_domain,
+            ).id
+        obj = client.create_tap_mirror(**attrs)
+        display_columns, columns = tap_service._get_columns(obj)
+        data = osc_utils.get_dict_properties(obj, columns)
+        return display_columns, data
+
+
+class ListTapMirror(command.Lister):
+    _description = _("List tap mirrors.")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        identity_utils.add_project_owner_option_to_parser(parser)
+
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        params = {}
+        if parsed_args.project is not None:
+            params['project_id'] = common.find_project(
+                self.app.client_manager.identity,
+                parsed_args.project,
+                parsed_args.project_domain,
+            ).id
+        objs = client.tap_mirrors(retrieve_all=True, params=params)
+        headers, columns = column_util.get_column_definitions(
+            _attr_map, long_listing=True
+        )
+        return (
+            headers,
+            (osc_utils.get_dict_properties(s, columns) for s in objs),
+        )
+
+
+class ShowTapMirror(command.ShowOne):
+    _description = _("Show tap mirror details.")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            TAP_MIRROR,
+            metavar=f"<{TAP_MIRROR}>",
+            help=_("Tap mirror to display (name or ID)."),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        id = client.find_tap_mirror(
+            parsed_args.tap_mirror, ignore_missing=False
+        ).id
+        obj = client.get_tap_mirror(id)
+        display_columns, columns = tap_service._get_columns(obj)
+        data = osc_utils.get_dict_properties(obj, columns)
+        return display_columns, data
+
+
+class DeleteTapMirror(command.Command):
+    _description = _("Delete a tap mirror.")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            TAP_MIRROR,
+            metavar=f"<{TAP_MIRROR}>",
+            nargs="+",
+            help=_("Tap mirror to delete (name or ID)."),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        fails = 0
+        for id_or_name in parsed_args.tap_mirror:
+            try:
+                id = client.find_tap_mirror(
+                    id_or_name, ignore_missing=False
+                ).id
+
+                client.delete_tap_mirror(id)
+                LOG.warning("Tap Mirror %(id)s deleted", {'id': id})
+            except Exception as e:
+                fails += 1
+                LOG.error(
+                    "Failed to delete Tap Mirror with name or ID "
+                    "'%(id_or_name)s': %(e)s",
+                    {'id_or_name': id_or_name, 'e': e},
+                )
+        if fails > 0:
+            msg = _("Failed to delete %(fails)s of %(total)s Tap Mirror.") % {
+                'fails': fails,
+                'total': len(parsed_args.tap_mirror),
+            }
+            raise exceptions.CommandError(msg)
+
+
+class UpdateTapMirror(command.ShowOne):
+    _description = _("Update a tap mirror.")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            TAP_MIRROR,
+            metavar=f"<{TAP_MIRROR}>",
+            help=_("Tap mirror to modify (name or ID)."),
+        )
+        tap_service._add_updatable_args(parser)
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        original_t_s = client.find_tap_mirror(
+            parsed_args.tap_mirror, ignore_missing=False
+        ).id
+        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
+        obj = client.update_tap_mirror(original_t_s, **attrs)
+        display_columns, columns = tap_service._get_columns(obj)
+        data = osc_utils.get_dict_properties(obj, columns)
+        return display_columns, data