centralcli 7.2.3__tar.gz → 7.2.4__tar.gz

{centralcli-7.2.3 → centralcli-7.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: centralcli
-Version: 7.2.3
+Version: 7.2.4
 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-7.2.3 → centralcli-7.2.4}/centralcli/cache.py

@@ -3227,27 +3227,30 @@ class Cache:
 
 
             # no match found initiate cache update
-            if retry and not match and ((dev_type and not cache_updated) or self.responses.dev is None):
-                dev_type_sfx = "" if not dev_type else f" [grey42 italic](Device Type: {utils.unlistify(dev_type)})[/]"
-                econsole.print(f"[dark_orange3]:warning:[/]  [bright_red]No Match found[/] for [cyan]{query_str}[/]{dev_type_sfx}.")
-                if FUZZ:
-                    if dev_type:
-                        fuzz_match, fuzz_confidence = process.extract(query_str, [d["name"] for d in self.devices if d["type"] in dev_type], limit=1)[0]
-                    else:
-                        fuzz_match, fuzz_confidence = process.extract(query_str, [d["name"] for d in self.devices], limit=1)[0]
-                    confirm_str = render.rich_capture(f"Did you mean [green3]{fuzz_match}[/]?")
-                    if fuzz_confidence >= 70 and typer.confirm(confirm_str):
-                        match = self.DevDB.search(self.Q.name == fuzz_match)
-                if not match:
-                    kwargs = {"dev_db": True}
-                    if include_inventory:
-                        _word = " & Inventory "
-                        kwargs["inv_db"] = True
-                    else:
-                        _word = " "
-                    econsole.print(f":arrows_clockwise: Updating Device{_word}Cache.")
-                    self.check_fresh(refresh=True, dev_type=dev_type, **kwargs )
-                    cache_updated = True  # Need this for scenario when dev_type is the only thing refreshed, as that does not update self.responses.dev
+            if retry and not match and self.responses.dev is None:
+                if dev_type and cache_updated:
+                    ...  # self.responses.dev is not currently updated if dev_type provided, but cache update may have already occured in this session.
+                else:
+                    dev_type_sfx = "" if not dev_type else f" [grey42 italic](Device Type: {utils.unlistify(dev_type)})[/]"
+                    econsole.print(f"[dark_orange3]:warning:[/]  [bright_red]No Match found[/] for [cyan]{query_str}[/]{dev_type_sfx}.")
+                    if FUZZ:
+                        if dev_type:
+                            fuzz_match, fuzz_confidence = process.extract(query_str, [d["name"] for d in self.devices if d["type"] in dev_type], limit=1)[0]
+                        else:
+                            fuzz_match, fuzz_confidence = process.extract(query_str, [d["name"] for d in self.devices], limit=1)[0]
+                        confirm_str = render.rich_capture(f"Did you mean [green3]{fuzz_match}[/]?")
+                        if fuzz_confidence >= 70 and typer.confirm(confirm_str):
+                            match = self.DevDB.search(self.Q.name == fuzz_match)
+                    if not match:
+                        kwargs = {"dev_db": True}
+                        if include_inventory:
+                            _word = " & Inventory "
+                            kwargs["inv_db"] = True
+                        else:
+                            _word = " "
+                        econsole.print(f":arrows_clockwise: Updating Device{_word}Cache.")
+                        self.check_fresh(refresh=True, dev_type=dev_type, **kwargs )
+                        cache_updated = True  # Need this for scenario when dev_type is the only thing refreshed, as that does not update self.responses.dev
 
             if match:
                 match = [Model(dev) for dev in match]

{centralcli-7.2.3 → centralcli-7.2.4}/centralcli/cleaner.py

