python-openstackclient 6.6.0__py3-none-any.whl → 7.0.0__py3-none-any.whl

openstackclient/network/v2/router.py

@@ -13,6 +13,8 @@
 
 """Router action implementations"""
 
+import argparse
+import collections
 import copy
 import json
 import logging
@@ -85,8 +87,120 @@ def _get_columns(item):
     )
 
 
+def is_multiple_gateways_supported(n_client):
+    return n_client.find_extension("external-gateway-multihoming") is not None
+
+
+def _passed_multiple_gateways(extension_supported, external_gateways):
+    passed_multiple_gws = len(external_gateways) > 1
+    if passed_multiple_gws and not extension_supported:
+        msg = _(
+            'Supplying --external-gateway option multiple times is not '
+            'supported due to the lack of external-gateway-multihoming '
+            'extension at the Neutron side.'
+        )
+        raise exceptions.CommandError(msg)
+    return passed_multiple_gws
+
+
+def _get_external_gateway_attrs(client_manager, parsed_args):
+    attrs = {}
+
+    if parsed_args.external_gateways:
+        external_gateways: collections.defaultdict[str, list[dict]] = (
+            collections.defaultdict(list)
+        )
+        n_client = client_manager.network
+        first_network_id = None
+
+        for gw_net_name_or_id in parsed_args.external_gateways:
+            gateway_info = {}
+            gw_net = n_client.find_network(
+                gw_net_name_or_id, ignore_missing=False
+            )
+            if first_network_id is None:
+                first_network_id = gw_net.id
+            gateway_info['network_id'] = gw_net.id
+            if 'disable_snat' in parsed_args and parsed_args.disable_snat:
+                gateway_info['enable_snat'] = False
+            if 'enable_snat' in parsed_args and parsed_args.enable_snat:
+                gateway_info['enable_snat'] = True
+
+            # This option was added before multiple gateways were supported, so
+            # it does not have a per-gateway port granularity so just pass it
+            # along in gw info in case it is specified.
+            if 'qos_policy' in parsed_args and parsed_args.qos_policy:
+                qos_id = n_client.find_qos_policy(
+                    parsed_args.qos_policy, ignore_missing=False
+                ).id
+                gateway_info['qos_policy_id'] = qos_id
+            if 'no_qos_policy' in parsed_args and parsed_args.no_qos_policy:
+                gateway_info['qos_policy_id'] = None
+
+            external_gateways[gw_net.id].append(gateway_info)
+
+        multiple_gws_supported = is_multiple_gateways_supported(n_client)
+        # Parse the external fixed IP specs and match them to specific gateway
+        # ports if needed.
+        if parsed_args.fixed_ips:
+            for ip_spec in parsed_args.fixed_ips:
+                # If there is only one gateway, this value will represent the
+                # network ID for it, otherwise it will be overridden.
+                ip_net_id = first_network_id
+
+                if ip_spec.get('subnet', False):
+                    subnet_name_id = ip_spec.pop('subnet')
+                    if subnet_name_id:
+                        subnet = n_client.find_subnet(
+                            subnet_name_id, ignore_missing=False
+                        )
+                        ip_spec['subnet_id'] = subnet.id
+                        ip_net_id = subnet.network_id
+                if ip_spec.get('ip-address', False):
+                    ip_spec['ip_address'] = ip_spec.pop('ip-address')
+                # Finally, add an ip_spec to the specific gateway identified
+                # by a network from the spec.
+                if (
+                    'subnet_id' in ip_spec
+                    and ip_net_id not in external_gateways
+                ):
+                    msg = _(
+                        'Subnet %s does not belong to any of the networks '
+                        'provided for --external-gateway.'
+                    ) % (ip_spec['subnet_id'])
+                    raise exceptions.CommandError(msg)
+                for gw_info in external_gateways[ip_net_id]:
+                    if 'external_fixed_ips' not in gw_info:
+                        gw_info['external_fixed_ips'] = [ip_spec]
+                        break
+                else:
+                    # The end user has requested more fixed IPs than there are
+                    # gateways, add multiple fixed IPs to single gateway to
+                    # retain current behavior.
+                    for gw_info in external_gateways[ip_net_id]:
+                        gw_info['external_fixed_ips'].append(ip_spec)
+                        break
+
+        # Use the newer API whenever it is supported regardless of whether one
+        # or multiple gateways are passed as arguments.
+        if multiple_gws_supported:
+            gateway_list = []
+            # Now merge the per-network-id lists of external gateway info
+            # dicts into one list.
+            for gw_info_list in external_gateways.values():
+                gateway_list.extend(gw_info_list)
+            attrs['external_gateways'] = gateway_list
+        else:
+            attrs['external_gateway_info'] = external_gateways[
+                first_network_id
+            ][0]
+    return attrs
+
+
 def _get_attrs(client_manager, parsed_args):
     attrs = {}
