python-openstackclient 10.0.0__py3-none-any.whl → 10.1.0__py3-none-any.whl

openstackclient/network/v2/floating_ip.py

@@ -18,12 +18,14 @@ import logging
 from typing import Any
 
 from openstack import exceptions as sdk_exceptions
+from openstack.network.v2 import floating_ip as _floating_ip
 from osc_lib.cli import format_columns
 from osc_lib import exceptions
 from osc_lib import utils
 from osc_lib.utils import tags as _tag
 
 from openstackclient import command
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 from openstackclient.network import common
@@ -35,7 +37,9 @@ _formatters = {
 }
 
 
-def _get_network_columns(item: Any) -> tuple[tuple[str, ...], tuple[str, ...]]:
+def _get_network_columns(
+    item: _floating_ip.FloatingIP,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     hidden_columns = ['location', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
         item, {}, hidden_columns
@@ -231,9 +235,6 @@ class DeleteFloatingIP(command.Command):
 
 
 class ListFloatingIP(command.Lister):
-    # TODO(songminglong): Use SDK resource mapped attribute names once
-    # the OSC minimum requirements include SDK 1.0
-
     _description = _("List floating IP(s)")
 
     def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
@@ -311,6 +312,7 @@ class ListFloatingIP(command.Lister):
             default=False,
             help=_("List additional fields in output"),
         )
+        pagination.add_marker_pagination_option_to_parser(parser)
         return parser
 
     def take_action(
@@ -398,6 +400,12 @@ class ListFloatingIP(command.Lister):
                 ).id
                 router_ids.append(router_id)
             query['router_id'] = router_ids
+        if parsed_args.marker is not None:
+            query['marker'] = parsed_args.marker
+        if parsed_args.limit is not None:
+            query['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            query['max_items'] = parsed_args.max_items
 
         _tag.get_tag_filtering_args(parsed_args, query)
 

openstackclient/network/v2/floating_ip_port_forwarding.py

@@ -18,10 +18,12 @@ import logging
 from collections.abc import Iterable, Sequence
 from typing import Any
 
+from openstack.network.v2 import port_forwarding as _port_forwarding
 from osc_lib import exceptions
 from osc_lib import utils
 
 from openstackclient import command
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.network import common
 
@@ -91,7 +93,9 @@ def validate_port(port: int) -> None:
         raise exceptions.CommandError(msg)
 
 
-def _get_columns(item: Any) -> tuple[tuple[str, ...], tuple[str, ...]]:
+def _get_columns(
+    item: _port_forwarding.PortForwarding,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     hidden_columns = ['location', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
         item, {}, hidden_columns
@@ -294,7 +298,7 @@ class ListFloatingIPPortForwarding(command.Lister):
                 "specified protocol number"
             ),
         )
-
+        pagination.add_marker_pagination_option_to_parser(parser)
         return parser
 
     def take_action(
@@ -340,6 +344,12 @@ class ListFloatingIPPortForwarding(command.Lister):
                 )
         if parsed_args.protocol is not None:
             query['protocol'] = parsed_args.protocol
+        if parsed_args.marker is not None:
+            query['marker'] = parsed_args.marker
+        if parsed_args.limit is not None:
+            query['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            query['max_items'] = parsed_args.max_items
 
         obj = client.find_ip(
             parsed_args.floating_ip,

openstackclient/network/v2/fwaas/group.py

@@ -60,7 +60,6 @@ _attr_map_dict = {x[0]: x[1] for x in _attr_map}
 def _get_common_parser(
     parser: argparse.ArgumentParser,
 ) -> argparse.ArgumentParser:
-    parser.add_argument('--name', help=_('Name for the firewall group'))
     parser.add_argument(
         '--description',
         metavar='<description>',
@@ -184,6 +183,23 @@ class CreateFirewallGroup(command.ShowOne):
     def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         _get_common_parser(parser)
+        # TODO(slaweq): Remove the deprecated --name option and make the
+        # positional name argument required (remove nargs='?') once the
+        # deprecation period is over.
+        parser.add_argument(
+            'positional_name',
+            nargs='?',
+            metavar='<name>',
+            default=None,
+            help=_('Name for the firewall group'),
+        )
+        parser.add_argument(
+            '--name',
+            help=_(
+                '(Deprecated, please pass name as a positional argument) '
+                'Name for the firewall group'
+            ),
+        )
         identity_utils.add_project_owner_option_to_parser(parser)
         port_group = parser.add_mutually_exclusive_group()
         port_group.add_argument(
@@ -207,6 +223,22 @@ class CreateFirewallGroup(command.ShowOne):
         self, parsed_args: argparse.Namespace
     ) -> tuple[Sequence[str], Iterable[Any]]:
         client = self.app.client_manager.network
+        # TODO(slaweq): Remove this --name deprecation handling once the
+        # deprecation period is over.
+        if parsed_args.positional_name and parsed_args.name:
+            msg = _(
+                "Cannot specify name as both a positional argument "
+                "and with the --name option."
+            )
+            raise exceptions.CommandError(msg)
+        if parsed_args.name:
+            LOG.warning(
+                'The --name option is deprecated for the "firewall group '
+                'create" command, please pass the name as a positional '
+                'argument instead.'
+            )
+        elif parsed_args.positional_name:
+            parsed_args.name = parsed_args.positional_name
         attrs = _get_common_attrs(self.app.client_manager, parsed_args)
         if 'project' in parsed_args and parsed_args.project is not None:
             attrs['project_id'] = identity_common.find_project(
@@ -300,6 +332,7 @@ class SetFirewallGroup(command.Command):
             metavar='<firewall-group>',
             help=_('Firewall group to update (name or ID)'),
         )
+        parser.add_argument('--name', help=_('Name for the firewall group'))
         parser.add_argument(
             '--port',
             metavar='<port>',

openstackclient/network/v2/fwaas/rule.py

@@ -74,9 +74,6 @@ def _convert_to_lowercase(string: str) -> str:
 def _get_common_parser(
     parser: argparse.ArgumentParser,
 ) -> argparse.ArgumentParser:
-    parser.add_argument(
-        '--name', metavar='<name>', help=_('Name of the firewall rule')
-    )
     parser.add_argument(
         '--description',
         metavar='<description>',
@@ -288,6 +285,24 @@ class CreateFirewallRule(command.ShowOne):
     def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         _get_common_parser(parser)
+        # TODO(slaweq): Remove the deprecated --name option and make the
+        # positional name argument required (remove nargs='?') once the
+        # deprecation period is over.
+        parser.add_argument(
+            'positional_name',
+            nargs='?',
+            metavar='<name>',
+            default=None,
+            help=_('Name of the firewall rule'),
+        )
+        parser.add_argument(
+            '--name',
+            metavar='<name>',
+            help=_(
+                '(Deprecated, please pass name as a positional argument) '
+                'Name of the firewall rule'
+            ),
+        )
         identity_utils.add_project_owner_option_to_parser(parser)
         return parser
 
@@ -295,6 +310,22 @@ class CreateFirewallRule(command.ShowOne):
         self, parsed_args: argparse.Namespace
     ) -> tuple[Sequence[str], Iterable[Any]]:
         client = self.app.client_manager.network
+        # TODO(slaweq): Remove this --name deprecation handling once the
+        # deprecation period is over.
+        if parsed_args.positional_name and parsed_args.name:
+            msg = _(
+                "Cannot specify name as both a positional argument "
+                "and with the --name option."
+            )
+            raise exceptions.CommandError(msg)
+        if parsed_args.name:
+            LOG.warning(
+                'The --name option is deprecated for the "firewall group '
+                'rule create" command, please pass the name as a positional '
+                'argument instead.'
+            )
+        elif parsed_args.positional_name:
+            parsed_args.name = parsed_args.positional_name
         attrs = _get_common_attrs(self.app.client_manager, parsed_args)
         if 'project' in parsed_args and parsed_args.project is not None:
             attrs['project_id'] = identity_common.find_project(
@@ -415,6 +446,11 @@ class SetFirewallRule(command.Command):
             metavar='<firewall-rule>',
             help=_('Firewall rule to set (name or ID)'),
         )
+        parser.add_argument(
+            '--name',
+            metavar='<name>',
+            help=_('Name of the firewall rule'),
+        )
         return parser
 
     def take_action(self, parsed_args: argparse.Namespace) -> None:

openstackclient/network/v2/ip_availability.py

@@ -17,10 +17,12 @@ import argparse
 from collections.abc import Iterable, Sequence
 from typing import Any
 
+from openstack.network.v2 import network_ip_availability as _ip_availability
 from osc_lib.cli import format_columns
 from osc_lib import utils
 
 from openstackclient import command
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 
@@ -29,15 +31,15 @@ _formatters = {
 }
 
 
-def _get_columns(item: Any) -> tuple[tuple[str, ...], tuple[str, ...]]:
+def _get_columns(
+    item: _ip_availability.NetworkIPAvailability,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     hidden_columns = ['id', 'name', 'location', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
         item, {}, hidden_columns
     )
 
 
-# TODO(ankur-gupta-f): Use the SDK resource mapped attribute names once
-# the OSC minimum requirements include SDK 1.0.
 class ListIPAvailability(command.Lister):
     _description = _("List IP availability for network")
 
@@ -64,6 +66,7 @@ class ListIPAvailability(command.Lister):
             ),
         )
         identity_common.add_project_domain_option_to_parser(parser)
+        pagination.add_marker_pagination_option_to_parser(parser)
         return parser
 
     def take_action(
@@ -87,7 +90,6 @@ class ListIPAvailability(command.Lister):
         filters = {}
         if parsed_args.ip_version:
             filters['ip_version'] = parsed_args.ip_version
-
         if parsed_args.project:
             identity_client = self.app.client_manager.identity
             project_id = identity_common.find_project(
@@ -96,6 +98,13 @@ class ListIPAvailability(command.Lister):
                 parsed_args.project_domain,
             ).id
             filters['project_id'] = project_id
+        if parsed_args.marker is not None:
+            filters['marker'] = parsed_args.marker
+        if parsed_args.limit is not None:
+            filters['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            filters['max_items'] = parsed_args.max_items
+
         data = client.network_ip_availabilities(**filters)
         return (
             column_headers,

openstackclient/network/v2/l3_conntrack_helper.py

@@ -18,16 +18,20 @@ import logging
 from collections.abc import Iterable, Sequence
 from typing import Any
 
+from openstack.network.v2 import l3_conntrack_helper as _l3_conntrack_helper
 from osc_lib import exceptions
 from osc_lib import utils
 
 from openstackclient import command
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 
 LOG = logging.getLogger(__name__)
 
 
-def _get_columns(item: Any) -> tuple[tuple[str, ...], tuple[str, ...]]:
+def _get_columns(
+    item: _l3_conntrack_helper.ConntrackHelper,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     hidden_columns = ['location', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
         item, {}, hidden_columns
@@ -176,6 +180,7 @@ class ListConntrackHelper(command.Lister):
                 'the netfilter conntrack target rule (name or ID)'
             ),
         )
+        pagination.add_marker_pagination_option_to_parser(parser)
 
         return parser
 
@@ -197,7 +202,15 @@ class ListConntrackHelper(command.Lister):
             'Protocol',
             'Port',
         )
+
         attrs = _get_attrs(client, parsed_args)
+        if parsed_args.marker is not None:
+            attrs['marker'] = parsed_args.marker
+        if parsed_args.limit is not None:
+            attrs['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            attrs['max_items'] = parsed_args.max_items
+
         data = client.conntrack_helpers(attrs.pop('router_id'), **attrs)
 
         return (

openstackclient/network/v2/local_ip.py

@@ -20,6 +20,7 @@ import logging
 from collections.abc import Iterable, Sequence
 from typing import Any
 
+from openstack.network.v2 import local_ip as _local_ip
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -30,7 +31,9 @@ from openstackclient.identity import common as identity_common
 LOG = logging.getLogger(__name__)
 
 
-def _get_columns(item: Any) -> tuple[tuple[str, ...], tuple[str, ...]]:
+def _get_columns(
+    item: _local_ip.LocalIP,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     hidden_columns = ['location', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
         item, {}, hidden_columns

openstackclient/network/v2/local_ip_association.py

@@ -20,6 +20,7 @@ import logging
 from collections.abc import Iterable, Sequence
 from typing import Any
 
+from openstack.network.v2 import local_ip_association as _local_ip_association
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -30,7 +31,9 @@ from openstackclient.identity import common as identity_common
 LOG = logging.getLogger(__name__)
 
 
-def _get_columns(item: Any) -> tuple[tuple[str, ...], tuple[str, ...]]:
+def _get_columns(
+    item: _local_ip_association.LocalIPAssociation,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     hidden_columns = ['location', 'name', 'id', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
         item, {}, hidden_columns

openstackclient/network/v2/ndp_proxy.py

@@ -20,6 +20,7 @@ import logging
 from collections.abc import Iterable, Sequence
 from typing import Any
 
+from openstack.network.v2 import ndp_proxy as _ndp_proxy
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -31,7 +32,9 @@ from openstackclient.identity import common as identity_common
 LOG = logging.getLogger(__name__)
 
 
-def _get_columns(item: Any) -> tuple[tuple[str, ...], tuple[str, ...]]:
+def _get_columns(
+    item: _ndp_proxy.NDPProxy,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     hidden_columns = ['location']
     return utils.get_osc_show_columns_for_sdk_resource(
         item, {}, hidden_columns

openstackclient/network/v2/network.py

@@ -18,12 +18,14 @@ import logging
 from typing import Any
 
 from cliff import columns as cliff_columns
+from openstack.network.v2 import network as _network
 from osc_lib.cli import format_columns
 from osc_lib import exceptions
 from osc_lib import utils
 from osc_lib.utils import tags as _tag
 
 from openstackclient import command
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 from openstackclient.network import common
@@ -54,7 +56,9 @@ _formatters = {
 }
 
 
-def _get_columns_network(item: Any) -> tuple[tuple[str, ...], tuple[str, ...]]:
+def _get_columns_network(
+    item: _network.Network,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     column_map = {
         'subnet_ids': 'subnets',
         'is_admin_state_up': 'admin_state_up',
@@ -146,6 +150,13 @@ def _get_attrs_network(
         attrs['qos_policy_id'] = _qos_policy.id
     if 'no_qos_policy' in parsed_args and parsed_args.no_qos_policy:
         attrs['qos_policy_id'] = None
+
+    # Set pvlan
+    if parsed_args.pvlan:
+        attrs['pvlan'] = True
+    if parsed_args.no_pvlan:
+        attrs['pvlan'] = False
+
     # Update DNS network options
     if parsed_args.dns_domain is not None:
         attrs['dns_domain'] = parsed_args.dns_domain
@@ -208,8 +219,6 @@ def _add_additional_network_options(parser: argparse.ArgumentParser) -> None:
     )
 
 
-# TODO(sindhu): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class CreateNetwork(command.ShowOne, common.NeutronCommandWithExtraArgs):
     _description = _("Create new network")
 
@@ -348,6 +357,24 @@ class CreateNetwork(command.ShowOne, common.NeutronCommandWithExtraArgs):
             help=_("Disable VLAN QinQ (S-Tag ethtype 0x8a88) for the network"),
         )
 
+        pvlan_grp = parser.add_mutually_exclusive_group()
+        pvlan_grp.add_argument(
+            '--pvlan',
+            action='store_true',
+            help=_(
+                "Enable Private VLAN for the network "
+                "(PVLAN extension required)"
+            ),
+        )
+        pvlan_grp.add_argument(
+            '--no-pvlan',
+            action='store_true',
+            help=_(
+                "Disable Private VLAN for the network "
+                "(PVLAN extension required)"
+            ),
+        )
+
         _add_additional_network_options(parser)
         _tag.add_tag_option_to_parser_for_create(parser, _('network'))
         return parser
@@ -367,6 +394,11 @@ class CreateNetwork(command.ShowOne, common.NeutronCommandWithExtraArgs):
         if parsed_args.no_qinq_vlan:
             attrs['vlan_qinq'] = False
 
+        if parsed_args.pvlan:
+            attrs['pvlan'] = True
+        if parsed_args.no_pvlan:
+            attrs['pvlan'] = False
+
         if attrs.get('vlan_transparent') and attrs.get('vlan_qinq'):
             msg = _(
                 "--transparent-vlan and --qinq-vlan can not be both enabled "
@@ -374,6 +406,14 @@ class CreateNetwork(command.ShowOne, common.NeutronCommandWithExtraArgs):
             )
             raise exceptions.CommandError(msg)
 
+        if (
+            attrs.get('port_security_enabled') is False
+            and attrs.get('pvlan') is True
+        ):
+            msg = _(
+                "--disable-port-security and --pvlan can not be used together."
+            )
+            raise exceptions.CommandError(msg)
         if (
             parsed_args.segmentation_id
             and not parsed_args.provider_network_type
@@ -439,8 +479,6 @@ class DeleteNetwork(command.Command):
             raise exceptions.CommandError(msg)
 
 
-# TODO(sindhu): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class ListNetwork(command.Lister):
     _description = _("List networks")
 
@@ -542,6 +580,7 @@ class ListNetwork(command.Lister):
             help=_('List only networks hosted the specified agent (ID only)'),
         )
         _tag.add_tag_filtering_option_to_parser(parser, _('networks'))
+        pagination.add_marker_pagination_option_to_parser(parser)
         return parser
 
     def take_action(
@@ -576,7 +615,15 @@ class ListNetwork(command.Lister):
                 'Availability Zones',
                 'Tags',
             )
-        elif parsed_args.agent_id:
+        else:
+            columns = ('id', 'name', 'subnet_ids')
+            column_headers = (
+                'ID',
+                'Name',
+                'Subnets',
+            )
+
+        if parsed_args.agent_id:
             columns = ('id', 'name', 'subnet_ids')
             column_headers = (
                 'ID',
@@ -585,7 +632,6 @@ class ListNetwork(command.Lister):
             )
             client = self.app.client_manager.network
             dhcp_agent = client.get_agent(parsed_args.agent_id)
-            data = client.dhcp_agent_hosting_networks(dhcp_agent)
 
             return (
                 column_headers,
@@ -595,16 +641,9 @@ class ListNetwork(command.Lister):
                         columns,
                         formatters=_formatters,
                     )
-                    for s in data
+                    for s in client.dhcp_agent_hosting_networks(dhcp_agent)
                 ),
             )
-        else:
-            columns = ('id', 'name', 'subnet_ids')
-            column_headers = (
-                'ID',
-                'Name',
-                'Subnets',
-            )
 
         args = {}
 
@@ -653,9 +692,14 @@ class ListNetwork(command.Lister):
             args['provider:segmentation_id'] = parsed_args.segmentation_id
             args['provider_segmentation_id'] = parsed_args.segmentation_id
 
-        _tag.get_tag_filtering_args(parsed_args, args)
+        if parsed_args.marker is not None:
+            args['marker'] = parsed_args.marker
+        if parsed_args.limit is not None:
+            args['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            args['max_items'] = parsed_args.max_items
 
-        data = client.networks(**args)
+        _tag.get_tag_filtering_args(parsed_args, args)
 
         return (
             column_headers,
@@ -665,13 +709,11 @@ class ListNetwork(command.Lister):
                     columns,
                     formatters=_formatters,
                 )
-                for s in data
+                for s in client.networks(**args)
             ),
         )
 
 
-# TODO(sindhu): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class SetNetwork(common.NeutronCommandWithExtraArgs):
     _description = _("Set network properties")
 
@@ -770,6 +812,23 @@ class SetNetwork(common.NeutronCommandWithExtraArgs):
             action='store_true',
             help=_("Remove the QoS policy attached to this network"),
         )
+        pvlan_grp = parser.add_mutually_exclusive_group()
+        pvlan_grp.add_argument(
+            '--pvlan',
+            action='store_true',
+            help=_(
+                "Enable Private VLAN for the network. PVLAN extension "
+                "required."
+            ),
+        )
+        pvlan_grp.add_argument(
+            '--no-pvlan',
+            action='store_true',
+            help=_(
+                "Disable Private VLAN for the network (Default). "
+                "PVLAN extension required."
+            ),
+        )
         _tag.add_tag_option_to_parser_for_set(parser, _('network'))
         _add_additional_network_options(parser)
         return parser
@@ -782,6 +841,14 @@ class SetNetwork(common.NeutronCommandWithExtraArgs):
         attrs.update(
             self._parse_extra_properties(parsed_args.extra_properties)
         )
+        if (
+            attrs.get('port_security_enabled') is False
+            and attrs.get('pvlan') is True
+        ):
+            msg = _(
+                "--disable-port-security and --pvlan can not be used together."
+            )
+            raise exceptions.CommandError(msg)
         if attrs:
             with common.check_missing_extension_if_error(
                 self.app.client_manager.network, attrs