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

openstackclient/network/v2/default_security_group_rule.py

@@ -16,10 +16,10 @@
 import logging
 
 from osc_lib.cli import parseractions
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.network import common
 from openstackclient.network import utils as network_utils
@@ -150,7 +150,7 @@ class CreateDefaultSecurityGroupRule(
         return parser
 
     def take_action(self, parsed_args):
-        client = self.app.client_manager.sdk_connection.network
+        client = self.app.client_manager.network
         # Build the create attributes.
         attrs = {}
         attrs['protocol'] = network_utils.get_protocol(parsed_args)
@@ -248,7 +248,7 @@ class DeleteDefaultSecurityGroupRule(command.Command):
 
     def take_action(self, parsed_args):
         result = 0
-        client = self.app.client_manager.sdk_connection.network
+        client = self.app.client_manager.network
         for r in parsed_args.rule:
             try:
                 obj = client.find_default_security_group_rule(
@@ -300,7 +300,8 @@ class ListDefaultSecurityGroupRule(command.Lister):
             metavar='<protocol>',
             type=network_utils.convert_to_lowercase,
             help=_(
-                "List rules by the IP protocol (ah, dhcp, egp, esp, gre, "
+                "List only default rules with the specified IP protocol "
+                "(ah, dhcp, egp, esp, gre, "
                 "icmp, igmp, ipv6-encap, ipv6-frag, ipv6-icmp, "
                 "ipv6-nonxt, ipv6-opts, ipv6-route, ospf, pgm, rsvp, "
                 "sctp, tcp, udp, udplite, vrrp and integer "
@@ -319,7 +320,7 @@ class ListDefaultSecurityGroupRule(command.Lister):
             '--ingress',
             action='store_true',
             help=_(
-                "List default rules which will be applied to incoming "
+                "List only default rules which will be applied to incoming "
                 "network traffic"
             ),
         )
@@ -327,14 +328,14 @@ class ListDefaultSecurityGroupRule(command.Lister):
             '--egress',
             action='store_true',
             help=_(
-                "List default rules which will be applied to outgoing "
+                "List only default rules which will be applied to outgoing "
                 "network traffic"
             ),
         )
         return parser
 
     def take_action(self, parsed_args):
-        client = self.app.client_manager.sdk_connection.network
+        client = self.app.client_manager.network
         column_headers = (
             'ID',
             'IP Protocol',
@@ -403,7 +404,7 @@ class ShowDefaultSecurityGroupRule(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        client = self.app.client_manager.sdk_connection.network
+        client = self.app.client_manager.network
         obj = client.find_default_security_group_rule(
             parsed_args.rule, ignore_missing=False
         )

openstackclient/network/v2/floating_ip.py

@@ -247,7 +247,7 @@ class ListFloatingIP(common.NetworkAndComputeLister):
             action='append',
             help=self.enhance_help_neutron(
                 _(
-                    "List floating IP(s) according to given network "
+                    "List only floating IP(s) with the specified network "
                     "(name or ID) "
                     "(repeat option to fiter on multiple networks)"
                 )
@@ -260,7 +260,8 @@ class ListFloatingIP(common.NetworkAndComputeLister):
             action='append',
             help=self.enhance_help_neutron(
                 _(
-                    "List floating IP(s) according to given port (name or ID) "
+                    "List only floating IP(s) with the specified port "
+                    "(name or ID) "
                     "(repeat option to fiter on multiple ports)"
                 )
             ),
@@ -269,14 +270,20 @@ class ListFloatingIP(common.NetworkAndComputeLister):
             '--fixed-ip-address',
             metavar='<ip-address>',
             help=self.enhance_help_neutron(
-                _("List floating IP(s) according to given fixed IP address")
+                _(
+                    "List only floating IP(s) with the specified fixed IP "
+                    "address"
+                )
             ),
         )
         parser.add_argument(
             '--floating-ip-address',
             metavar='<ip-address>',
             help=self.enhance_help_neutron(
-                _("List floating IP(s) according to given floating IP address")
+                _(
+                    "List only floating IP(s) with the specified floating IP "
+                    "address"
+                )
             ),
         )
         parser.add_argument(
@@ -285,8 +292,8 @@ class ListFloatingIP(common.NetworkAndComputeLister):
             choices=['ACTIVE', 'DOWN'],
             help=self.enhance_help_neutron(
                 _(
-                    "List floating IP(s) according to given status ('ACTIVE', "
-                    "'DOWN')"
+                    "List only floating IP(s) with the specified status "
+                    "('ACTIVE', 'DOWN')"
                 )
             ),
         )
@@ -295,8 +302,8 @@ class ListFloatingIP(common.NetworkAndComputeLister):
             metavar='<project>',
             help=self.enhance_help_neutron(
                 _(
-                    "List floating IP(s) according to given project "
-                    "(name or ID) "
+                    "List only floating IP(s) with the specified project "
+                    "(name or ID)"
                 )
             ),
         )
@@ -308,7 +315,7 @@ class ListFloatingIP(common.NetworkAndComputeLister):
             action='append',
             help=self.enhance_help_neutron(
                 _(
-                    "List floating IP(s) according to given router "
+                    "List only floating IP(s) with the specified router "
                     "(name or ID) "
                     "(repeat option to fiter on multiple routers)"
                 )

openstackclient/network/v2/floating_ip_port_forwarding.py

@@ -16,10 +16,10 @@
 import logging
 import typing as ty
 
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.network import common
 
@@ -265,8 +265,8 @@ class ListFloatingIPPortForwarding(command.Lister):
             '--port',
             metavar='<port>',
             help=_(
-                "Filter the list result by the ID or name of "
-                "the internal network port"
+                "List only floating IP port forwardings with the "
+                "specified internal network port (name or ID)"
             ),
         )
         parser.add_argument(
@@ -274,14 +274,17 @@ class ListFloatingIPPortForwarding(command.Lister):
             metavar='<port-number>',
             dest='external_protocol_port',
             help=_(
-                "Filter the list result by the "
-                "protocol port number of the floating IP"
+                "List only floating IP port forwardings with the "
+                "specified external protocol port number"
             ),
         )
         parser.add_argument(
             '--protocol',
             metavar='<protocol>',
-            help=_("Filter the list result by the port protocol"),
+            help=_(
+                "List only floating IP port forwardings with the "
+                "specified protocol number"
+            ),
         )
 
         return parser

openstackclient/network/v2/ip_availability.py

@@ -14,9 +14,9 @@
 """IP Availability Info implementations"""
 
 from osc_lib.cli import format_columns
-from osc_lib.command import command
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 
@@ -47,14 +47,17 @@ class ListIPAvailability(command.Lister):
             metavar='<ip-version>',
             dest='ip_version',
             help=_(
-                "List IP availability of given IP version "
-                "networks (default is 4)"
+                "List only IP availability with the specified IP version "
+                "networks (4 or 6, default is 4)"
             ),
         )
         parser.add_argument(
             '--project',
             metavar='<project>',
-            help=_("List IP availability of given project (name or ID)"),
+            help=_(
+                "List only IP availability with the specified project "
+                "(name or ID)"
+            ),
         )
         identity_common.add_project_domain_option_to_parser(parser)
         return parser

openstackclient/network/v2/l3_conntrack_helper.py

@@ -15,10 +15,10 @@
 
 import logging
 
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 LOG = logging.getLogger(__name__)
@@ -150,19 +150,26 @@ class ListConntrackHelper(command.Lister):
         parser.add_argument(
             '--helper',
             metavar='<helper>',
-            help=_('The netfilter conntrack helper module'),
+            help=_(
+                'List only helpers using the specified netfilter conntrack '
+                'helper module'
+            ),
         )
         parser.add_argument(
             '--protocol',
             metavar='<protocol>',
             help=_(
-                'The network protocol for the netfilter conntrack target rule'
+                'List only helpers with the specified network protocol for '
+                'the netfilter conntrack target rule'
             ),
         )
         parser.add_argument(
             '--port',
             metavar='<port>',
-            help=_('The network port for the netfilter conntrack target rule'),
+            help=_(
+                'List only helpers with the specified network port for '
+                'the netfilter conntrack target rule (name or ID)'
+            ),
         )
 
         return parser

openstackclient/network/v2/local_ip.py

@@ -17,10 +17,10 @@
 
 import logging
 
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 
@@ -198,32 +198,38 @@ class ListLocalIP(command.Lister):
         parser.add_argument(
             '--name',
             metavar='<name>',
-            help=_("List only Local IPs of given name in output"),
+            help=_("List only local IP(s) with the specified name"),
         )
         parser.add_argument(
             '--project',
             metavar="<project>",
-            help=_("List Local IPs according to their project (name or ID)"),
+            help=_(
+                "List only local IP(s) with the specified project (name or ID)"
+            ),
         )
         parser.add_argument(
             '--network',
             metavar='<network>',
-            help=_("List Local IP(s) according to given network (name or ID)"),
+            help=_(
+                "List only local IP(s) with the specified 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 only local IP(s) with the specified 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 only local IP(s) with the specified IP address"),
         )
         parser.add_argument(
             '--ip-mode',
             metavar='<ip_mode>',
-            help=_("List Local IP(s) according to given IP mode"),
+            help=_("List only local IP(s) with the specified IP mode"),
         )
 
         identity_common.add_project_domain_option_to_parser(parser)

openstackclient/network/v2/local_ip_association.py

@@ -17,10 +17,10 @@
 
 import logging
 
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 
@@ -150,18 +150,21 @@ class ListLocalIPAssociation(command.Lister):
             '--fixed-port',
             metavar='<fixed-port>',
             help=_(
-                "Filter the list result by the ID or name of the fixed port"
+                "List only local IP assocations with the specified fixed IP "
+                "port (name or ID)"
             ),
         )
         parser.add_argument(
             '--fixed-ip',
             metavar='<fixed-ip>',
-            help=_("Filter the list result by fixed ip"),
+            help=_(
+                "List only local IP associations with the specified fixed IP"
+            ),
         )
         parser.add_argument(
             '--host',
             metavar='<host>',
-            help=_("Filter the list result by given host"),
+            help=_("List only local IP associations with the specified host"),
         )
         identity_common.add_project_domain_option_to_parser(parser)
 