+    n_client = client_manager.network
+
     if parsed_args.name is not None:
         attrs['name'] = parsed_args.name
     if parsed_args.enable:
@@ -113,44 +227,85 @@ def _get_attrs(client_manager, parsed_args):
             parsed_args.project_domain,
         ).id
         attrs['project_id'] = project_id
-    if parsed_args.external_gateway:
-        gateway_info = {}
-        n_client = client_manager.network
-        network = n_client.find_network(
-            parsed_args.external_gateway, ignore_missing=False
-        )
-        gateway_info['network_id'] = network.id
-        if parsed_args.disable_snat:
-            gateway_info['enable_snat'] = False
-        if parsed_args.enable_snat:
-            gateway_info['enable_snat'] = True
-        if parsed_args.fixed_ip:
-            ips = []
-            for ip_spec in parsed_args.fixed_ip:
-                if ip_spec.get('subnet', False):
-                    subnet_name_id = ip_spec.pop('subnet')
-                    if subnet_name_id:
-                        subnet = n_client.find_subnet(
-                            subnet_name_id, ignore_missing=False
-                        )
-                        ip_spec['subnet_id'] = subnet.id
-                if ip_spec.get('ip-address', False):
-                    ip_spec['ip_address'] = ip_spec.pop('ip-address')
-                ips.append(ip_spec)
-            gateway_info['external_fixed_ips'] = ips
-        attrs['external_gateway_info'] = gateway_info
+
+    attrs.update(_get_external_gateway_attrs(client_manager, parsed_args))
+
     # "router set" command doesn't support setting flavor_id.
     if 'flavor_id' in parsed_args and parsed_args.flavor_id is not None:
-        attrs['flavor_id'] = parsed_args.flavor_id
+        flavor = n_client.find_flavor(parsed_args.flavor_id)
+        attrs['flavor_id'] = flavor.id
+
+    for attr in ('enable_default_route_bfd', 'enable_default_route_ecmp'):
+        value = getattr(parsed_args, attr, None)
+        if value is not None:
+            attrs[attr] = value
 
     return attrs
 
 
+def _parser_add_bfd_ecmp_arguments(parser):
+    """Helper to add BFD and ECMP args for CreateRouter and SetRouter."""
+    parser.add_argument(
+        '--enable-default-route-bfd',
+        dest='enable_default_route_bfd',
+        default=None,
+        action='store_true',
+        help=_(
+            "Enable BFD sessions for default routes inferred from "
+            "the external gateway port subnets for this router."
+        ),
+    )
+    parser.add_argument(
+        '--disable-default-route-bfd',
+        dest='enable_default_route_bfd',
+        default=None,
+        action='store_false',
+        help=_(
+            "Disable BFD sessions for default routes inferred from "
+            "the external gateway port subnets for this router."
+        ),
+    )
+    parser.add_argument(
+        '--enable-default-route-ecmp',
+        dest='enable_default_route_ecmp',
+        default=None,
+        action='store_true',
+        help=_(
+            "Add ECMP default routes if multiple are available via "
+            "different gateway ports."
+        ),
+    )
+    parser.add_argument(
+        '--disable-default-route-ecmp',
+        dest='enable_default_route_ecmp',
+        default=None,
+        action='store_false',
+        help=_("Add default route only for first gateway port."),
+    )
+
+
+def _command_check_bfd_ecmp_supported(attrs, client):
+    """Helper to check for server side support when bfd/ecmp attrs provided.
+
+    :raises: exceptions.CommandError
+    """
+    if (
+        'enable_default_route_bfd' in attrs
+        or 'enable_default_route_ecmp' in attrs
+    ) and not is_multiple_gateways_supported(client):
+        msg = _(
+            'The external-gateway-multihoming extension is not enabled at '
+            'the Neutron side, cannot use --enable-default-route-bfd or '
+            '--enable-default-route-ecmp arguments.'
+        )
+        raise exceptions.CommandError(msg)
+
+
 class AddPortToRouter(command.Command):
     _description = _("Add a port to a router")
 
     def get_parser(self, prog_name):
