network: Add '--marker', '--limit' to most list commands

As noted in the neutron API reference guide [1]:

  To reduce load on the service, list operations will return a maximum
  number of items at a time. To navigate the collection, the parameters
  limit, marker and page_reverse can be set in the URI.

Take advantage of the common pagination helpers introduced in change
I551bb4c3ff0568c6df5244a1d0f0669497bee58f to expose this functionality
to end users.

[1] https://docs.openstack.org/api-ref/network/v2/#pagination

Change-Id: Idea9c995ad412efdc11ecb64baaece6ab35cbb48
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>

Author: stephenfin

openstackclient/network/v2/address_group.py

@@ -23,6 +23,7 @@
 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
 from openstackclient.network import common
@@ -169,6 +170,7 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
             ),
         )
         identity_common.add_project_domain_option_to_parser(parser)
+        pagination.add_marker_pagination_option_to_parser(parser)
 
         return parser
 
@@ -201,6 +203,11 @@ def take_action(
                 parsed_args.project_domain,
             ).id
             attrs['project_id'] = project_id
+        if parsed_args.marker is not None:
+            attrs['marker'] = parsed_args.marker
+        if parsed_args.limit is not None:
+            attrs['limit'] = parsed_args.limit
+
         data = client.address_groups(**attrs)
 
         return (

openstackclient/network/v2/address_scope.py

@@ -22,6 +22,7 @@
 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
 from openstackclient.network import common
@@ -185,7 +186,7 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
             ),
         )
         identity_common.add_project_domain_option_to_parser(parser)
-
+        pagination.add_marker_pagination_option_to_parser(parser)
         shared_group = parser.add_mutually_exclusive_group()
         shared_group.add_argument(
             '--share',
@@ -197,6 +198,7 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
             action='store_true',
             help=_("List only address scopes not shared between projects"),
         )
+
         return parser
 
     def take_action(
@@ -234,6 +236,10 @@ def take_action(
                 parsed_args.project_domain,
             ).id
             attrs['project_id'] = project_id
+        if parsed_args.marker is not None:
+            attrs['marker'] = parsed_args.marker
+        if parsed_args.limit is not None:
+            attrs['limit'] = parsed_args.limit
         data = client.address_scopes(**attrs)
 
         return (

openstackclient/network/v2/floating_ip.py

@@ -24,6 +24,7 @@
 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
@@ -308,6 +309,7 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
             default=False,
             help=_("List additional fields in output"),
         )
+        pagination.add_marker_pagination_option_to_parser(parser)
         return parser
 
     def take_action(
@@ -395,6 +397,10 @@ def take_action(
                 ).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
 
         _tag.get_tag_filtering_args(parsed_args, query)
 

openstackclient/network/v2/floating_ip_port_forwarding.py

@@ -22,6 +22,7 @@
 from osc_lib import utils
 
 from openstackclient import command
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.network import common
 
@@ -294,7 +295,7 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
                 "specified protocol number"
             ),
         )
-
+        pagination.add_marker_pagination_option_to_parser(parser)
         return parser
 
     def take_action(
@@ -340,6 +341,10 @@ def take_action(
                 )
         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
 
         obj = client.find_ip(
             parsed_args.floating_ip,

openstackclient/network/v2/ip_availability.py

@@ -21,6 +21,7 @@
 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
 
@@ -62,6 +63,7 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
             ),
         )
         identity_common.add_project_domain_option_to_parser(parser)
+        pagination.add_marker_pagination_option_to_parser(parser)
         return parser
 
     def take_action(
@@ -85,7 +87,6 @@ def take_action(
         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(
@@ -94,6 +95,11 @@ def take_action(
                 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
+
         data = client.network_ip_availabilities(**filters)
         return (
             column_headers,

openstackclient/network/v2/l3_conntrack_helper.py

@@ -22,6 +22,7 @@
 from osc_lib import utils
 
 from openstackclient import command
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 
 LOG = logging.getLogger(__name__)
@@ -176,6 +177,7 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
                 'the netfilter conntrack target rule (name or ID)'
             ),
         )
+        pagination.add_marker_pagination_option_to_parser(parser)
 
         return parser
 
@@ -197,7 +199,13 @@ def take_action(
             '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
+
         data = client.conntrack_helpers(attrs.pop('router_id'), **attrs)
 
         return (

openstackclient/network/v2/network.py

@@ -24,6 +24,7 @@
 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
@@ -538,6 +539,7 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
             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(
@@ -650,6 +652,11 @@ def take_action(
             args['provider:segmentation_id'] = parsed_args.segmentation_id
             args['provider_segmentation_id'] = parsed_args.segmentation_id
 
+        if parsed_args.marker is not None:
+            args['marker'] = parsed_args.marker
+        if parsed_args.limit is not None:
+            args['limit'] = parsed_args.limit
+
         _tag.get_tag_filtering_args(parsed_args, args)
 
         data = client.networks(**args)

openstackclient/network/v2/network_agent.py

@@ -24,6 +24,7 @@
 from osc_lib import utils
 
 from openstackclient import command
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 
 LOG = logging.getLogger(__name__)
@@ -246,6 +247,7 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
             default=False,
             help=_("List additional fields in output"),
         )
+        pagination.add_marker_pagination_option_to_parser(parser)
 
         return parser
 
@@ -273,6 +275,10 @@ def take_action(
         )
 
         filters = {}
+        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.network is not None:
             network = client.find_network(

openstackclient/network/v2/network_flavor.py

@@ -22,6 +22,7 @@
 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
 from openstackclient.network import common
@@ -190,6 +191,11 @@ def take_action(self, parsed_args: argparse.Namespace) -> None:
 class ListNetworkFlavor(command.Lister):
     _description = _("List network flavors")
 
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
+        pagination.add_marker_pagination_option_to_parser(parser)
+        return parser
+
     def take_action(
         self, parsed_args: argparse.Namespace
     ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
@@ -204,7 +210,13 @@ def take_action(
             'Description',
         )
 
-        data = client.flavors()
+        filters = {}
+        if parsed_args.marker is not None:
+            filters['marker'] = parsed_args.marker
+        if parsed_args.limit is not None:
+            filters['limit'] = parsed_args.limit
+
+        data = client.flavors(**filters)
         return (
             column_headers,
             (

openstackclient/network/v2/network_flavor_profile.py

@@ -20,6 +20,7 @@
 from osc_lib import utils
 
 from openstackclient import command
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.network import common
 
@@ -159,6 +160,11 @@ def take_action(self, parsed_args: argparse.Namespace) -> None:
 class ListNetworkFlavorProfile(command.Lister):
     _description = _("List network flavor profile(s)")
 
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
+        pagination.add_marker_pagination_option_to_parser(parser)
+        return parser
+
     def take_action(
         self, parsed_args: argparse.Namespace
     ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
@@ -179,7 +185,14 @@ def take_action(
             'Description',
         )
 
-        data = client.service_profiles()
+        filters = {}
+        if parsed_args.marker is not None:
+            filters['marker'] = parsed_args.marker
+        if parsed_args.limit is not None:
+            filters['limit'] = parsed_args.limit
+
+        data = client.service_profiles(**filters)
+
         return (
             column_headers,
             (