centralcli 5.2.2__tar.gz → 5.3.0__tar.gz

{centralcli-5.2.2 → centralcli-5.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: centralcli
-Version: 5.2.2
+Version: 5.3.0
 Summary: A CLI for interacting with Aruba Central (Cloud Management Platform).  Facilitates bulk imports, exports, reporting.  A handy tool if you have devices managed by Aruba Central.
 Home-page: https://github.com/Pack3tL0ss/central-api-cli
 License: MIT

{centralcli-5.2.2 → centralcli-5.3.0}/centralcli/cache.py

@@ -1086,7 +1086,7 @@ class Cache:
             err_console.print(":warning:  Invalid config")
             return
 
-        match = self.get_dev_identifier(incomplete, device_type="gw", completion=True)
+        match = self.get_dev_identifier(incomplete, dev_type="gw", completion=True)
 
         out = []
         if match:

{centralcli-5.2.2 → centralcli-5.3.0}/centralcli/central.py

@@ -4041,7 +4041,7 @@ class CentralApi(Session):
         self,
         serial_num: str,
         api: str = "V1",
-        offset: int = 0,
+        marker: str = None,
         limit: int = 100
     ) -> Response:
         """Get routes for a device.
@@ -4049,7 +4049,7 @@ class CentralApi(Session):
         Args:
             serial_num (str): Device serial number
             api (str, optional): API version (V0|V1), Defaults to V1.
-            offset (str, optional): Pagination offset.
+            marker (str, optional): Pagination offset.
             limit (int, optional): page size Defaults to 100.
 
         Returns:
@@ -4060,7 +4060,7 @@ class CentralApi(Session):
         params = {
             'device': serial_num,
             'api': api,
-            'marker': offset,
+            'marker': marker,
             'limit': limit
         }
 

{centralcli-5.2.2 → centralcli-5.3.0}/centralcli/cleaner.py

@@ -35,6 +35,7 @@ from centralcli.constants import DevTypes, StatusOptions, LLDPCapabilityTypes
 from centralcli.objects import DateTime
 from centralcli.models import CloudAuthUploadResponse
 
+TableFormat = Literal["json", "yaml", "csv", "rich", "tabulate"]
 
 def epoch_convert(func):
     @functools.wraps(func)
@@ -1359,16 +1360,15 @@ def get_client_roaming_history(data: List[dict]) -> List[dict]:
 
     return data
 
-def get_fw_version_list(data: List[dict], format: str = "rich") -> List[dict]:
+def get_fw_version_list(data: List[dict], format: TableFormat = "rich") -> List[dict]:
+    # Override default behavior of k, v formatter (default which implies rich will use unicode check mark for beta)
+    if format != "rich" and "release_status" in data[-1].keys():
+        _short_value["release_status"] = lambda v: "True" if "beta" in v.lower() else "False"
+
     data = [
         dict(short_value(k, d[k]) for k in d) for d in data
     ]
     data = strip_no_value(data)
-    if format != "rich" and data and "beta" in data[-1].keys():
-        data = [
-            {k: v.replace("\u2705", "True") for k, v in d.items()}
-            for d in data
-        ]
 
     return data
 
@@ -1590,7 +1590,7 @@ def show_ts_commands(data: Union[List[dict], dict],) -> Union[List[dict], dict]:
 
     return data
 
-def get_overlay_routes(data: Union[List[dict], dict], format: str = "rich", simplify: bool = True) -> Union[List[dict], dict]:
+def get_overlay_routes(data: Union[List[dict], dict], format: TableFormat = "rich", simplify: bool = True) -> Union[List[dict], dict]:
     if "routes" in data:
         data = data["routes"]
 
@@ -1624,7 +1624,6 @@ def get_overlay_routes(data: Union[List[dict], dict], format: str = "rich", simp
                     route = {**base, **route}
                 else:
                     route = {**{k: "" for k in base.keys()}, **route}
-                # outdata += [route]  # Put fields in desired order
                 outdata += [{k: route.get(k) for k in field_order if k in route.keys()}]  # Put fields in desired order
 
         if format == "rich" and data and "is_best" in outdata[-1].keys():
@@ -1633,16 +1632,8 @@ def get_overlay_routes(data: Union[List[dict], dict], format: str = "rich", simp
                 for d in outdata
             ]
 
-    _short_value["0.0.0.0"] = "0.0.0.0"  # OVERRIDE default
+    _short_value["0.0.0.0"] = "0.0.0.0"  # OVERRIDE default referenced by simple_kv_formatter.  Otherwise will replace with "-"
     data = simple_kv_formatter(outdata)
-    # data = simple_kv_formatter(
-    #     [
-    #         {
-    #             **{k: v for k, v in r.items() if k != "nexthop"},
-    #             "nexthop": [{k: v if k != "interface" else utils.unlistify(v) for k, v in hops.items()} for hops in r["nexthop"]]
-    #         } for r in data
-    #     ]
-    # )
 
     return data
 
@@ -1660,12 +1651,13 @@ def get_overlay_interfaces(data: Union[List[dict], dict]) -> Union[List[dict], d
 
     return simple_kv_formatter(data)
 
-def get_full_wlan_list(data: List[dict] | str | Dict, verbosity: int = 0) -> List[dict]:
+def get_full_wlan_list(data: List[dict] | str | Dict, verbosity: int = 0, format: TableFormat = "rich") -> List[dict]:
     if isinstance(data, list) and data and isinstance(data[0], str):
         data = json.loads(data[0])
     if isinstance(data, dict) and "wlans" in data:
         data = data["wlans"]
 
+    # TODO PlaceHolder logic, currently only support verbosity level 0
     verbosity_keys = {
         0: [
             'group',
@@ -1683,6 +1675,7 @@ def get_full_wlan_list(data: List[dict] | str | Dict, verbosity: int = 0) -> Lis
         ]
     }
     pretty_data = []
+
     # rf_band all is a legacy key so all means 2.4 and 5, this updates so that all is only the value if 6 is also enabled.
     # also grabs values for keys that are stored in dicts
     def _simplify_value(wlan: dict, k: str, v: Any) -> Any:
@@ -1704,6 +1697,10 @@ def get_full_wlan_list(data: List[dict] | str | Dict, verbosity: int = 0) -> Lis
             ssid_data["name"] = None
         pretty_data += [ssid_data]
 
+    # override default which swaps in unicode checkmark/X (for rich output)
+    if format != "rich" and "disable_ssid" in data[-1].keys():
+        _short_value["disable_ssid"] = lambda v: 'True' if not v else 'False'
+
     pretty_data = simple_kv_formatter(pretty_data)
     pretty_data = strip_no_value(pretty_data)
     return pretty_data

{centralcli-5.2.2 → centralcli-5.3.0}/centralcli/clibatch.py

@@ -1429,11 +1429,12 @@ def batch_delete_groups_or_labels(data: Union[list, dict], *, yes: bool = False,
 
 # FIXME The Loop logic keeps trying if a delete fails despite the device being offline, validate the error check logic
 # TODO batch delete sites does a call for each site, not multi-site endpoint?
-@app.command(short_help="Delete devices.", help=help_text.batch_delete_devices)
+# TODO make sub-command clibatchdelete.py seperate out sites devices...
+@app.command(short_help="Delete devices.",)
 def delete(
     what: BatchDelArgs = typer.Argument(..., show_default=False,),
     import_file: Path = typer.Argument(None, exists=True, readable=True, show_default=False, autocompletion=lambda incomplete: [],),
-    ui_only: bool = typer.Option(False, "--ui-only", help="Only delete device from UI/Monitoring views.  Devices remains assigned and licensed.  Devices must be offline."),
+    ui_only: bool = typer.Option(False, "--ui-only", help="Only delete device from UI/Monitoring views (devices must be offline).  Devices will remain in inventory with subscriptions unchanged."),
     cop_inv_only: bool = typer.Option(False, "--cop-only", help="Only delete device from CoP inventory.", hidden=True),
     dry_run: bool = typer.Option(False, "--dry-run", help="Testing/Debug Option", hidden=True),
     force: bool = typer.Option(False, "-F", "--force", help="Perform API calls based on input file without validating current states (valid for devices)"),
@@ -1456,7 +1457,17 @@ def delete(
         help="The Aruba Central Account to use (must be defined in the config)",
     ),
 ) -> None:
-    """Batch delete Aruba Central Objects [devices|sites|groups|labels] based on input from file.
+    """[bright_green]Perform batch Delete operations using import data from file.[/]
+
+    [cyan]cencli delete sites <IMPORT_FILE>[/] and
+    [cyan]cencli delte groups <IMPORT_FILE>[/]
+        Do what you'd expect.
+
+    [cyan]cencli batch delete devices <IMPORT_FILE>[/]
+
+    Delete devices will remove any subscriptions/licenses from the device and disassociate the device with the Aruba Central app in GreenLake.  It will then remove the device from the monitoring views, along with the historical data for the device.
+
+    Note: devices can only be removed from monitoring views if they are in a down state.  This command will delay/wait for any Up devices to go Down after the subscriptions/assignment to Central is removed, but it can also be ran again.  It will pick up where it left off, skipping any steps that have already been performed.
     """
     if show_example:
         print(getattr(examples, f"delete_{what}"))

