Add four new network agent types to the list command filter

ralonsoh · ralonsoh · commit 762a3b10d137 · 2025-02-24T10:58:48.000Z
Added four new network agent types to the list method filter: * ``ovn-controller`` * ``ovn-controller-gateway`` * ``ovn-metadata`` * ``ovn-agent`` These agents are represented in the OVN network agent classes defined in [1]. The OVN agent names are defined in [2]. [1]https://github.com/openstack/neutron/blob/86f94de99aa08b1b4aadca8e90c6e79487171b8e/neutron/plugins/ml2/drivers/ovn/agent/neutron_agent.py [2]https://github.com/openstack/neutron/blob/86f94de99aa08b1b4aadca8e90c6e79487171b8e/neutron/common/ovn/constants.py#L91-L94 Closes-Bug: #2097124 Change-Id: I117be7e60f67fdd94677cbaa65a3aff01e57bb5e
diff --git a/openstackclient/network/v2/network_agent.py b/openstackclient/network/v2/network_agent.py
@@ -164,32 +164,37 @@ def take_action(self, parsed_args):
 # OSC minimum requirements include SDK 1.0.
 class ListNetworkAgent(command.Lister):
     _description = _("List network agents")
+    _supported_agents = {
+        'bgp': 'BGP dynamic routing agent',
+        'dhcp': 'DHCP agent',
+        'open-vswitch': 'Open vSwitch agent',
+        'linux-bridge': 'Linux bridge agent',
+        'ofa': 'OFA driver agent',
+        'l3': 'L3 agent',
+        'loadbalancer': 'Loadbalancer agent',
+        'metering': 'Metering agent',
+        'metadata': 'Metadata agent',
+        'macvtap': 'Macvtap agent',
+        'nic': 'NIC Switch agent',
+        'baremetal': 'Baremetal Node',
+        'ovn-controller': 'OVN Controller agent',
+        'ovn-controller-gateway': 'OVN Controller Gateway agent',
+        'ovn-metadata': 'OVN Metadata agent',
+        'ovn-agent': 'OVN Neutron agent',
+    }
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
+        supported_agents = ','.join(self._supported_agents.keys())
         parser.add_argument(
             '--agent-type',
             metavar='<agent-type>',
-            choices=[
-                "bgp",
-                "dhcp",
-                "open-vswitch",
-                "linux-bridge",
-                "ofa",
-                "l3",
-                "loadbalancer",
-                "metering",
-                "metadata",
-                "macvtap",
-                "nic",
-                "baremetal",
-            ],
+            choices=list(self._supported_agents.keys()),
             help=_(
                 "List only agents with the specified agent type. "
-                "The supported agent types are: bgp, dhcp, open-vswitch, "
-                "linux-bridge, ofa, l3, loadbalancer, metering, "
-                "metadata, macvtap, nic, baremetal."
-            ),
+                "The supported agent types are: %(supported_agents)s."
+            )
+            % {'supported_agents': supported_agents},
         )
         parser.add_argument(
             '--host',
@@ -237,21 +242,6 @@ def take_action(self, parsed_args):
             'Binary',
         )
 
-        key_value = {
-            'bgp': 'BGP dynamic routing agent',
-            'dhcp': 'DHCP agent',
-            'open-vswitch': 'Open vSwitch agent',
-            'linux-bridge': 'Linux bridge agent',
-            'ofa': 'OFA driver agent',
-            'l3': 'L3 agent',
-            'loadbalancer': 'Loadbalancer agent',
-            'metering': 'Metering agent',
-            'metadata': 'Metadata agent',
-            'macvtap': 'Macvtap agent',
-            'nic': 'NIC Switch agent',
-            'baremetal': 'Baremetal Node',
-        }
-
         filters = {}
 
         if parsed_args.network is not None:
@@ -269,7 +259,9 @@ def take_action(self, parsed_args):
             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]
+                filters['agent_type'] = self._supported_agents[
+                    parsed_args.agent_type
+                ]
             if parsed_args.host is not None:
                 filters['host'] = parsed_args.host
 
diff --git a/releasenotes/notes/network-ovn-agents-bdfced3a6d25e7d2.yaml b/releasenotes/notes/network-ovn-agents-bdfced3a6d25e7d2.yaml
@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    Added four new network agent types to the list method filter:
+    ``ovn-controller``, ``ovn-controller-gateway``, ``ovn-metadata`` and
+    ``ovn-agent``.
