python-openstackclient 7.4.0__py3-none-any.whl → 8.1.0__py3-none-any.whl

openstackclient/network/v2/local_ip.py

@@ -28,10 +28,9 @@ LOG = logging.getLogger(__name__)
 
 
 def _get_columns(item):
-    column_map = {}
     hidden_columns = ['location', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
-        item, column_map, hidden_columns
+        item, {}, hidden_columns
     )
 
 
@@ -74,30 +73,32 @@ class CreateLocalIP(command.ShowOne):
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
         parser.add_argument(
-            '--name', metavar="<name>", help=_("New local IP name")
+            '--name', metavar="<name>", help=_("New Local IP name")
         )
         parser.add_argument(
             '--description',
             metavar="<description>",
-            help=_("New local IP description"),
+            help=_("Description for Local IP"),
         )
         parser.add_argument(
             '--network',
             metavar='<network>',
-            help=_("Network to allocate Local IP (name or ID)"),
+            help=_("Network to allocate Local IP from (name or ID)"),
         )
         parser.add_argument(
             '--local-port',
             metavar='<local-port>',
-            help=_("Port to allocate Local IP (name or ID)"),
+            help=_("Port to allocate Local IP from (name or ID)"),
         )
         parser.add_argument(
             "--local-ip-address",
             metavar="<local-ip-address>",
-            help=_("IP address or CIDR "),
+            help=_("IP address or CIDR for Local IP"),
         )
         parser.add_argument(
-            '--ip-mode', metavar='<ip-mode>', help=_("local IP ip mode")
+            '--ip-mode',
+            metavar='<ip-mode>',
+            help=_("IP mode to use for Local IP"),
         )
 
         identity_common.add_project_domain_option_to_parser(parser)
@@ -116,7 +117,7 @@ class CreateLocalIP(command.ShowOne):
 
 
 class DeleteLocalIP(command.Command):
-    _description = _("Delete local IP(s)")
+    _description = _("Delete Local IP(s)")
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
@@ -149,14 +150,15 @@ class DeleteLocalIP(command.Command):
 
         if result > 0:
             total = len(parsed_args.local_ip)
-            msg = _(
-                "%(result)s of %(total)s local IPs failed " "to delete."
-            ) % {'result': result, 'total': total}
+            msg = _("%(result)s of %(total)s local IPs failed to delete.") % {
+                'result': result,
+                'total': total,
+            }
             raise exceptions.CommandError(msg)
 
 
 class SetLocalIP(command.Command):
-    _description = _("Set local ip properties")
+    _description = _("Set Local IP properties")
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
@@ -171,7 +173,7 @@ class SetLocalIP(command.Command):
         parser.add_argument(
             '--description',
             metavar="<description>",
-            help=_('Set local IP description'),
+            help=_('Set Local IP description'),
         )
         return parser
 
@@ -188,7 +190,7 @@ class SetLocalIP(command.Command):
 
 
 class ListLocalIP(command.Lister):
-    _description = _("List local IPs")
+    _description = _("List Local IPs")
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
@@ -196,36 +198,32 @@ class ListLocalIP(command.Lister):
         parser.add_argument(
             '--name',
             metavar='<name>',
-            help=_("List only local IPs of given name in output"),
+            help=_("List only Local IPs of given name in output"),
         )
         parser.add_argument(
             '--project',
             metavar="<project>",
-            help=_(
-                "List Local IPs according to their project " "(name or ID)"
-            ),
+            help=_("List Local IPs according to their project (name or ID)"),
         )
         parser.add_argument(
             '--network',
             metavar='<network>',
-            help=_(
-                "List Local IP(s) according to " "given network (name or ID)"
-            ),
+            help=_("List Local IP(s) according to given network (name or ID)"),
         )
         parser.add_argument(
             '--local-port',
             metavar='<local-port>',
-            help=_("List Local IP(s) according to " "given port (name or ID)"),
+            help=_("List Local IP(s) according to given port (name or ID)"),
         )
         parser.add_argument(
             '--local-ip-address',
             metavar='<local-ip-address>',
-            help=_("List Local IP(s) according to " "given Local IP Address"),
+            help=_("List Local IP(s) according to given Local IP Address"),
         )
         parser.add_argument(
             '--ip-mode',
             metavar='<ip_mode>',
-            help=_("List Local IP(s) according to " "given IP mode"),
+            help=_("List Local IP(s) according to given IP mode"),
         )
 
         identity_common.add_project_domain_option_to_parser(parser)