{centralcli-5.2.2 → centralcli-5.3.0}/centralcli/clicommon.py

@@ -453,7 +453,7 @@ class CLICommon:
         data: Union[List[dict], List[str], dict, None] = None,
         tablefmt: TableFormat = "rich",
         title: str = None,
-        caption: str = None,
+        caption: str | List[str] = None,
         pager: bool = False,
         outfile: Path = None,
         sort_by: str = None,
@@ -481,7 +481,7 @@ class CLICommon:
                 clean bypasses all formatters.
             title: (str, optional): Title of output table.
                 Only applies to "rich" tablefmt. Defaults to None.
-            caption: (str, optional): Caption displayed at bottom of table.
+            caption: (str | List[str], optional): Caption displayed at bottom of table.
                 Only applies to "rich" tablefmt. Defaults to None.
             pager (bool, optional): Page Output / or not. Defaults to True.
             outfile (Path, optional): path/file of output file. Defaults to None.
@@ -497,6 +497,8 @@ class CLICommon:
             fold_cols (Union[List[str], str], optional): columns that will be folded (wrapped within the same column). Applies to tablfmt=rich. Defaults to [].
             cleaner (callable, optional): The Cleaner function to use.
         """
+        if isinstance(caption, list):
+            caption = "\n  ".join(caption)
         if resp is not None:
             resp = utils.listify(resp)
 

{centralcli-5.2.2 → centralcli-5.3.0}/centralcli/clishow.py

@@ -937,7 +937,7 @@ def interfaces(
         try:
             up = len([i for i in resp.output if i.get("status").lower() == "up"])
             down = len(resp.output) - up
-            caption += [f"  Counts: Total: [cyan]{len(resp.output)}[/], Up: [bright_green]{up}[/], Down: [bright_red]{down}[/]"]
+            caption += [f"Counts: Total: [cyan]{len(resp.output)}[/], Up: [bright_green]{up}[/], Down: [bright_red]{down}[/]"]
         except Exception as e:
             log.error(f"{e.__class__.__name__} while trying to get counts from {dev.name} interface output")
 
@@ -946,7 +946,7 @@ def interfaces(
         resp,
         tablefmt=tablefmt,
         title=title,
-        caption="\n".join(caption),
+        caption=caption,
         pager=pager,
         outfile=outfile,
         sort_by=sort_by,
@@ -990,8 +990,9 @@ def poe(
     caption = "  Power values are in watts."
     if resp:
         resp.output = utils.listify(resp.output)  # if they specify an interface output will be a single dict.
-        _delivering_count = len(list(filter(lambda i: i.get("poe_detection_status", 99) == 3, resp.output)))
-        caption = f"{caption}  Interfaces delivering power: [bright_green]{_delivering_count}[/]"
+        if not port:
+            _delivering_count = len(list(filter(lambda i: i.get("poe_detection_status", 99) == 3, resp.output)))
+            caption = f"{caption}  Interfaces delivering power: [bright_green]{_delivering_count}[/]"
         if "poe_slots" in resp.output[0] and resp.output[0]["poe_slots"]:  # CX has the key but it appears to always be an empty dict
             caption = f"{caption}\n  Switch Poe Capabilities (watts): Max: [cyan]{resp.output[0]['poe_slots'].get('maximum_power_in_watts', '?')}[/]"
             caption = f"{caption}, Draw: [cyan]{resp.output[0]['poe_slots'].get('power_drawn_in_watts', '?')}[/]"
@@ -1159,12 +1160,18 @@ def dhcp(
 
 @app.command(short_help="Show firmware upgrade status")
 def upgrade(
-    device: List[str] = typer.Argument(..., metavar=iden_meta.dev, hidden=False, autocompletion=cli.cache.dev_completion),
+    device: List[str] = typer.Argument(
+        ...,
+        metavar=iden_meta.dev,
+        hidden=False,
+        autocompletion=cli.cache.dev_completion,
+        show_default=False,
+    ),
     do_json: bool = typer.Option(False, "--json", is_flag=True, help="Output in JSON"),
     do_yaml: bool = typer.Option(False, "--yaml", is_flag=True, help="Output in YAML"),
     do_csv: bool = typer.Option(False, "--csv", is_flag=True, help="Output in CSV"),
     do_table: bool = typer.Option(False, "--table", help="Output in table format",),
-    outfile: Path = typer.Option(None, "--out", help="Output to file (and terminal)", writable=True),
+    outfile: Path = typer.Option(None, "--out", help="Output to file (and terminal)", writable=True, show_default=False),
     pager: bool = typer.Option(False, "--pager", help="Enable Paged Output"),
     update_cache: bool = typer.Option(False, "-U", hidden=True),  # Force Update of cli.cache for testing
     default: bool = typer.Option(False, "-d", is_flag=True, help="Use default central account", show_default=False,),
@@ -1571,7 +1578,7 @@ def lldp(
     Valid on APs and CX switches
 
     Use [cyan]cencli show aps -n --site <SITE>[/] to see lldp neighbors for all APs in a site.
-    NOTE: AOS-SW will return LLDP neighbors, but only it reports neighbors for connected Aruba devices managed in Central
+    NOTE: AOS-SW will return LLDP neighbors, but only reports neighbors for connected Aruba devices managed in Central
     """
     central = cli.central
 
