Network L3 Router Commands for OSC

Implements: blueprint network-l3-commands

Co-Authored-By: Akihiro Motoki <amotoki@gmail.com>
Change-Id: Ia24d76227e164062e89a74c1621b8acb830b26cf

Author: ankur-odl

doc/source/cli/command-objects/network-agent.rst

@@ -33,7 +33,34 @@ Add network to an agent
 
 .. describe:: <network>
 
-    Network to be added to an agent (ID or name)
+    Network to be added to an agent (name or ID)
+
+network agent add router
+------------------------
+
+Add router to an agent
+
+.. program:: network agent add router
+.. code:: bash
+
+    openstack network agent add router
+        [--l3]
+        <agent-id>
+        <router>
+
+.. option:: --l3
+
+    Add router to L3 agent
+
+.. _network_agent_add_router-agent-id:
+.. describe:: <agent-id>
+
+   Agent to which a router is added (ID only)
+
+.. _network_agent_add_router-router:
+.. describe:: <router>
+
+   Router to be added to an agent (name or ID)
 
 network agent delete
 --------------------
@@ -62,7 +89,8 @@ List network agents
     openstack network agent list
         [--agent-type <agent-type>]
         [--host <host>]
-        [--network <network>]
+        [--network <network> | --router <router>]
+        [--long]
 
 .. option:: --agent-type <agent-type>
 
@@ -77,7 +105,69 @@ List network agents
 
 .. option:: --network <network>
 
-    List agents hosting a network (ID or name)
+    List agents hosting a network (name or ID)
+
+.. option:: --router <router>
+
+    List agents hosting this router (name or ID)
+
+.. option:: --long
+
+    List additional fields in output
+
+network agent remove network
+----------------------------
+
+Remove network from an agent
+
+.. program:: network agent remove network
+.. code:: bash
+
+    openstack network agent remove network
+        [--dhcp]
+        <agent-id>
+        <network>
+
+.. option:: --dhcp
+
+    Remove network from DHCP agent
+
+.. _network_agent_remove_network-agent-id:
+.. describe:: <agent-id>
+
+    Agent to which a network is removed (ID only)
+
+.. _network_agent_remove_network-network:
+.. describe:: <network>
+
+    Network to be removed from an agent (name or ID)
+
+network agent remove router
+---------------------------
+
+Remove router from an agent
+
+.. program:: network agent remove router
+.. code:: bash
+
+    openstack agent remove router
+        [--l3]
+        <agent-id>
+        <router>
+
+.. option:: --l3
+
+    Remove router from L3 agent
+
+.. _network_agent_remove_router-agent-id:
+.. describe:: <agent-id>
+
+   Agent from which router will be removed (ID only)
+
+.. _network_agent_remove_router-router:
+.. describe:: <router>
+
+   Router to be removed from an agent (name or ID)
 
 network agent set
 -----------------
@@ -124,28 +214,3 @@ Display network agent details
 .. describe:: <network-agent>
 
     Network agent to display (ID only)
-
-network agent remove network
-----------------------------
-
-Remove network from an agent
-
-.. program:: network agent remove network
-.. code:: bash
-
-    openstack network agent remove network
-        [--dhcp]
-        <agent-id>
-        <network>
-
-.. describe:: --dhcp
-
-    Remove network from DHCP agent.
-
-.. describe:: <agent-id>
-
-    Agent to which a network is removed (ID only)
-
-.. describe:: <network>
-
-    Network to be removed from an agent (ID or name)

doc/source/cli/command-objects/router.rst

@@ -155,6 +155,11 @@ List routers
         [--enable | --disable]
         [--long]
         [--project <project> [--project-domain <project-domain>]]
+        [--agent <agent-id>]
+
+.. option:: --agent <agent-id>
+
+    List routers hosted by an agent (ID only)
 
 .. option:: --long
 

openstackclient/network/v2/network_agent.py

@@ -26,10 +26,16 @@
 LOG = logging.getLogger(__name__)
 
 
+def _format_alive(alive):
+    return ":-)" if alive else "XXX"
+
+
 def _format_admin_state(state):
     return 'UP' if state else 'DOWN'
 
 _formatters = {
+    'is_alive': _format_alive,
+    'alive': _format_alive,
     'admin_state_up': _format_admin_state,
     'is_admin_state_up': _format_admin_state,
     'configurations': utils.format_dict,
@@ -60,7 +66,7 @@ def get_parser(self, prog_name):
         parser.add_argument(
             'network',
             metavar='<network>',
-            help=_('Network to be added to an agent (ID or name)'))
+            help=_('Network to be added to an agent (name or ID)'))
 
         return parser
 
@@ -78,6 +84,37 @@ def take_action(self, parsed_args):
                 exceptions.CommandError(msg)
 
 