@@ -295,7 +293,7 @@ class ListLocalIP(command.Lister):
 
 
 class ShowLocalIP(command.ShowOne):
-    _description = _("Display local IP details")
+    _description = _("Display Local IP details")
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)

openstackclient/network/v2/local_ip_association.py

@@ -28,10 +28,9 @@ LOG = logging.getLogger(__name__)
 
 
 def _get_columns(item):
-    column_map = {}
     hidden_columns = ['location', 'name', 'id', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
-        item, column_map, hidden_columns
+        item, {}, hidden_columns
     )
 
 
@@ -44,7 +43,7 @@ class CreateLocalIPAssociation(command.ShowOne):
             'local_ip',
             metavar='<local-ip>',
             help=_(
-                "Local IP that the port association belongs to " "(Name or ID)"
+                "Local IP that the port association belongs to (Name or ID)"
             ),
         )
         parser.add_argument(
@@ -90,7 +89,7 @@ class DeleteLocalIPAssociation(command.Command):
             'local_ip',
             metavar="<local-ip>",
             help=_(
-                "Local IP that the port association belongs to " "(Name or ID)"
+                "Local IP that the port association belongs to (Name or ID)"
             ),
         )
         parser.add_argument(
@@ -151,7 +150,7 @@ class ListLocalIPAssociation(command.Lister):
             '--fixed-port',
             metavar='<fixed-port>',
             help=_(
-                "Filter the list result by the ID or name of " "the fixed port"
+                "Filter the list result by the ID or name of the fixed port"
             ),
         )
         parser.add_argument(

openstackclient/network/v2/ndp_proxy.py

@@ -29,10 +29,9 @@ LOG = logging.getLogger(__name__)
 
 
 def _get_columns(item):
-    column_map = {}
     hidden_columns = ['location']
     return utils.get_osc_show_columns_for_sdk_resource(
-        item, column_map, hidden_columns
+        item, {}, hidden_columns
     )
 
 
@@ -69,7 +68,7 @@ class CreateNDPProxy(command.ShowOne):
             '--description',
             metavar='<description>',
             help=_(
-                "A text to describe/contextualize the use of the "
+                "Text to describe/contextualize the use of the "
                 "NDP proxy configuration"
             ),
         )
@@ -124,13 +123,13 @@ class DeleteNDPProxy(command.Command):
             except Exception as e:
                 result += 1
                 LOG.error(
-                    _("Failed to delete NDP proxy " "'%(ndp_proxy)s': %(e)s"),
+                    _("Failed to delete NDP proxy '%(ndp_proxy)s': %(e)s"),
                     {'ndp_proxy': ndp_proxy, 'e': e},
                 )
         if result > 0:
             total = len(parsed_args.ndp_proxy)
             msg = _(
-                "%(result)s of %(total)s NDP proxies failed " "to delete."
+                "%(result)s of %(total)s NDP proxies failed to delete."
             ) % {'result': result, 'total': total}
             raise exceptions.CommandError(msg)
 
@@ -156,18 +155,18 @@ class ListNDPProxy(command.Lister):
         )
         parser.add_argument(
             '--ip-address',
-            metavar='ip-address',
-            help=_("List only NDP proxies according to their IPv6 address"),
+            metavar='<ip-address>',
+            help=_("List only NDP proxies associated to this IPv6 address"),
         )
         parser.add_argument(
             '--project',
             metavar='<project>',
-            help=_("List NDP proxies according to their project (name or ID)"),
+            help=_("List only NDP proxies of given project (name or ID)"),
         )
         parser.add_argument(
             '--name',
             metavar='<name>',
-            help=_("List NDP proxies according to their name"),
+            help=_("List only NDP proxies of given name"),
         )
 
         identity_common.add_project_domain_option_to_parser(parser)