openstackclient/network/v2/ndp_proxy.py

@@ -17,10 +17,10 @@
 
 import logging
 
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 
@@ -143,30 +143,37 @@ class ListNDPProxy(command.Lister):
             '--router',
             metavar='<router>',
             help=_(
-                "List only NDP proxies belonging to this router (name or ID)"
+                "List only NDP proxies associated with the specifed router "
+                "(name or ID)"
             ),
         )
         parser.add_argument(
             '--port',
             metavar='<port>',
             help=_(
-                "List only NDP proxies associated to this port (name or ID)"
+                "List only NDP proxies associated with the specified port "
+                "(name or ID)"
             ),
         )
         parser.add_argument(
             '--ip-address',
             metavar='<ip-address>',
-            help=_("List only NDP proxies associated to this IPv6 address"),
+            help=_(
+                "List only NDP proxies associated with the specified "
+                "IPv6 address"
+            ),
         )
         parser.add_argument(
             '--project',
             metavar='<project>',
-            help=_("List only NDP proxies of given project (name or ID)"),
+            help=_(
+                "List only NDP proxies with the specified project (name or ID)"
+            ),
         )
         parser.add_argument(
             '--name',
             metavar='<name>',
-            help=_("List only NDP proxies of given name"),
+            help=_("List only NDP proxies with the specified name"),
         )
 
         identity_common.add_project_domain_option_to_parser(parser)