-        parser = super(AddPortToRouter, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'router',
             metavar='<router>',
@@ -174,7 +329,7 @@ class AddSubnetToRouter(command.Command):
     _description = _("Add a subnet to a router")
 
     def get_parser(self, prog_name):
-        parser = super(AddSubnetToRouter, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'router',
             metavar='<router>',
@@ -200,7 +355,7 @@ class AddExtraRoutesToRouter(command.ShowOne):
     _description = _("Add extra static routes to a router's routing table.")
 
     def get_parser(self, prog_name):
-        parser = super(AddExtraRoutesToRouter, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'router',
             metavar='<router>',
@@ -251,7 +406,7 @@ class RemoveExtraRoutesFromRouter(command.ShowOne):
     )
 
     def get_parser(self, prog_name):
-        parser = super(RemoveExtraRoutesFromRouter, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'router',
             metavar='<router>',
@@ -302,7 +457,7 @@ class CreateRouter(command.ShowOne, common.NeutronCommandWithExtraArgs):
     _description = _("Create a new router")
 
     def get_parser(self, prog_name):
-        parser = super(CreateRouter, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'name', metavar='<name>', help=_("New router name")
         )
@@ -362,18 +517,25 @@ class CreateRouter(command.ShowOne, common.NeutronCommandWithExtraArgs):
         parser.add_argument(
             '--external-gateway',
             metavar="<network>",
-            help=_("External Network used as router's gateway (name or ID)"),
+            action='append',
+            help=_(
+                "External Network used as router's gateway (name or ID). "
+                "(repeat option to set multiple gateways per router "
+                "if the L3 service plugin in use supports it)."
+            ),
+            dest='external_gateways',
         )
         parser.add_argument(
             '--fixed-ip',
             metavar='subnet=<subnet>,ip-address=<ip-address>',
             action=parseractions.MultiKeyValueAction,
             optional_keys=['subnet', 'ip-address'],
+            dest='fixed_ips',
             help=_(
                 "Desired IP and/or subnet (name or ID) "
                 "on external gateway: "
                 "subnet=<subnet>,ip-address=<ip-address> "
-                "(repeat option to set multiple fixed IP addresses)"
+                "(repeat option to set multiple fixed IP addresses)."
             ),
         )
         snat_group = parser.add_mutually_exclusive_group()
@@ -402,11 +564,17 @@ class CreateRouter(command.ShowOne, common.NeutronCommandWithExtraArgs):
             action='store_false',
             help=_("Disable IPv6 NDP proxy on external gateway"),
         )
+        parser.add_argument(
+            '--flavor',
+            metavar='<flavor-id>',
+            help=_("Associate the router to a flavor (by name or ID"),
+        )
         parser.add_argument(
             '--flavor-id',
             metavar='<flavor-id>',
-            help=_("Associate the router to a flavor by ID"),
+            help=argparse.SUPPRESS,
         )
+        _parser_add_bfd_ecmp_arguments(parser)
 
         return parser
 
@@ -422,7 +590,7 @@ class CreateRouter(command.ShowOne, common.NeutronCommandWithExtraArgs):
             self._parse_extra_properties(parsed_args.extra_properties)
         )
 
-        if parsed_args.enable_ndp_proxy and not parsed_args.external_gateway:
+        if parsed_args.enable_ndp_proxy and not parsed_args.external_gateways:
             msg = _(
                 "You must specify '--external-gateway' in order "
                 "to enable router's NDP proxy"
@@ -432,15 +600,26 @@ class CreateRouter(command.ShowOne, common.NeutronCommandWithExtraArgs):
         if parsed_args.enable_ndp_proxy is not None:
             attrs['enable_ndp_proxy'] = parsed_args.enable_ndp_proxy
 
+        _command_check_bfd_ecmp_supported(attrs, client)
+
+        external_gateways = attrs.pop('external_gateways', None)
         obj = client.create_router(**attrs)
         # tags cannot be set when created, so tags need to be set later.
         _tag.update_tags_for_set(client, obj, parsed_args)
 
+        # If the multiple external gateways API is intended to be used,
+        # do a separate API call to set the desired external gateways as the
+        # router creation API supports adding only one.
+        if external_gateways:
+            client.update_external_gateways(
+                obj, body={'router': {'external_gateways': external_gateways}}
+            )
+
         if (
             parsed_args.disable_snat
             or parsed_args.enable_snat
-            or parsed_args.fixed_ip
-        ) and not parsed_args.external_gateway:
+            or parsed_args.fixed_ips
+        ) and not parsed_args.external_gateways:
             msg = _(
                 "You must specify '--external-gateway' in order "
                 "to specify SNAT or fixed-ip values"
@@ -457,7 +636,7 @@ class DeleteRouter(command.Command):
     _description = _("Delete router(s)")
 
     def get_parser(self, prog_name):
-        parser = super(DeleteRouter, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'router',
             metavar="<router>",
@@ -499,7 +678,7 @@ class ListRouter(command.Lister):
     _description = _("List routers")
 
     def get_parser(self, prog_name):
-        parser = super(ListRouter, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             '--name',
             metavar='<name>',
@@ -643,7 +822,7 @@ class RemovePortFromRouter(command.Command):
     _description = _("Remove a port from a router")
 
     def get_parser(self, prog_name):
-        parser = super(RemovePortFromRouter, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'router',
             metavar='<router>',
@@ -669,7 +848,7 @@ class RemoveSubnetFromRouter(command.Command):
     _description = _("Remove a subnet from a router")
 
     def get_parser(self, prog_name):
-        parser = super(RemoveSubnetFromRouter, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'router',
             metavar='<router>',
@@ -699,7 +878,7 @@ class SetRouter(common.NeutronCommandWithExtraArgs):
     _description = _("Set router properties")
 
     def get_parser(self, prog_name):
-        parser = super(SetRouter, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'router',
             metavar="<router>",
@@ -780,18 +959,25 @@ class SetRouter(common.NeutronCommandWithExtraArgs):
         parser.add_argument(
             '--external-gateway',
             metavar="<network>",
-            help=_("External Network used as router's gateway (name or ID)"),
+            action='append',
+            help=_(
+                "External Network used as router's gateway (name or ID). "
+                "(repeat option to set multiple gateways per router "
+                "if the L3 service plugin in use supports it)."
+            ),
+            dest='external_gateways',
         )
         parser.add_argument(
             '--fixed-ip',
             metavar='subnet=<subnet>,ip-address=<ip-address>',
             action=parseractions.MultiKeyValueAction,
             optional_keys=['subnet', 'ip-address'],
+            dest='fixed_ips',
             help=_(
                 "Desired IP and/or subnet (name or ID) "
                 "on external gateway: "
                 "subnet=<subnet>,ip-address=<ip-address> "
-                "(repeat option to set multiple fixed IP addresses)"
+                "(repeat option to set multiple fixed IP addresses)."
             ),
         )
         snat_group = parser.add_mutually_exclusive_group()
@@ -832,6 +1018,7 @@ class SetRouter(common.NeutronCommandWithExtraArgs):
             help=_("Remove QoS policy from router gateway IPs"),
         )
         _tag.add_tag_option_to_parser_for_set(parser, _('router'))
+        _parser_add_bfd_ecmp_arguments(parser)
         return parser
 
     def take_action(self, parsed_args):
@@ -860,8 +1047,8 @@ class SetRouter(common.NeutronCommandWithExtraArgs):
         if (
             parsed_args.disable_snat
             or parsed_args.enable_snat
-            or parsed_args.fixed_ip
-        ) and not parsed_args.external_gateway:
+            or parsed_args.fixed_ips
+        ) and not parsed_args.external_gateways:
             msg = _(
                 "You must specify '--external-gateway' in order "
                 "to update the SNAT or fixed-ip values"
@@ -870,7 +1057,7 @@ class SetRouter(common.NeutronCommandWithExtraArgs):
 
         if (
             parsed_args.qos_policy or parsed_args.no_qos_policy
-        ) and not parsed_args.external_gateway:
+        ) and not parsed_args.external_gateways:
             try:
                 original_net_id = obj.external_gateway_info['network_id']
             except (KeyError, TypeError):
@@ -881,17 +1068,21 @@ class SetRouter(common.NeutronCommandWithExtraArgs):
                 )
                 raise exceptions.CommandError(msg)
             else:
-                if not attrs.get('external_gateway_info'):
+                if not attrs.get('external_gateway_info') and not attrs.get(
+                    'external_gateways'
+                ):
                     attrs['external_gateway_info'] = {}
                 attrs['external_gateway_info']['network_id'] = original_net_id
         if parsed_args.qos_policy:
             check_qos_id = client.find_qos_policy(
                 parsed_args.qos_policy, ignore_missing=False
             ).id
-            attrs['external_gateway_info']['qos_policy_id'] = check_qos_id
+            if not attrs.get('external_gateways'):
+                attrs['external_gateway_info']['qos_policy_id'] = check_qos_id
 
         if 'no_qos_policy' in parsed_args and parsed_args.no_qos_policy:
-            attrs['external_gateway_info']['qos_policy_id'] = None
+            if not attrs.get('external_gateways'):
+                attrs['external_gateway_info']['qos_policy_id'] = None
 
         attrs.update(
             self._parse_extra_properties(parsed_args.extra_properties)
@@ -900,8 +1091,19 @@ class SetRouter(common.NeutronCommandWithExtraArgs):
         if parsed_args.enable_ndp_proxy is not None:
             attrs['enable_ndp_proxy'] = parsed_args.enable_ndp_proxy
 
+        _command_check_bfd_ecmp_supported(attrs, client)
+
         if attrs:
+            external_gateways = attrs.pop('external_gateways', None)
             client.update_router(obj, **attrs)
+            # If the multiple external gateways API is intended to be used,
+            # do a separate API call to set external gateways.
+            if external_gateways:
+                client.update_external_gateways(
+                    obj,
+                    body={'router': {'external_gateways': external_gateways}},
+                )
+
         # tags is a subresource and it needs to be updated separately.
         _tag.update_tags_for_set(client, obj, parsed_args)
 
@@ -910,7 +1112,7 @@ class ShowRouter(command.ShowOne):
     _description = _("Display router details")
 
     def get_parser(self, prog_name):
-        parser = super(ShowRouter, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'router',
             metavar="<router>",
@@ -946,7 +1148,7 @@ class UnsetRouter(common.NeutronUnsetCommandWithExtraArgs):
     _description = _("Unset router properties")
 
     def get_parser(self, prog_name):
-        parser = super(UnsetRouter, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             '--route',
             metavar='destination=<subnet>,gateway=<ip-address>',
@@ -961,11 +1163,15 @@ class UnsetRouter(common.NeutronUnsetCommandWithExtraArgs):
                 "(repeat option to unset multiple routes)"
             ),
         )
+        # NOTE(dmitriis): This was not extended to support selective removal
+        # of external gateways due to a cpython bug in argparse:
+        # https://github.com/python/cpython/issues/53584
         parser.add_argument(
             '--external-gateway',
             action='store_true',
             default=False,
             help=_("Remove external gateway information from the router"),
+            dest='external_gateways',
         )
         parser.add_argument(
             '--qos-policy',
@@ -1012,7 +1218,7 @@ class UnsetRouter(common.NeutronUnsetCommandWithExtraArgs):
                     'qos_policy_id': None,
                 }
 
-        if parsed_args.external_gateway:
+        if parsed_args.external_gateways:
             attrs['external_gateway_info'] = {}
 
         attrs.update(
@@ -1020,6 +1226,149 @@ class UnsetRouter(common.NeutronUnsetCommandWithExtraArgs):
         )
 
         if attrs:
+            # If removing multiple gateways per router are supported,
+            # use the relevant API to remove them all.
+            if is_multiple_gateways_supported(client):
+                client.remove_external_gateways(
+                    obj,
+                    body={'router': {'external_gateways': {}}},
+                )
+
             client.update_router(obj, **attrs)
         # tags is a subresource and it needs to be updated separately.
         _tag.update_tags_for_unset(client, obj, parsed_args)
+
+
+class AddGatewayToRouter(command.ShowOne):
+    _description = _("Add router gateway")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            'router',
+            metavar="<router>",
+            help=_("Router to modify (name or ID)."),
+        )
+        parser.add_argument(
+            metavar="<network>",
+            help=_(
+                "External Network to a attach a router gateway to (name or "
+                "ID)."
+            ),
+            dest='external_gateways',
+            # The argument is stored in a list in order to reuse the
+            # common attribute parsing code.
+            nargs=1,
+        )
+        parser.add_argument(
+            '--fixed-ip',
+            metavar='subnet=<subnet>,ip-address=<ip-address>',
+            action=parseractions.MultiKeyValueAction,
+            optional_keys=['subnet', 'ip-address'],
+            dest='fixed_ips',
+            help=_(
+                "Desired IP and/or subnet (name or ID) "
+                "on external gateway: "
+                "subnet=<subnet>,ip-address=<ip-address> "
+                "(repeat option to set multiple fixed IP addresses)."
+            ),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        if not is_multiple_gateways_supported(client):
+            msg = _(
+                'The external-gateway-multihoming extension is not enabled at '
+                'the Neutron side.'
+            )
+            raise exceptions.CommandError(msg)
+
+        router_obj = client.find_router(
+            parsed_args.router, ignore_missing=False
+        )
+
+        # Get the common attributes.
+        attrs = _get_external_gateway_attrs(
+            self.app.client_manager, parsed_args
+        )
+
+        if attrs:
+            external_gateways = attrs.pop('external_gateways')
+            router_obj = client.add_external_gateways(
+                router_obj,
+                body={'router': {'external_gateways': external_gateways}},
+            )
+
+        display_columns, columns = _get_columns(router_obj)
+        data = utils.get_item_properties(
+            router_obj, columns, formatters=_formatters
+        )
+        return (display_columns, data)
+
+
+class RemoveGatewayFromRouter(command.ShowOne):
+    _description = _("Remove router gateway")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            'router',
+            metavar="<router>",
+            help=_("Router to modify (name or ID)."),
+        )
+        parser.add_argument(
+            metavar="<network>",
+            help=_(
+                "External Network to remove a router gateway from (name or "
+                "ID)."
+            ),
+            dest='external_gateways',
+            # The argument is stored in a list in order to reuse the
+            # common attribute parsing code.
+            nargs=1,
+        )
+        parser.add_argument(
+            '--fixed-ip',
+            metavar='subnet=<subnet>,ip-address=<ip-address>',
+            action=parseractions.MultiKeyValueAction,
+            optional_keys=['subnet', 'ip-address'],
+            dest='fixed_ips',
+            help=_(
+                "IP and/or subnet (name or ID) on the external gateway "
+                "which is used to identify a particular gateway if multiple "
+                "are attached to the same network: subnet=<subnet>,"
+                "ip-address=<ip-address>."
+            ),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        if not is_multiple_gateways_supported(client):
+            msg = _(
+                'The external-gateway-multihoming extension is not enabled at '
+                'the Neutron side.'
+            )
+            raise exceptions.CommandError(msg)
+
+        router_obj = client.find_router(
+            parsed_args.router, ignore_missing=False
+        )
+
+        # Get the common attributes.
+        attrs = _get_external_gateway_attrs(
+            self.app.client_manager, parsed_args
+        )
+        if attrs:
+            external_gateways = attrs.pop('external_gateways')
+            router_obj = client.remove_external_gateways(
+                router_obj,
+                body={'router': {'external_gateways': external_gateways}},
+            )
+
+        display_columns, columns = _get_columns(router_obj)
+        data = utils.get_item_properties(
+            router_obj, columns, formatters=_formatters
+        )
+        return (display_columns, data)