@@ -247,7 +246,7 @@ class SetNDPProxy(command.Command):
             '--description',
             metavar='<description>',
             help=_(
-                "A text to describe/contextualize the use of "
+                "Text to describe/contextualize the use of "
                 "the NDP proxy configuration"
             ),
         )

openstackclient/network/v2/network.py

@@ -68,8 +68,7 @@ def _get_columns_network(item):
 
 
 def _get_columns_compute(item):
-    column_map = {}
-    return utils.get_osc_show_columns_for_sdk_resource(item, column_map)
+    return utils.get_osc_show_columns_for_sdk_resource(item, {})
 
 
 def _get_attrs_network(client_manager, parsed_args):
@@ -166,7 +165,7 @@ def _add_additional_network_options(parser):
         help=_(
             "The physical mechanism by which the virtual network "
             "is implemented. For example: "
-            "flat, geneve, gre, local, vlan, vxlan."
+            "flat, geneve, gre, local, vlan or vxlan."
         ),
     )
     parser.add_argument(
@@ -292,8 +291,8 @@ class CreateNetwork(
             action='store_true',
             help=self.enhance_help_neutron(
                 _(
-                    "The network has an external routing facility that's not "
-                    "managed by Neutron and can be used as in: "
+                    "The network has an external routing facility that is not "
+                    "managed by Neutron and can be used. For example: "
                     "openstack router set --external-gateway NETWORK "
                     "(external-net extension required)"
                 )
@@ -355,17 +354,14 @@ class CreateNetwork(
             '--qinq-vlan',
             action='store_true',
             help=self.enhance_help_neutron(
-                _("Enable VLAN QinQ (S-Tag ethtype 0x8a88) " "for the network")
+                _("Enable VLAN QinQ (S-Tag ethtype 0x8a88) for the network")
             ),
         )
         vlan_qinq_grp.add_argument(
             '--no-qinq-vlan',
             action='store_true',
             help=self.enhance_help_neutron(
-                _(
-                    "Disable VLAN QinQ (S-Tag ethtype 0x8a88) "
-                    "for the network"
-                )
+                _("Disable VLAN QinQ (S-Tag ethtype 0x8a88) for the network")
             ),
         )
 
@@ -537,7 +533,7 @@ class ListNetwork(common.NetworkAndComputeLister):
                 _(
                     "List networks according to their physical mechanisms. "
                     "The supported options are: flat, geneve, gre, local, "
-                    "vlan, vxlan."
+                    "vlan and vxlan."
                 )
             ),
         )
@@ -576,7 +572,7 @@ class ListNetwork(common.NetworkAndComputeLister):
     def take_action_network(self, client, parsed_args):
         identity_client = self.app.client_manager.identity
         if parsed_args.long:
-            columns = (
+            columns: tuple[str, ...] = (
                 'id',
                 'name',
                 'status',
@@ -589,7 +585,7 @@ class ListNetwork(common.NetworkAndComputeLister):
                 'availability_zones',
                 'tags',
             )
-            column_headers = (
+            column_headers: tuple[str, ...] = (
                 'ID',
                 'Name',
                 'Status',
@@ -789,10 +785,10 @@ class SetNetwork(common.NeutronCommandWithExtraArgs):
             '--external',
             action='store_true',
             help=_(
-                "The network has an external routing facility that's not "
-                "managed by Neutron and can be used as in: "
+                "The network has an external routing facility that is not "
+                "managed by Neutron and can be used. For example: "
                 "openstack router set --external-gateway NETWORK "
-                "(external-net extension required)"
+                "(external-net extension required)."
             ),
         )
         external_router_grp.add_argument(

openstackclient/network/v2/network_agent.py

@@ -155,7 +155,7 @@ class DeleteNetworkAgent(command.Command):
         if result > 0:
             total = len(parsed_args.network_agent)
             msg = _(
-                "%(result)s of %(total)s network agents failed " "to delete."
+                "%(result)s of %(total)s network agents failed to delete."
             ) % {'result': result, 'total': total}
             raise exceptions.CommandError(msg)
 
@@ -164,32 +164,37 @@ class DeleteNetworkAgent(command.Command):
 # 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',
@@ -218,7 +223,7 @@ class ListNetworkAgent(command.Lister):
 
     def take_action(self, parsed_args):
         client = self.app.client_manager.network
-        columns = (
+        columns: tuple[str, ...] = (
             'id',
             'agent_type',
             'host',
@@ -227,7 +232,7 @@ class ListNetworkAgent(command.Lister):
             'is_admin_state_up',
             'binary',
         )
-        column_headers = (
+        column_headers: tuple[str, ...] = (
             'ID',
             'Agent Type',
             'Host',
@@ -237,21 +242,6 @@ class ListNetworkAgent(command.Lister):
             '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 @@ class ListNetworkAgent(command.Lister):
             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
 

openstackclient/network/v2/network_auto_allocated_topology.py

@@ -25,10 +25,9 @@ LOG = logging.getLogger(__name__)
 
 
 def _get_columns(item):
-    column_map = {}
     hidden_columns = ['name', 'location', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
-        item, column_map, hidden_columns
+        item, {}, hidden_columns
     )
 
 
@@ -71,7 +70,7 @@ class CreateAutoAllocatedTopology(command.ShowOne):
             metavar='<project>',
             help=_(
                 "Return the auto allocated topology for a given project. "
-                "Default is current project"
+                "Default is current project."
             ),
         )
         identity_common.add_project_domain_option_to_parser(parser)
@@ -89,7 +88,7 @@ class CreateAutoAllocatedTopology(command.ShowOne):
             default=True,
             help=_(
                 "If topology exists returns the topology's "
-                "information (Default)"
+                "information (default)"
             ),
         )
 
@@ -132,7 +131,7 @@ class DeleteAutoAllocatedTopology(command.Command):
             metavar='<project>',
             help=_(
                 'Delete auto allocated topology for a given project. '
-                'Default is the current project'
+                'Default is the current project.'
             ),
         )
         identity_common.add_project_domain_option_to_parser(parser)

openstackclient/network/v2/network_flavor.py

@@ -102,7 +102,7 @@ class CreateNetworkFlavor(command.ShowOne, common.NeutronCommandWithExtraArgs):
             metavar="<service-type>",
             required=True,
             help=_(
-                'Service type to which the flavor applies to: e.g. VPN '
+                'Service type to which the flavor applies. For example: VPN '
                 '(See openstack network service provider list for loaded '
                 'examples.)'
             ),

openstackclient/network/v2/network_flavor_profile.py

@@ -79,14 +79,14 @@ class CreateNetworkFlavorProfile(
             '--driver',
             help=_(
                 "Python module path to driver. This becomes "
-                "required if --metainfo is missing and vice versa"
+                "required if --metainfo is missing and vice-versa."
             ),
         )
         parser.add_argument(
             '--metainfo',
             help=_(
                 "Metainfo for the flavor profile. This becomes "
-                "required if --driver is missing and vice versa"
+                "required if --driver is missing and vice-versa."
             ),
         )
 
@@ -146,7 +146,7 @@ class DeleteNetworkFlavorProfile(command.Command):
         if result > 0:
             total = len(parsed_args.flavor_profile)
             msg = _(
-                "%(result)s of %(total)s flavor_profiles failed " "to delete."
+                "%(result)s of %(total)s flavor_profiles failed to delete."
             ) % {"result": result, "total": total}
             raise exceptions.CommandError(msg)
 
@@ -217,14 +217,14 @@ class SetNetworkFlavorProfile(common.NeutronCommandWithExtraArgs):
             '--driver',
             help=_(
                 "Python module path to driver. This becomes "
-                "required if --metainfo is missing and vice versa"
+                "required if --metainfo is missing and vice-versa."
             ),
         )
         parser.add_argument(
             '--metainfo',
             help=_(
                 "Metainfo for the flavor profile. This becomes "
-                "required if --driver is missing and vice versa"
+                "required if --driver is missing and vice-versa."
             ),
         )
 

openstackclient/network/v2/network_meter.py

@@ -70,7 +70,7 @@ class CreateMeter(command.ShowOne, common.NeutronCommandWithExtraArgs):
         parser.add_argument(
             '--description',
             metavar='<description>',
-            help=_("Create description for meter"),
+            help=_("Description for meter"),
         )
         parser.add_argument(
             '--project',
@@ -139,12 +139,12 @@ class DeleteMeter(command.Command):
             except Exception as e:
                 result += 1
                 LOG.error(
-                    _("Failed to delete meter with " "ID '%(meter)s': %(e)s"),
+                    _("Failed to delete meter with ID '%(meter)s': %(e)s"),
                     {"meter": meter, "e": e},
                 )
         if result > 0:
             total = len(parsed_args.meter)
-            msg = _("%(result)s of %(total)s meters failed " "to delete.") % {
+            msg = _("%(result)s of %(total)s meters failed to delete.") % {
                 "result": result,
                 "total": total,
             }

openstackclient/network/v2/network_meter_rule.py

@@ -14,6 +14,7 @@
 """Meter Rule Implementations"""
 
 import logging
+import typing as ty
 
 from osc_lib.command import command
 from osc_lib import exceptions
@@ -27,15 +28,14 @@ LOG = logging.getLogger(__name__)
 
 
 def _get_columns(item):
-    column_map = {}
     hidden_columns = ['location', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
-        item, column_map, hidden_columns
+        item, {}, hidden_columns
     )
 
 
 def _get_attrs(client_manager, parsed_args):
-    attrs = {}
+    attrs: dict[str, ty.Any] = {}
 
     if parsed_args.exclude:
         attrs['excluded'] = True
@@ -168,17 +168,14 @@ class DeleteMeterRule(command.Command):
             except Exception as e:
                 result += 1
                 LOG.error(
-                    _(
-                        "Failed to delete meter rule with "
-                        "ID '%(id)s': %(e)s"
-                    ),
+                    _("Failed to delete meter rule with ID '%(id)s': %(e)s"),
                     {"id": id, "e": e},
                 )
 
         if result > 0:
             total = len(parsed_args.meter_rule_id)
             msg = _(
-                "%(result)s of %(total)s meter rules failed " "to delete."
+                "%(result)s of %(total)s meter rules failed to delete."
             ) % {"result": result, "total": total}
             raise exceptions.CommandError(msg)
 

openstackclient/network/v2/network_qos_policy.py

@@ -174,7 +174,7 @@ class DeleteNetworkQosPolicy(command.Command):
         if result > 0:
             total = len(parsed_args.policy)
             msg = _(
-                "%(result)s of %(total)s QoS policies failed " "to delete."
+                "%(result)s of %(total)s QoS policies failed to delete."
             ) % {'result': result, 'total': total}
             raise exceptions.CommandError(msg)
 
@@ -190,7 +190,7 @@ class ListNetworkQosPolicy(command.Lister):
             '--project',
             metavar='<project>',
             help=_(
-                "List qos policies according to their project (name or ID)"
+                "List QoS policies according to their project (name or ID)"
             ),
         )
         identity_common.add_project_domain_option_to_parser(parser)
@@ -198,12 +198,12 @@ class ListNetworkQosPolicy(command.Lister):
         shared_group.add_argument(
             '--share',
             action='store_true',
-            help=_("List qos policies shared between projects"),
+            help=_("List QoS policies shared between projects"),
         )
         shared_group.add_argument(
             '--no-share',
             action='store_true',
-            help=_("List qos policies not shared between projects"),
+            help=_("List QoS policies not shared between projects"),
         )
         return parser