+class AddRouterToAgent(command.Command):
+    _description = _("Add router to an agent")
+
+    def get_parser(self, prog_name):
+        parser = super(AddRouterToAgent, self).get_parser(prog_name)
+        parser.add_argument(
+            '--l3',
+            action='store_true',
+            help=_('Add router to an L3 agent')
+        )
+        parser.add_argument(
+            'agent_id',
+            metavar='<agent-id>',
+            help=_("Agent to which a router is added (ID only)")
+        )
+        parser.add_argument(
+            'router',
+            metavar='<router>',
+            help=_("Router to be added to an agent (name or ID)")
+        )
+
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        agent = client.get_agent(parsed_args.agent_id)
+        router = client.find_router(parsed_args.router, ignore_missing=False)
+        if parsed_args.l3:
+            client.add_router_to_agent(agent, router)
+
+
 class DeleteNetworkAgent(command.Command):
     _description = _("Delete network agent(s)")
 
@@ -135,11 +172,24 @@ def get_parser(self, prog_name):
             metavar='<host>',
             help=_("List only agents running on the specified host")
         )
-        parser.add_argument(
+        agent_type_group = parser.add_mutually_exclusive_group()
+        agent_type_group.add_argument(
             '--network',
             metavar='<network>',
             help=_('List agents hosting a network (name or ID)')
         )
+        agent_type_group.add_argument(
+            '--router',
+            metavar='<router>',
+            help=_('List agents hosting this router (name or ID)')
+        )
+        parser.add_argument(
+            '--long',
+            action='store_true',
+            default=False,
+            help=_("List additional fields in output")
+        )
+
         return parser
 
     def take_action(self, parsed_args):
@@ -178,39 +228,29 @@ def take_action(self, parsed_args):
         }
 
         filters = {}
+
         if parsed_args.network is not None:
-            columns = (
-                'id',
-                'host',
-                'is_admin_state_up',
-                'is_alive',
-            )
-            column_headers = (
-                'ID',
-                'Host',
-                'Admin State Up',
-                'Alive',
-            )
             network = client.find_network(
                 parsed_args.network, ignore_missing=False)
             data = client.network_hosting_dhcp_agents(network)
-
-            return (column_headers,
-                    (utils.get_item_properties(
-                        s, columns,
-                        formatters=_formatters,
-                    ) for s in data))
+        elif parsed_args.router is not None:
+            if parsed_args.long:
+                columns += ('ha_state',)
+                column_headers += ('HA State',)
+            router = client.find_router(parsed_args.router,
+                                        ignore_missing=False)
+            data = client.routers_hosting_l3_agents(router)
         else:
             if parsed_args.agent_type is not None:
                 filters['agent_type'] = key_value[parsed_args.agent_type]
             if parsed_args.host is not None:
                 filters['host'] = parsed_args.host
 
             data = client.agents(**filters)
-            return (column_headers,
-                    (utils.get_item_properties(
-                        s, columns, formatters=_formatters,
-                    ) for s in data))
+        return (column_headers,
+                (utils.get_item_properties(
+                    s, columns, formatters=_formatters,
+                ) for s in data))
 
 
 class RemoveNetworkFromAgent(command.Command):
@@ -229,7 +269,7 @@ def get_parser(self, prog_name):
         parser.add_argument(
             'network',
             metavar='<network>',
-            help=_('Network to be removed from an agent (ID or name)'))
+            help=_('Network to be removed from an agent (name or ID)'))
         return parser
 
     def take_action(self, parsed_args):
@@ -246,6 +286,37 @@ def take_action(self, parsed_args):
                 exceptions.CommandError(msg)
 
 
+class RemoveRouterFromAgent(command.Command):
+    _description = _("Remove router from an agent")
+
+    def get_parser(self, prog_name):
+        parser = super(RemoveRouterFromAgent, self).get_parser(prog_name)
+        parser.add_argument(
+            '--l3',
+            action='store_true',
+            help=_('Remove router from an L3 agent')
+        )
+        parser.add_argument(
+            'agent_id',
+            metavar='<agent-id>',
+            help=_("Agent from which router will be removed (ID only)")
+        )
+        parser.add_argument(
+            'router',
+            metavar='<router>',
+            help=_("Router to be removed from an agent (name or ID)")
+        )
+
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        agent = client.get_agent(parsed_args.agent_id)
+        router = client.find_router(parsed_args.router, ignore_missing=False)
+        if parsed_args.l3:
+            client.remove_router_from_agent(agent, router)
+
+
 # TODO(huanxuan): Use the SDK resource mapped attribute names once the
 # OSC minimum requirements include SDK 1.0.
 class SetNetworkAgent(command.Command):