@@ -1626,7 +1626,7 @@ def show_interfaces(data: List[dict] | dict, verbosity: int = 0, dev_type: DevTy
         key_order = verbosity_keys[verbosity]
         # send all key/value pairs through formatters
         data = [
-            dict(short_value(k, d.get(k),) for k in key_order) for d in data
+            dict(short_value(k, d[k],) for k in key_order if k in d) for d in data
         ]
     else:
         key_order = [*key_order, *data[-1].keys()]

{centralcli-7.2.3 → centralcli-7.2.4}/centralcli/clicommon.py

@@ -383,8 +383,7 @@ class CLICommon:
         else:
             return default
 
-    @staticmethod
-    def write_file(outfile: Path, outdata: str) -> None:
+    def write_file(self, outfile: Path, outdata: str) -> None:
         """Output data to file
 
         Args:
@@ -407,19 +406,22 @@ class CLICommon:
 
             print(f"\n[cyan]Writing output to {outfile}... ", end="")
 
-            out_msg = None
-            try:
-                if isinstance(outdata, (dict, list)):
-                    outdata = json.dumps(outdata, indent=4)
-                outfile.write_text(outdata)  # typer.unstyle(outdata) also works
-            except Exception as e:
-                outfile.write_text(f"{outdata}")
-                out_msg = f"Error ({e.__class__.__name__}) occurred during attempt to output to file.  " \
-                    "Used simple string conversion"
+            if not outfile.parent.is_dir():
+                self.econsole.print(f"[red]Directory Not Found[/]\n[dark_orange3]:warning:[/]  Unable to write output to [cyan]{outfile.name}[/].\nDirectory [cyan]{str(outfile.parent.absolute())}[/] [red]does not exist[/].")
+            else:
+                out_msg = None
+                try:
+                    if isinstance(outdata, (dict, list)):
+                        outdata = json.dumps(outdata, indent=4)
+                    outfile.write_text(outdata)  # typer.unstyle(outdata) also works
+                except Exception as e:
+                    outfile.write_text(f"{outdata}")
+                    out_msg = f"Error ({e.__class__.__name__}) occurred during attempt to output to file.  " \
+                        "Used simple string conversion"
 
-            print("[italic green]Done")
-            if out_msg:
-                log.warning(out_msg, show=True)
+                print("[italic green]Done")
+                if out_msg:
+                    log.warning(out_msg, show=True)
 
     @staticmethod
     def exit(msg: str = None, code: int = 1, emoji: bool = True) -> None:

{centralcli-7.2.3 → centralcli-7.2.4}/centralcli/clikick.py

@@ -8,7 +8,6 @@ from rich import print
 
 
 # Detect if called from pypi installed package or via cloned github repo (development)
-# TODO should be able to do this in __init__
 try:
     from centralcli import cli
 except (ImportError, ModuleNotFoundError) as e:
@@ -19,16 +18,18 @@ except (ImportError, ModuleNotFoundError) as e:
     else:
         print(pkg_dir.parts)
         raise e
-from centralcli.constants import IdenMetaVars
 
-iden = IdenMetaVars()
+from centralcli.constants import iden_meta
+from .cache import CacheClient
+from .models import Clients
+
 app = typer.Typer()
 
 @app.command(short_help="Disconnect all WLAN clients from an AP optionally for a specific SSID",)
 def all(
     device: str = typer.Argument(
         ...,
-        metavar=iden.dev,
+        metavar=iden_meta.dev,
         help="The AP to disconnect clients from",
         autocompletion=cli.cache.dev_ap_completion,
         show_default=False,
@@ -46,7 +47,7 @@ def all(
     dev = cli.cache.get_dev_identifier(device)
     _ssid_msg = "" if not ssid else f" on SSID [cyan]{ssid}[/]"
     print(f'Kick [bright_red]ALL[/] users connected to [cyan]{dev.name}[/]{_ssid_msg}')
-    if yes or typer.confirm("\nproceed?", abort=True):
+    if cli.confirm(yes):
         resp = cli.central.request(
             cli.central.kick_users,
             dev.serial,
@@ -56,12 +57,10 @@ def all(
         cli.display_results(resp, tablefmt="action")
 
 
-# TODO rather than drop option have cache remove users with last_connected > 30 days
 @app.command(short_help="Disconnect a WLAN client",)
 def client(
-    client: str = typer.Argument(..., metavar=iden.client, autocompletion=cli.cache.client_completion, show_default=False),
+    client: str = typer.Argument(..., metavar=iden_meta.client, autocompletion=cli.cache.client_completion, show_default=False),
     refresh: bool = typer.Option(False, "--refresh", "-R", help="Cache is used to determine what AP the client is connected to, which could be [red]stale[/]. This forces a cache update."),
-    drop: bool = typer.Option(False, "--drop", "-D", help="(implies -R): Drop all users from existing cache, then refresh.  By default any user that has ever connected is retained in the cache."),
     yes: bool = cli.options.yes,
     debug: bool = cli.options.debug,
     default: bool = cli.options.default,
@@ -75,15 +74,31 @@ def client(
 
     The [cyan]-R[/] flag can be used to force a cache refresh prior to performing the disconnect.
     """
-    if refresh or drop:
-        resp = cli.central.request(cli.cache.refresh_client_db, "wireless", truncate=drop)
+    if refresh:
+        resp = cli.central.request(cli.cache.refresh_client_db, client_type="wireless")
         if not resp:
             cli.display_results(resp, exit_on_fail=True)
 
-    client = cli.cache.get_client_identifier(client, exit_on_fail=True)
+    client: CacheClient = cli.cache.get_client_identifier(client, exit_on_fail=True)
+    if not client.last_connected:
+        if refresh:
+            cli.exit(f"Client {client} is not connected.")
+        else:
+            client_resp = cli.central.request(cli.cache.refresh_client_db, mac=client.mac)
+            if not client_resp:
+                cli.econsole.print(f"client {client} is not online according to cache, Failure occured attempting to fetch client details from API.")
+                cli.display_results(client_resp, exit_on_fail=True)
+
+            _clients = [CacheClient(c) for c in Clients(client_resp.output)]
+            online_client =  [c for c in _clients if c.last_connected is not None]
+            if online_client:
+                client = online_client[-1]
+            else:
+                client = _clients[-1]
+                cli.exit(f"Client {client} is not online: Failure Stage: {client_resp.output[-1].get('failure_stage', '')}, Reason: {client_resp.output[-1].get('failure_reason', '')}")
 
     print(f'Kick client [cyan]{client.name}[/], currently connected to [cyan]{client.connected_name}[/]')
-    if yes or typer.confirm("\nProceed?", abort=True):
+    if cli.confirm(yes):
         resp = cli.central.request(
             cli.central.kick_users,
             client.connected_serial,

{centralcli-7.2.3 → centralcli-7.2.4}/centralcli/clishow.py

@@ -10,6 +10,8 @@ import os
 from datetime import datetime
 from typing import List, Iterable, Literal, Dict, Any, Tuple, TYPE_CHECKING
 from pathlib import Path
+import getpass
+from jinja2 import Template
 from rich import print
 from rich.console import Console
 
@@ -48,6 +50,7 @@ from centralcli.constants import (
 )
 from centralcli.cache import CentralObject
 from centralcli.objects import DateTime
+from .strings import cron_weekly
 
 if TYPE_CHECKING:
     from .cache import CacheSite, CacheGroup, CacheLabel, CacheDevice
@@ -163,7 +166,7 @@ def _build_device_caption(resp: Response, *, inventory: bool = False, dev_type:
 
     # Put together counts caption string
     if status:
-        _cnt_str = ", ".join([f'[{"bright_green" if status.lower() == "up" else "red"}]{t}[/]: [cyan]{status_by_type[t]["total"]}[/]' for t in status_by_type])
+        _cnt_str = ", ".join([f'[{"bright_green" if status.lower() == "up" else "red"}]{status.capitalize()} {t if t != "ap" else "APs"}[/]: [cyan]{status_by_type[t]["total"]}[/]' for t in status_by_type])
     elif inventory:
         _cnt_str = f"Total in inventory: [cyan]{len(resp.output)}[/], "
         _cnt_str = _cnt_str + ", ".join(
@@ -558,7 +561,7 @@ def aps(
         if up and down:
             ...  # They used both flags.  ignore
         elif up or down:
-            status = "Down" if down else "Up"
+            status = "down" if down else "up"
 
         show_devices(
             aps, dev_type="ap", include_inventory=with_inv, verbosity=verbose, outfile=outfile, update_cache=update_cache, group=group, site=site, label=label, status=status,
@@ -2009,6 +2012,7 @@ def wlans(
         "calculate_client_count": True,
     }
 
+    # TODO specifying WLAN name ... is ignored if verbose
     tablefmt = cli.get_format(do_json=do_json, do_yaml=do_yaml, do_csv=do_csv, do_table=do_table, default="rich")
     if group:  # Specifying the group implies verbose (same # of API calls either way.)
         resp = central.request(central.get_full_wlan_list, group)
@@ -2032,7 +2036,7 @@ def wlans(
     else:
         resp = central.request(central.get_wlans, **params)
         caption = None
-        if resp:
+        if resp and not name:
             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)
@@ -2875,7 +2879,7 @@ def portals(
 # TODO add sort_by completion, portal completion
 @app.command()
 def guests(
-    portal: str = typer.Argument(..., help="portal name", show_default=False,),
+    portal: str = typer.Argument(..., help="portal name", autocompletion=cli.cache.portal_completion, show_default=False,),
     sort_by: str = cli.options.sort_by,
     reverse: bool = cli.options.reverse,
     do_json: bool = cli.options.do_json,
@@ -3017,6 +3021,42 @@ def version(
     """
     cli.version_callback()
 
+@app.command(hidden=os.name != "posix")
+def cron(
+    accounts: List[str] = typer.Argument(None,),
+) -> None:
+    """Show contents of cron file that can be used to automate token refresh weekly.
+
+    This will keep the tokens valid, even if cencli is not used.
+    """
+    if os.name != "posix":
+        cli.econsole.print("This command is currently only supported on Linux using cron.  It is possible to do the same via Windows Task Scheduler.  Showing Linux cron.weekly output for reference.")
+
+    user = getpass.getuser()
+    exec_path = sys.argv[0]
+    py_path = sys.executable
+
+    config_data = {
+        "user": user,
+        "py_path": py_path,
+        "exec_path": exec_path,
+        "accounts": "" if not accounts else " ".join(accounts)
+    }
+
+    template = Template(cron_weekly)
+    config_out = template.render(config_data)
+
+    cli.econsole.rule("/etc/cron.weekly/cencli file contents")
+    cli.console.print(config_out)
+    cli.econsole.rule()
+
+    cli.econsole.print(
+        "Place the above contents into a file: /etc/cron.weekly/cencli [grey42 italic](requires sudo)[/]\n"
+        f"Alternatively you can pipe the output directly [cyan]cencli show cron {'' if not accounts else ' '.join(accounts)} | sudo tee /etc/cron.weekly/cencli[/]"
+        "\nThen make it executable: [cyan]sudo chmod +x /etc/cron.weekly/cencli[/]"
+        "\n\n[cyan]cencli refresh token[/] [dark_olive_green2 italic]command will always update the tokens for the default workspace (that's the -d flag)[/]"
+    )
+
 
 def _get_cencli_config() -> None:
     try:

{centralcli-7.2.3 → centralcli-7.2.4}/centralcli/clitest.py

@@ -167,7 +167,7 @@ def method(
         resp = _check_bool_to_str(args, kwargs, resp_str=str(e))
 
     attrs = {
-        k: v for k, v in resp.__dict__.items() if k not in ["output", "raw"] and (log.DEBUG or not k.startswith("_"))
+        k: v for k, v in resp.__dict__.items() if k not in ["output", "raw", "data_key"] and (log.DEBUG or not k.startswith("_"))
     }
 
     req = (

{centralcli-7.2.3 → centralcli-7.2.4}/centralcli/models.py

@@ -411,7 +411,7 @@ class Client(BaseModel):
     @classmethod
     def pretty_dt(cls, dt: datetime) -> DateTime:
         if dt is None:  # TODO all with potential for there not to be a value need this
-            return None
+            return DateTime(None, "timediff")  # resolves PydanticSerializationError when model_dump_json is called on client with None for last_connected (Failed)
 
         return DateTime(dt.timestamp(), "timediff")
 

{centralcli-7.2.3 → centralcli-7.2.4}/centralcli/response.py

@@ -383,7 +383,8 @@ class Response:
                 r = r.replace("message: ", "").replace(self.output["message"], f'[red italic]{self.output["message"]}[/]')
 
         r = r.replace("failed:", "[red]failed[/]:").replace("FAILED", "[red]FAILED[/red]").replace("failed_devices", "[red]failed_devices[/]").replace("INVALID", "[red]INVALID[/]")
-        r = r.replace("SUCCESS", "[bright_green]SUCCESS[/]").replace("Success", "[bright_green]Success[/]").replace("success", "[bright_green]success[/]").replace("succeeded_devices", "[bright_green]succeeded_devices[/]")
+        r = r.replace("SUCCESS", "[bright_green]SUCCESS[/]").replace("Success", "[bright_green]Success[/]").replace("Success[/]fully", "Successfully[/]")
+        r = r.replace("Success", "[bright_green]Success[/]").replace("success", "[bright_green]success[/]").replace("succeeded_devices", "[bright_green]succeeded_devices[/]")
         r = r.replace("invalid_device", "[red]invalid_device[/]").replace("blocked_device", "[red]blocked_device[/red]").replace("ATHENA_ERROR_DEVICE_ALREADY_EXIST", "[italic dark_orange3]Device already exists[/]")
 
         # sanitize sensitive data for demos

{centralcli-7.2.3 → centralcli-7.2.4}/centralcli/strings.py

@@ -589,3 +589,10 @@ class ImportExamples:
         if key not in self.__dict__.keys():
             log.error(f"An attempt was made to get {key} attr from ImportExamples which is not defined.")
             return f":warning: [bright_red]Error[/] no str defined for [cyan]ImportExamples.{key}[/]"
+
+cron_weekly = """#!/usr/bin/env bash
+
+/bin/su -c "{{py_path}} {{exec_path}} refresh token -d {{accounts}}" {{user}} &&
+    logger -t centralcli "Token Refreshed via cron" ||
+    logger -t centralcli "Token Refresh returned error"
+"""

{centralcli-7.2.3 → centralcli-7.2.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "centralcli"
-version = "7.2.3"
+version = "7.2.4"
 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>"]