openstackclient/network/v2/network.py

@@ -24,12 +24,12 @@ from openstackclient.identity import common as identity_common
 from openstackclient.network import common
 
 
-class AdminStateColumn(cliff_columns.FormattableColumn):
+class AdminStateColumn(cliff_columns.FormattableColumn[bool]):
     def human_readable(self):
         return 'UP' if self._value else 'DOWN'
 
 
-class RouterExternalColumn(cliff_columns.FormattableColumn):
+class RouterExternalColumn(cliff_columns.FormattableColumn[bool]):
     def human_readable(self):
         return 'External' if self._value else 'Internal'
 
@@ -401,6 +401,16 @@ class CreateNetwork(
             )
             raise exceptions.CommandError(msg)
 
+        if (
+            parsed_args.segmentation_id
+            and not parsed_args.provider_network_type
+        ):
+            msg = _(
+                "--provider-segment requires --provider-network-type "
+                "to be specified."
+            )
+            raise exceptions.CommandError(msg)
+
         attrs.update(
             self._parse_extra_properties(parsed_args.extra_properties)
         )
@@ -459,12 +469,12 @@ class ListNetwork(common.NetworkAndComputeLister):
         router_ext_group.add_argument(
             '--external',
             action='store_true',
-            help=self.enhance_help_neutron(_("List external networks")),
+            help=self.enhance_help_neutron(_("List only external networks")),
         )
         router_ext_group.add_argument(
             '--internal',
             action='store_true',
-            help=self.enhance_help_neutron(_("List internal networks")),
+            help=self.enhance_help_neutron(_("List only internal networks")),
         )
         parser.add_argument(
             '--long',
@@ -477,24 +487,26 @@ class ListNetwork(common.NetworkAndComputeLister):
             '--name',
             metavar='<name>',
             help=self.enhance_help_neutron(
-                _("List networks according to their name")
+                _("List only networks with the specified name")
             ),
         )
         admin_state_group = parser.add_mutually_exclusive_group()
         admin_state_group.add_argument(
             '--enable',
             action='store_true',
-            help=self.enhance_help_neutron(_("List enabled networks")),
+            help=self.enhance_help_neutron(_("List only enabled networks")),
         )
         admin_state_group.add_argument(
             '--disable',
             action='store_true',
-            help=self.enhance_help_neutron(_("List disabled networks")),
+            help=self.enhance_help_neutron(_("List only disabled networks")),
         )
         parser.add_argument(
             '--project',
             metavar='<project>',
-            help=_("List networks according to their project (name or ID)"),
+            help=_(
+                "List only networks with the specified project (name or ID)"
+            ),
         )
         identity_common.add_project_domain_option_to_parser(
             parser, enhance_help=self.enhance_help_neutron
@@ -504,14 +516,14 @@ class ListNetwork(common.NetworkAndComputeLister):
             '--share',
             action='store_true',
             help=self.enhance_help_neutron(
-                _("List networks shared between projects")
+                _("List only networks shared between projects")
             ),
         )
         shared_group.add_argument(
             '--no-share',
             action='store_true',
             help=self.enhance_help_neutron(
-                _("List networks not shared between projects")
+                _("List only networks not shared between projects")
             ),
         )
         parser.add_argument(
@@ -520,7 +532,7 @@ class ListNetwork(common.NetworkAndComputeLister):
             choices=['ACTIVE', 'BUILD', 'DOWN', 'ERROR'],
             help=self.enhance_help_neutron(
                 _(
-                    "List networks according to their status "
+                    "List only networks with the specified status "
                     "('ACTIVE', 'BUILD', 'DOWN', 'ERROR')"
                 )
             ),
@@ -531,7 +543,8 @@ class ListNetwork(common.NetworkAndComputeLister):
             choices=['flat', 'geneve', 'gre', 'local', 'vlan', 'vxlan'],
             help=self.enhance_help_neutron(
                 _(
-                    "List networks according to their physical mechanisms. "
+                    "List only networks with the specified physical "
+                    "mechanisms. "
                     "The supported options are: flat, geneve, gre, local, "
                     "vlan and vxlan."
                 )
@@ -542,7 +555,10 @@ class ListNetwork(common.NetworkAndComputeLister):
             metavar='<provider-physical-network>',
             dest='physical_network',
             help=self.enhance_help_neutron(
-                _("List networks according to name of the physical network")
+                _(
+                    "List only networks with the specified physical network "
+                    "name"
+                )
             ),
         )
         parser.add_argument(
@@ -551,8 +567,9 @@ class ListNetwork(common.NetworkAndComputeLister):
             dest='segmentation_id',
             help=self.enhance_help_neutron(
                 _(
-                    "List networks according to VLAN ID for VLAN networks or "
-                    "Tunnel ID for GENEVE/GRE/VXLAN networks"
+                    "List only networks with the specified provider segment "
+                    "ID (VLAN ID for VLAN networks or "
+                    "Tunnel ID for GENEVE/GRE/VXLAN networks)"
                 )
             ),
         )
@@ -561,7 +578,7 @@ class ListNetwork(common.NetworkAndComputeLister):
             metavar='<agent-id>',
             dest='agent_id',
             help=self.enhance_help_neutron(
-                _('List networks hosted by agent (ID only)')
+                _('List only networks hosted the specified agent (ID only)')
             ),
         )
         _tag.add_tag_filtering_option_to_parser(

openstackclient/network/v2/network_agent.py

@@ -17,21 +17,21 @@ import logging
 
 from cliff import columns as cliff_columns
 from osc_lib.cli import format_columns
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 LOG = logging.getLogger(__name__)
 
 
-class AliveColumn(cliff_columns.FormattableColumn):
+class AliveColumn(cliff_columns.FormattableColumn[bool]):
     def human_readable(self):
         return ":-)" if self._value else "XXX"
 
 
-class AdminStateColumn(cliff_columns.FormattableColumn):
+class AdminStateColumn(cliff_columns.FormattableColumn[bool]):
     def human_readable(self):
         return 'UP' if self._value else 'DOWN'
 
@@ -205,12 +205,12 @@ class ListNetworkAgent(command.Lister):
         agent_type_group.add_argument(
             '--network',
             metavar='<network>',
-            help=_('List agents hosting a network (name or ID)'),
+            help=_('List agents hosting the specified network (name or ID)'),
         )
         agent_type_group.add_argument(
             '--router',
             metavar='<router>',
-            help=_('List agents hosting this router (name or ID)'),
+            help=_('List agents hosting the specified router (name or ID)'),
         )
         parser.add_argument(
             '--long',

openstackclient/network/v2/network_auto_allocated_topology.py

@@ -15,9 +15,9 @@
 
 import logging
 
-from osc_lib.command import command
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 

openstackclient/network/v2/network_flavor.py

@@ -15,10 +15,10 @@
 
 import logging
 
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 from openstackclient.network import common

openstackclient/network/v2/network_flavor_profile.py

@@ -13,10 +13,10 @@
 
 import logging
 
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.network import common
 

openstackclient/network/v2/network_meter.py

@@ -15,10 +15,10 @@
 
 import logging
 
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 from openstackclient.network import common

openstackclient/network/v2/network_meter_rule.py

@@ -16,10 +16,10 @@
 import logging
 import typing as ty
 
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 from openstackclient.network import common