@@ -1896,6 +1903,7 @@ def token(
 
 
 # TODO clean up output ... single line output
+# TODO restrict to GWs appears to only work on GW
 @app.command(short_help="Show device routing table")
 def routes(
     device: List[str] = typer.Argument(..., metavar=iden_meta.dev, autocompletion=cli.cache.dev_completion, show_default=False,),
@@ -1924,16 +1932,14 @@ def routes(
 
     tablefmt = cli.get_format(do_json=do_json, do_yaml=do_yaml, do_csv=do_csv, do_table=do_table, default="rich")
     resp = central.request(central.get_device_ip_routes, device.serial)
-    if "summary" in resp.output:
-        s = resp.summary
+    caption = ""
+    if "summary" in resp.raw:
+        s = resp.raw["summary"]
         caption = (
             f'max: {s.get("maximum")} total: {s.get("total")} default: {s.get("default")} connected: {s.get("connected")} '
             f'static: {s.get("static")} dynamic: {s.get("dynamic")} overlay: {s.get("overlay")} '
         )
-    else:
-        caption = ""
-    if "routes" in resp.output:
-        resp.output = resp.output["routes"]
+
 
     cli.display_results(
         resp,
@@ -2008,11 +2014,11 @@ def wlans(
         "calculate_client_count": True,
     }
 
-    # TODO only verbosity 0 currently if group is specified
     tablefmt = cli.get_format(do_json=do_json, do_yaml=do_yaml, do_csv=do_csv, do_table=do_table, default="rich")
-    if group:
-        resp = central.request(central.get_full_wlan_list, group)
-        cli.display_results(resp, sort_by=sort_by, reverse=reverse, tablefmt=tablefmt, title=title, pager=pager, outfile=outfile, cleaner=cleaner.get_full_wlan_list, verbosity=verbose)
+    if group:  # Specifying the group implies verbose (same # of API calls either way.)
+        resp = central.request(central.get_full_wlan_list, group)  # TODO have get_full_wlan_list covert to list of dicts
+        caption = None  # if not resp else f"[green]{len(resp.output)}[/] SSIDs configured in group [cyan]{group}[/]"  # It's a str need JSON.loads...
+        cli.display_results(resp, title=title, caption=caption, pager=pager, outfile=outfile, sort_by=sort_by, reverse=reverse, tablefmt=tablefmt, cleaner=cleaner.get_full_wlan_list, verbosity=verbose, format=tablefmt)
     elif verbose:
         import json
         group_res = central.request(central.get_groups_properties)
@@ -2039,10 +2045,14 @@ def wlans(
         else:
             resp = group_res
 
-        cli.display_results(resp, sort_by=sort_by, reverse=reverse, tablefmt=tablefmt, title=title, pager=pager, outfile=outfile, cleaner=cleaner.get_full_wlan_list, verbosity=0)
+        cli.display_results(resp, sort_by=sort_by, reverse=reverse, tablefmt=tablefmt, title=title, pager=pager, outfile=outfile, cleaner=cleaner.get_full_wlan_list, verbosity=verbose, format=tablefmt)
     else:
         resp = central.request(central.get_wlans, **params)
-        cli.display_results(resp, sort_by=sort_by, reverse=reverse, tablefmt=tablefmt, title=title, pager=pager, outfile=outfile, cleaner=cleaner.get_wlans)
+        caption = None
+        if resp:
+            caption = [f'[green]{len(resp.output)}[/] SSIDs,  [green]{sum([wlan.get("client_count", 0) for wlan in resp.output])}[/] Wireless Clients.']
+            caption += ["Summary Output, Specify the group ([cyan]--group GROUP[/])",  "or use the verbose flag ([cyan]`-v`[/]) for additional details"]
+        cli.display_results(resp, tablefmt=tablefmt, title=title, caption=caption, pager=pager, outfile=outfile, sort_by=sort_by, reverse=reverse, cleaner=cleaner.get_wlans)
 
 
 @app.command()
@@ -2141,12 +2151,6 @@ def clients(
     sort_by: SortClientOptions = typer.Option(None, "--sort", show_default=False, rich_help_panel="Formatting",),
     reverse: bool = typer.Option(False, "-r", help="Reverse output order", show_default=False, rich_help_panel="Formatting",),
     verbose: bool = typer.Option(False, "-v", help="additional details (vertically)", show_default=False, rich_help_panel="Formatting",),
-    verbose2: bool = typer.Option(
-        False,
-        "-vv",
-        help="Show raw response (no formatting but still honors --yaml, --csv ... if provided)",
-        show_default=False,
-    ),
     pager: bool = typer.Option(False, "--pager", help="Enable Paged Output",),
     default: bool = typer.Option(
         False, "-d",
@@ -2259,7 +2263,7 @@ def clients(
     tablefmt = cli.get_format(do_json, do_yaml, do_csv, do_table, default="rich" if not verbose else "yaml")
 
     verbose_kwargs = {}
-    if not verbose2 and not denylisted:
+    if not denylisted:
         verbose_kwargs["cleaner"] = cleaner.get_clients
         verbose_kwargs["cache"] = cli.cache
         verbose_kwargs["verbose"] = verbose
@@ -2284,7 +2288,7 @@ def clients(
         **verbose_kwargs
     )
 
-# TODO Sortby Enum
+
 @app.command()
 def tunnels(
     gateway: str = typer.Argument(..., metavar=iden_meta.dev, autocompletion=cli.cache.dev_gw_completion, case_sensitive=False, show_default=False,),

{centralcli-5.2.2 → centralcli-5.3.0}/centralcli/clishowaudit.py

@@ -46,12 +46,13 @@ def show_logs_cencli_callback(ctx: typer.Context, cencli: bool):
     return cencli
 
 
+# TODO remove verbose2 using --raw now
 @app.command(
     help="Show Audit Logs. Audit Logs will displays prior 5 days if no time options are provided.",
     short_help="Show Audit Logs (last 5 days default)",
 )
 def logs(
-    args: List[str] = typer.Argument(
+    log_id: str = typer.Argument(
         None,
         metavar='[LOG_ID]',
         help="Show details for a specific log_id",
@@ -111,13 +112,13 @@ def logs(
         autocompletion=cli.cache.account_completion,
     ),
 ) -> None:
-    if cencli or (args and args[-1] == "cencli"):
+    if cencli or (log_id and log_id[-1] == "cencli"):
         from centralcli import log
         log.print_file() if not tail else log.follow()
         raise typer.Exit(0)
 
-    if args:
-        log_id = cli.cache.get_log_identifier(args[-1])
+    if log_id:
+        log_id = cli.cache.get_log_identifier(log_id)
     else:
         log_id = None
         if device:

{centralcli-5.2.2 → centralcli-5.3.0}/centralcli/clishowospf.py

@@ -57,7 +57,7 @@ def neighbors(
     dev = cli.cache.get_dev_identifier(device)
     resp = central.request(central.get_ospf_neighbor, dev.serial)
     tablefmt = cli.get_format(do_json, do_yaml, do_csv, do_table, default="rich" if not verbose else "yaml")
-    cf = "[reset][italic dark_olive_green2]"
+    # cf = "[reset][italic dark_olive_green2]"
     caption = ""
 
     if resp.raw.get("summary"):
@@ -67,23 +67,20 @@ def neighbors(
             raise typer.Exit(0)
         else:
             caption = [
-                f'{cf} Router ID:[/] {summary["router_id"]} | {cf}OSPF Neigbors:[/] {summary["neighbor_count"]} | {cf}OSPF Interfaces:[/] {summary["interface_count"]}',
-                f'{cf}OSPF Areas:[/] {summary["area_count"]} | {cf}active LSA:[/] {summary["active_lsa_count"]} | {cf}rexmt LSA:[/] {summary["rexmt_lsa_count"]}'
+                f'[cyan]Router ID[/]: {summary["router_id"]} | [cyan]OSPF Neigbors[/]: {summary["neighbor_count"]} | [cyan]OSPF Interfaces[/]: {summary["interface_count"]}',
+                f'[cyan]OSPF Areas[/]: {summary["area_count"]} | [cyan]active LSA[/]: {summary["active_lsa_count"]} | [cyan]rexmt LSA[/]: {summary["rexmt_lsa_count"]}'
             ]
-            caption = "\n   ".join(caption)
 
-    title = f"{dev.name} OSPF Neighbors"
-
-    cli.display_results(\
+    cli.display_results(
         resp,
         tablefmt=tablefmt,
-        title=title,
+        title=f"{dev.name} OSPF Neighbors",
         pager=pager,
         outfile=outfile,
         sort_by=sort_by,
         reverse=reverse,
         cleaner=cleaner.get_ospf_neighbor if not verbose else None,
-        caption=f"{caption}\n"
+        caption=caption
     )
 
 
@@ -120,33 +117,29 @@ def interfaces(
     dev = cli.cache.get_dev_identifier(device)
     resp = central.request(central.get_ospf_interface, dev.serial)
     tablefmt = cli.get_format(do_json, do_yaml, do_csv, do_table, default="rich" if not verbose else "yaml")
-    cf = "[reset][italic dark_olive_green2]"
+    # cf = "[reset][italic dark_olive_green2]"
     caption = ""
 
     if resp.raw.get("summary"):
         summary = resp.raw["summary"]
         if summary["admin_status"] is False:
-            print(f"OSPF is not enabled on {dev.name}")
-            raise typer.Exit(0)
+            cli.exit(f"OSPF is not enabled on {dev.name}", code=0)
         else:
             caption = [
-                f'{cf} Router ID:[/] {summary["router_id"]} | {cf}OSPF Neigbors:[/] {summary["neighbor_count"]} | {cf}OSPF Interfaces:[/] {summary["interface_count"]}',
-                f'{cf}OSPF Areas:[/] {summary["area_count"]} | {cf}active LSA:[/] {summary["active_lsa_count"]} | {cf}rexmt LSA:[/] {summary["rexmt_lsa_count"]}'
+                f'[cyan]Router ID[/]: {summary["router_id"]} | [cyan]OSPF Neigbors[/]: {summary["neighbor_count"]} | [cyan]OSPF Interfaces[/]: {summary["interface_count"]}',
+                f'[cyan]OSPF Areas[/]: {summary["area_count"]} | [cyan]active LSA[/]: {summary["active_lsa_count"]} | [cyan]rexmt LSA[/]: {summary["rexmt_lsa_count"]}'
             ]
-            caption = "\n   ".join(caption)
-
-    title = f"{dev.name} OSPF Interfaces"
 
     cli.display_results(
         resp,
         tablefmt=tablefmt,
-        title=title,
+        title=f"{dev.name} OSPF Interfaces",
         pager=pager,
         outfile=outfile,
         sort_by=sort_by,
         reverse=reverse,
         cleaner=cleaner.get_ospf_interface if not verbose else None,
-        caption=f"{caption}\n",
+        caption=caption,
         full_cols=["ip/mask", "DR IP", "BDR IP", "DR rtr id", "BDR rtr id"]
     )
 
@@ -182,33 +175,29 @@ def area(
     dev = cli.cache.get_dev_identifier(device)
     resp = central.request(central.get_ospf_area, dev.serial)
     tablefmt = cli.get_format(do_json, do_yaml, do_csv, do_table, default="rich" if not verbose else "yaml")
-    cf = "[reset][italic dark_olive_green2]"
+    # cf = "[reset][italic dark_olive_green2]"
     caption = ""
 
     if resp.raw.get("summary"):
         summary = resp.raw["summary"]
         if summary["admin_status"] is False:
-            print(f"OSPF is not enabled on {dev.name}")
-            raise typer.Exit(0)
+            cli.exit(f"OSPF is not enabled on {dev.name}", code=0)
         else:
             caption = [
-                f'{cf} Router ID:[/] {summary["router_id"]} | {cf}OSPF Neigbors:[/] {summary["neighbor_count"]} | {cf}OSPF Interfaces:[/] {summary["interface_count"]}',
-                f'{cf}OSPF Areas:[/] {summary["area_count"]} | {cf}active LSA:[/] {summary["active_lsa_count"]} | {cf}rexmt LSA:[/] {summary["rexmt_lsa_count"]}'
+                f'[cyan]Router ID[/]: {summary["router_id"]} | [cyan]OSPF Neigbors[/]: {summary["neighbor_count"]} | [cyan]OSPF Interfaces[/]: {summary["interface_count"]}',
+                f'[cyan]OSPF Areas[/]: {summary["area_count"]} | [cyan]active LSA[/]: {summary["active_lsa_count"]} | [cyan]rexmt LSA[/]: {summary["rexmt_lsa_count"]}'
             ]
-            caption = "\n   ".join(caption)
-
-    title = f"{dev.name} OSPF Area Details"
 
     cli.display_results(
         resp,
         tablefmt=tablefmt,
-        title=title,
+        title=f"{dev.name} OSPF Area Details",
         pager=pager,
         outfile=outfile,
         sort_by=sort_by,
         reverse=reverse,
         cleaner=cleaner.get_ospf_neighbor if not verbose else None,  # ospf_neighbor cleaner is sufficient here
-        caption=f"{caption}\n",
+        caption=caption,
         full_cols=["ip/mask", "DR IP", "BDR IP", "DR rtr id", "BDR rtr id"]
     )
 
@@ -244,8 +233,9 @@ def database(
     dev = cli.cache.get_dev_identifier(device)
     resp = central.request(central.get_ospf_database, dev.serial)
     tablefmt = cli.get_format(do_json, do_yaml, do_csv, do_table, default="yaml")
-    cf = "[reset][italic dark_olive_green2]"
+    # cf = "[reset][italic dark_olive_green2]"
     caption = ""
+    pad = "  " if tablefmt == "yaml" else ""
 
     if resp.raw.get("summary"):
         summary = resp.raw["summary"]
@@ -254,23 +244,20 @@ def database(
             raise typer.Exit(0)
         else:
             caption = [
-                f'{cf} Router ID:[/] {summary["router_id"]} | {cf}OSPF Neigbors:[/] {summary["neighbor_count"]} | {cf}OSPF Interfaces:[/] {summary["interface_count"]}',
-                f'{cf}OSPF Areas:[/] {summary["area_count"]} | {cf}active LSA:[/] {summary["active_lsa_count"]} | {cf}rexmt LSA:[/] {summary["rexmt_lsa_count"]}'
+                f'[cyan]{pad}Router ID[/]: {summary["router_id"]} | [cyan]OSPF Neigbors[/]: {summary["neighbor_count"]} | [cyan]OSPF Interfaces[/]: {summary["interface_count"]}',
+                f'[cyan]OSPF Areas[/]: {summary["area_count"]} | [cyan]active LSA[/]: {summary["active_lsa_count"]} | [cyan]rexmt LSA[/]: {summary["rexmt_lsa_count"]}'
             ]
-            caption = "\n   ".join(caption)
-
-    title = f"{dev.name} OSPF Database Details"
 
     cli.display_results(
         resp,
         tablefmt=tablefmt,
-        title=title,
+        title=f"{dev.name} OSPF Database Details",
         pager=pager,
         outfile=outfile,
         sort_by=sort_by,
         reverse=reverse,
         cleaner=cleaner.get_ospf_neighbor if not verbose else None,  # ospf_neighbor cleaner is sufficient here
-        caption=f"{caption}\n",
+        caption=caption,
         full_cols=["ip/mask", "DR IP", "BDR IP", "DR rtr id", "BDR rtr id"]
     )
 

{centralcli-5.2.2 → centralcli-5.3.0}/centralcli/clishowoverlay.py

@@ -57,7 +57,6 @@ def _build_caption(resp: Response) -> str | None:
 
 @app.command()
 def routes(
-    # what: OverlayRoutesArgs = typer.Argument("learned", case_sensitive=False, show_default=True),
     device: str = typer.Argument(..., metavar=iden_meta.dev, autocompletion=cli.cache.dev_ap_gw_completion, show_default=False,),
     advertised: bool = typer.Option(False, "--advertised", "-a", help="Show advertised routes [grey42]\[default: show learned routes][/]"),
     best: bool = typer.Option(False, "--best", "-b", help="Return only best/preferred route for each destination"),
@@ -152,11 +151,10 @@ def interfaces(
     )
 
 
+# single entry output, no need to sort
 @app.command()
 def connection(
-    device: str = typer.Argument(..., metavar=iden_meta.dev, autocompletion=cli.cache.dev_ap_gw_completion, show_default=False,),
-    # sort_by: str = typer.Option(None, "--sort", help="Field to sort by", rich_help_panel="Formatting", show_default=False,),  # single entry output, no need to sort
-    # reverse: bool = typer.Option(False, "-r", is_flag=True, help="Sort in descending order", rich_help_panel="Formatting"),
+    device: str = typer.Argument(..., metavar=iden_meta.dev, autocompletion=cli.cache.dev_gw_completion, show_default=False,),
     do_json: bool = typer.Option(False, "--json", is_flag=True, help="Output in JSON", rich_help_panel="Formatting"),
     do_yaml: bool = typer.Option(False, "--yaml", is_flag=True, help="Output in YAML", rich_help_panel="Formatting"),
     do_csv: bool = typer.Option(False, "--csv", is_flag=True, help="Output in CSV", rich_help_panel="Formatting"),
@@ -173,25 +171,28 @@ def connection(
         rich_help_panel="Common Options",
     ),
 ):
-    """Show overlay connection (OTO/ORO) details (GWs & APs)
+    """Show overlay connection (OTO/ORO) details (Valid on SD-Branch GWs/ VPNCs Only)
 
-    In testing this API endpoint always returned an error (request to ce failed... timed out) for APs.
-    You can get similar details using [cyan]cencli tshoot overlay DEVICE[/].
+    For additional details use [cyan]cencli tshoot overlay DEVICE[/] (which also works on APs).
     """
-    dev = cli.cache.get_dev_identifier(device, dev_type=("gw", "ap",))
+    dev = cli.cache.get_dev_identifier(device, dev_type="gw")
     tablefmt = cli.get_format(do_json=do_json, do_yaml=do_yaml, do_csv=do_csv, do_table=do_table, default="rich")
 
     resp = cli.central.request(cli.central.get_overlay_connection, dev.serial)
 
-    set_width_cols = {"name": 60}
+    set_width_cols = {}
     caption = None
     if "connection" in resp.output:
         resp.output = resp.output["connection"]
         caption=_build_caption(resp)
-    elif "summary" in resp.output:
+    elif "summary" in resp.output:  # For Mobility GWs this endpoint only shows Overlay for SD-Branch
         resp.output = resp.output["summary"]
         if resp.output.get("admin_status") is False:
-            set_width_cols = {"admin status": {"min": 55, "max": 100}}
+            caption = [
+                "This command only shows Overlay connection status for SD-Branch/VPNC GWs",
+                "Use [cyan]cencli tshoot overlay DEVICE[/] for Mobility GWs/APs"
+            ]
+            set_width_cols = {"admin status": {"min": 72, "max": 100}}
 
 
     cli.display_results(
@@ -201,8 +202,6 @@ def connection(
         caption=caption,
         pager=pager,
         outfile=outfile,
-        # sort_by=sort_by,
-        # reverse=reverse,
         set_width_cols=set_width_cols,
         cleaner=cleaner.simple_kv_formatter,
     )

{centralcli-5.2.2 → centralcli-5.3.0}/centralcli/cliupgrade.py

@@ -34,8 +34,9 @@ app = typer.Typer()
 def device(
     device: str = typer.Argument(
         ...,
-        metavar=iden.dev, show_default=False,
+        metavar=iden.dev,
         autocompletion=cli.cache.dev_completion,
+        show_default=False,
     ),
     version: str = typer.Argument(
         None,
@@ -90,6 +91,7 @@ def group(
         metavar=iden.group,
         help="Upgrade devices by group",
         autocompletion=cli.cache.group_completion,
+        show_default=False,
     ),
     version: str = typer.Argument(
         None,
@@ -108,8 +110,8 @@ def group(
         show_default=False,
         formats=["%m/%d/%Y %H:%M", "%d %H:%M"],
         ),
-    dev_type: AllDevTypes = typer.Option(..., help="Upgrade a specific device type",),
-    model: str = typer.Option(None, help="[applies to switches only] Upgrade a specific switch model"),
+    dev_type: AllDevTypes = typer.Option(..., help="Upgrade a specific device type", show_default=False,),
+    model: str = typer.Option(None, help="[applies to switches only] Upgrade a specific switch model", show_default=False,),
     reboot: bool = typer.Option(False, "-R", help="Automatically reboot device after firmware download (APs will reboot regardless)"),
     yes: bool = typer.Option(False, "-Y", "-y", help="Bypass confirmation prompts - Assume Yes"),
     debug: bool = typer.Option(False, "--debug", envvar="ARUBACLI_DEBUG", help="Enable Additional Debug Logging",),

{centralcli-5.2.2 → centralcli-5.3.0}/centralcli/constants.py

@@ -188,6 +188,7 @@ STRIP_KEYS = [
     "lsas",
     "commands",
     "stacks",
+    "routes",
 ]
 
 

{centralcli-5.2.2 → centralcli-5.3.0}/centralcli/render.py

@@ -426,8 +426,8 @@ def output(
                                 formatters.Terminal256Formatter(style='solarized-dark')
                                 )
 
-    if isinstance(raw_data, str):  # HACK
-        raw_data = raw_data.replace('✅', 'True').replace('❌', 'False')   #  TODO handle this better messes up column spacing if replacing string.
+    if isinstance(raw_data, str):  # HACK replace first pass is to line up cols but if table is tighter second pass will swap them regardless
+        raw_data = raw_data.replace('✅  ', 'True').replace('❌   ', 'False').replace('✅', 'True').replace('❌', 'False')   #  TODO handle this better
 
     return Output(rawdata=raw_data, prettydata=table_data, config=config)
 

{centralcli-5.2.2 → centralcli-5.3.0}/centralcli/response.py

@@ -160,8 +160,14 @@ class Response:
             self.status = response.status
             self.method = response.method
             _offset_str = ""
-            if "offset" in response.url.query and int(response.url.query['offset']) > 0:
-                _offset_str = f" offset: {response.url.query['offset']} limit: {response.url.query.get('limit', '?')}"
+            # /routing endpoints use "marker" rather than "offset" for pagination
+            offset_key = "marker" if "marker" in response.url.query and ("marker" in response.url.query or response.url.path.startswith("/api/routing/")) else "offset"
+            if offset_key in response.url.query:
+                if offset_key == "offset" and int(response.url.query[offset_key]) > 0:  # only show full query_str if call is beyond first page of results.
+                    _offset_str = f" {offset_key}: {response.url.query[offset_key]} limit: {response.url.query.get('limit', '?')}"
+                else:  # marker is not an int
+                    _offset_str = f" {offset_key}: {response.url.query[offset_key]} limit: {response.url.query.get('limit', '?')}"
+
             _log_msg = f"[{response.reason}] {response.method}:{response.url.path}{_offset_str} Elapsed: {elapsed:.2f}"
             if not self.ok:
                 self.output = self.output or self.error
@@ -577,6 +583,9 @@ class Session():
         # TODO cleanup, if we do strip_none here can remove from calling funcs.
         params = utils.strip_none(params)
 
+        # /routing endpoints use "marker" rather than "offset" for pagination
+        offset_key = "marker" if "marker" in params or "/api/routing/" in url else "offset"
+
         # for debugging can set a smaller limit in config or via --debug-limit flag to test paging
         if params and params.get("limit") and config.limit:
             log.info(f'paging limit being overridden by config: {params.get("limit")} --> {config.limit}')
@@ -615,14 +624,14 @@ class Session():
             # On 1st call determine if remaining calls can be made in batch
             # total is provided for some calls with the total # of records available
             # TODO no strip_none for these, may need to add if we determine a scenario needs it.
-            if params.get("offset", 99) == 0 and isinstance(r.raw, dict) and r.raw.get("total") and (len(r.output) + params.get("limit", 0) < r.raw.get("total")):
+            if params.get(offset_key, 99) == 0 and isinstance(r.raw, dict) and r.raw.get("total") and (len(r.output) + params.get("limit", 0) < r.raw.get("total")):
                 _total = r.raw["total"] if not url.endswith("/monitoring/v2/events") or r.raw["total"] <= 10_000 else 10_000  # events endpoint will fail if offset + limit > 10,000
                 if _total > len(r.output):
                     _limit = params.get("limit", 100)
-                    _offset = params.get("offset", 0)
+                    _offset = params.get(offset_key, 0)
                     br = BatchRequest
                     _reqs = [
-                        br(self.exec_api_call, url, data=data, json_data=json_data, method=method, headers=headers, params={**params, "offset": i, "limit": _limit}, **kwargs)
+                        br(self.exec_api_call, url, data=data, json_data=json_data, method=method, headers=headers, params={**params, offset_key: i, "limit": _limit}, **kwargs)
                         for i in range(len(r.output), _total, _limit)
                     ]
 
@@ -637,7 +646,7 @@ class Session():
                     elif len(failures) >= len(successful):
                         log.error(f"Failure rate exceeded during batch {method} calls to {url}. Stopping execution.", show=True)
                     elif failures:
-                        log_sfx = "" if len(failures) > 1 else f"?offset={failures[-1].url.query.get('offset')}&limit={failures[-1].url.query.get('limit')}..."
+                        log_sfx = "" if len(failures) > 1 else f"?{offset_key}={failures[-1].url.query.get(offset_key)}&limit={failures[-1].url.query.get('limit')}..."
                         log.error(f":warning:  Output incomplete.  {len(failures)} failure occured: [{failures[-1].method}] {failures[-1].url.path}{log_sfx}", caption=True)
 
                     page_res = [
@@ -648,22 +657,31 @@ class Session():
                     break
 
             _limit = params.get("limit", 0)
-            _offset = params.get("offset", 0)
-            if params.get("limit") and r.output and len(r.output) == _limit:
-                if count and len(paged_output) >= count:
+            if offset_key == "offset":
+                _offset = params.get(offset_key, 0)
+                if params.get("limit") and r.output and len(r.output) == _limit:
+                    if count and len(paged_output) >= count:
+                        r.output = paged_output
+                        r.raw = paged_raw
+                        break
+                    elif count and len(paged_output) < count:
+                        next_limit = count - len(paged_output)
+                        next_limit = _limit if next_limit > _limit else next_limit
+                        params[offset_key] = _offset + next_limit
+                    else:
+                        params[offset_key] = _offset + _limit
+                else:
                     r.output = paged_output
                     r.raw = paged_raw
                     break
-                elif count and len(paged_output) < count:
-                    next_limit = count - len(paged_output)
-                    next_limit = _limit if next_limit > _limit else next_limit
-                    params["offset"] = _offset + next_limit
+            else:  # The routing api endpoints use an opaque handle representing the next page or results, so they can not be batched, as we need the result to get the marker for the next call
+                if r.raw.get("marker"):
+                    params["marker"] = r.raw["marker"]
                 else:
-                    params["offset"] = _offset + _limit
-            else:
-                r.output = paged_output
-                r.raw = paged_raw
-                break
+                    r.raw, r.output = paged_raw, paged_output
+                    if r.raw.get("marker"):
+                        del r.raw["marker"]
+                    break
 
         return r
 

{centralcli-5.2.2 → centralcli-5.3.0}/centralcli/strings.py

@@ -251,20 +251,6 @@ name\nphl-access\nsan-dc-tor\ncom-branches
 {common_add_delete_end}
 """
 
-clibatch_delete_devices_help = """
-[bright_green]Perform batch Delete operations using import data from file.[/]
-
-[cyan]cencli delete sites <IMPORT_FILE>[/] and
-[cyan]cencli delte groups <IMPORT_FILE>[/]
-    Do what you'd expect.
-
-[cyan]cencli batch delete devices <IMPORT_FILE>[/]
-
-    Delete devices will remove any subscriptions/licenses from the device and disassociate the device with the Aruba Central app in GreenLake.  It will then remove the device from the monitoring views, along with the historical data for the device.
-
-    Note: devices can only be removed from monitoring views if they are in a down state.  This command will delay/wait for any Up devices to go Down after the subscriptions/assignment to Central is removed, but it can also be ran again.  It will pick up where it left off, skipping any steps that have already been performed.
-"""
-
 _site_common = """
 [cyan]Provide geo-loc or address details, (Google Maps "Plus Codes" are supported) not both.
 Can provide both in subsequent calls, but api does not allow both in same call.[reset]
@@ -401,7 +387,6 @@ class ImportExamples:
 
 class LongHelp:
     def __init__(self):
-        self.batch_delete_devices = do_capture(clibatch_delete_devices_help)
         self.update_site = do_capture(cliupdate_site_help)
         self.add_site = do_capture(cliadd_site_help)
 

{centralcli-5.2.2 → centralcli-5.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "centralcli"
-version = "5.2.2"
+version = "5.3.0"
 description = "A CLI for interacting with Aruba Central (Cloud Management Platform).  Facilitates bulk imports, exports, reporting.  A handy tool if you have devices managed by Aruba Central."
 license = "MIT"
 authors = ["Wade Wells (Pack3tL0ss) <wade@consolepi.org>"]