centralcli 1.7__tar.gz → 1.8__tar.gz

{centralcli-1.7 → centralcli-1.8}/PKG-INFO

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

@@ -198,19 +198,28 @@ class CentralApi(Session):
         url = "/monitoring/v1/aps"
         return await self.get(url)
 
-    async def get_swarms(self, group: str = None, status: str = None,
-                         public_ip_address: str = None, fields: str = None,
-                         calculate_total: bool = None,
-                         swarm_name: str = None, offset: int = 0, limit: int = 100) -> Response:
+    async def get_swarms(
+        self,
+        group: str = None,
+        status: str = None,
+        public_ip_address: str = None,
+        fields: str = None,
+        calculate_total: bool = None,
+        sort: str = None,
+        swarm_name: str = None,
+        offset: int = 0,
+        limit: int = 100,
+    ) -> Response:
         """List Swarms.
 
         Args:
             group (str, optional): Filter by group name
             status (str, optional): Filter by Swarm status
             public_ip_address (str, optional): Filter by public ip address
-            fields (str, optional): Comma separated list of fields to be returned. Valid fields are
-                status, ip_address, public_ip_address, firmware_version
+            fields (str, optional): Comma separated list of fields to be returned
+                Valid fields are: status, ip_address, public_ip_address, firmware_version
             calculate_total (bool, optional): Whether to calculate total Swarms
+            sort (str, optional): Sort parameter may be one of +swarm_id, -swarm_id
             swarm_name (str, optional): Filter by swarm name
             offset (int, optional): Pagination offset Defaults to 0.
             limit (int, optional): Pagination limit. Default is 100 and max is 1000 Defaults to 100.
@@ -226,11 +235,14 @@ class CentralApi(Session):
             'public_ip_address': public_ip_address,
             'fields': fields,
             'calculate_total': calculate_total,
+            'sort': sort,
             'swarm_name': swarm_name,
             'offset': offset,
-            'limit': limit,
+            'limit': limit
         }
 
+        params = utils.strip_none(params)
+
         return await self.get(url, params=params)
 
     async def get_swarm_details(self, swarm_id: str) -> Response:
@@ -246,15 +258,6 @@ class CentralApi(Session):
 
         return await self.get(url)
 
-    # async def get_swarms_by_group(self, group: str) -> Response:
-    #     url = "/monitoring/v1/swarms"
-    #     params = {"group": group}
-    #     return await self.get(url, params=params)
-
-    # async def get_swarm_details(self, swarm_id: str) -> Response:
-    #     url = f"/monitoring/v1/swarms/{swarm_id}"
-    #     return await self.get(url)
-
     async def get_clients(
         self,
         *args: Tuple[str],
@@ -2063,11 +2066,33 @@ class CentralApi(Session):
 
         return await self.get(url)
 
-    async def get_ts_commands(self, dev_type: Literal['iap', 'mas', 'switch', 'controller']) -> Response:
+    # async def get_ts_commands(self, dev_type: Literal['iap', 'mas', 'switch', 'controller']) -> Response:
+    #     url = "/troubleshooting/v1/commands"
+    #     params = {"device_type": dev_type}
+    #     return await self.get(url, params=params)
+
+    async def get_ts_commands(
+        self,
+        device_type: Literal['iap', 'mas', 'switch', 'controller', 'cx'],
+    ) -> Response:
+        """List Troubleshooting Commands.
+
+        Args:
+            device_type (str): Specify one of "IAP" for swarm, "MAS" for MAS switches, "SWITCH" for
+                aruba switches,"CX" for CX switches, "CONTROLLER" for controllers respectively.
+
+        Returns:
+            Response: CentralAPI Response object
+        """
         url = "/troubleshooting/v1/commands"
-        params = {"device_type": dev_type}
+
+        params = {
+            'device_type': device_type
+        }
+
         return await self.get(url, params=params)
 
+
     async def start_ts_session(
         self,
         serial: str,

{centralcli-1.7 → centralcli-1.8}/centralcli/cleaner.py

@@ -195,6 +195,7 @@ _short_key = {
     "events_details": "details",
     "associated_device_count": "devices",
     "label_id": "id",
+    "command_id": "id",
     "label_name": "name",
     # "acknowledged": "ack",
     "acknowledged_by": "ack by",
@@ -1272,3 +1273,19 @@ def show_interfaces(data: Union[List[dict], dict],) -> Union[List[dict], dict]:
     }
 
     return strip_no_value(data)
+
+def show_ts_commands(data: Union[List[dict], dict],) -> Union[List[dict], dict]:
+    key_order = [
+        "command_id",
+        "category",
+        "command",
+    ]
+    strip_keys = [
+        "summary"
+    ]
+    # data = simple_kv_formatter(data)
+    data = [
+        dict(short_value(k, d.get(k),) for k in key_order if k not in strip_keys) for d in data if "arguments" not in d.keys()
+    ]
+
+    return data

{centralcli-1.7 → centralcli-1.8}/centralcli/cli.py

@@ -819,16 +819,13 @@ def all_commands_callback(ctx: typer.Context, update_cache: bool):
             pass
 
 
-# TODO See if possible to do all 3 version options as one typer.Option (--version -v -V)
 @app.callback()
 def callback(
     # ctx: typer.Context,``
-    version: bool = typer.Option(False, "--version", is_flag=True, help="Show current cencli version, and latest available version."),
-    _version: bool = typer.Option(False, "-V", is_flag=True, help="Show current cencli version, and latest available version.", case_sensitive=False, hidden=False),
-    __version: bool = typer.Option(False, "-v", is_flag=True, hidden=True),
+    version: bool = typer.Option(False, "--version", "-V", "-v", case_sensitive=False, is_flag=True, help="Show current cencli version, and latest available version."),
     debug: bool = typer.Option(False, "--debug", is_flag=True, envvar="ARUBACLI_DEBUG", help="Enable Additional Debug Logging",),
                             #    callback=all_commands_callback),
-    debugv: bool = typer.Option(False, "--debugv", is_flag=True, help="Enable Verbose Debug Logging",),
+    debugv: bool = typer.Option(False, "--debugv", is_flag=True, help="Enable Verbose Debug Logging", hidden=True,),
                             #    callback=all_commands_callback),
     default: bool = typer.Option(
         False,

{centralcli-1.7 → centralcli-1.8}/centralcli/clicommon.py

@@ -176,10 +176,10 @@ class CLICommon:
 
         current = pkg_resources.get_distribution('centralcli').version
         resp = self.central.request(self.central.get, "https://pypi.org/pypi/centralcli/json")
-        latest = max(resp.output["releases"])
         if not resp:
             print(current)
         else:
+            latest = max(resp.output["releases"])
             msg = "[bold bright_green]centralcli[/] "
             msg += 'A CLI app for interacting with Aruba Central Cloud Management Platform.\n'
             msg += f'Brought to you by [cyan]{resp.output["info"]["author"]}[/]\n\n'

{centralcli-1.7 → centralcli-1.8}/centralcli/clishow.py

@@ -20,12 +20,12 @@ except (ImportError, ModuleNotFoundError):
 
 # Detect if called from pypi installed package or via cloned github repo (development)
 try:
-    from centralcli import Response, cleaner, clishowfirmware, clishowwids, clishowbranch, clishowospf, caas, cli, utils, config
+    from centralcli import Response, cleaner, clishowfirmware, clishowwids, clishowbranch, clishowospf, clishowtshoot, caas, cli, utils, config
 except (ImportError, ModuleNotFoundError) as e:
     pkg_dir = Path(__file__).absolute().parent
     if pkg_dir.name == "centralcli":
         sys.path.insert(0, str(pkg_dir.parent))
-        from centralcli import Response, cleaner, clishowfirmware, clishowwids, clishowbranch, clishowospf, caas, cli, utils, config
+        from centralcli import Response, cleaner, clishowfirmware, clishowwids, clishowbranch, clishowospf, clishowtshoot, caas, cli, utils, config
     else:
         print(pkg_dir.parts)
         raise e
@@ -41,6 +41,7 @@ app.add_typer(clishowfirmware.app, name="firmware")
 app.add_typer(clishowwids.app, name="wids")
 app.add_typer(clishowbranch.app, name="branch")
 app.add_typer(clishowospf.app, name="ospf")
+app.add_typer(clishowtshoot.app, name="tshoot")
 
 tty = utils.tty
 iden_meta = IdenMetaVars()
@@ -395,6 +396,49 @@ def aps(
         do_table=do_table)
 
 
+@app.command(short_help="Show Swarms (IAP Clusters)")
+def swarms(
+    group: str = typer.Option(None, metavar="<Device Group>", help="Filter by Group", autocompletion=cli.cache.group_completion, show_default=False,),
+    status: StatusOptions = typer.Option(None, metavar="[up|down]", help="Filter by swarm status", show_default=False,),
+    state: StatusOptions = typer.Option(None, hidden=True),  # alias for status
+    up: bool = typer.Option(False, "--up", help="Filter by swarms that are Up", show_default=False),
+    down: bool = typer.Option(False, "--down", help="Filter by swarms that are Down", show_default=False),
+    pub_ip: str = typer.Option(None, metavar="<Public IP Address>", help="Filter by swarm Public IP", show_default=False,),
+    name: str = typer.Option(None, "--name", help="Filter by swarm/cluster name", show_default=False,),
+    # do_stats: bool = typer.Option(False, "--stats", is_flag=True, help="Show device statistics"),
+    sort_by: str = typer.Option(None, "--sort", help="Field to sort by", rich_help_panel="Formatting", show_default=False,),
+    reverse: bool = typer.Option(False, "-r", is_flag=True, help="Sort in descending order", rich_help_panel="Formatting"),
+    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"),
+    do_table: bool = typer.Option(False, "--table", is_flag=True, help="Output in table format", rich_help_panel="Formatting"),
+    outfile: Path = typer.Option(None, "--out", help="Output to file (and terminal)", writable=True, rich_help_panel="Common Options", show_default=False,),
+    pager: bool = typer.Option(False, "--pager", help="Enable Paged Output", rich_help_panel="Common Options"),
+    update_cache: bool = typer.Option(False, "-U", hidden=True, rich_help_panel="Common Options"),  # Force Update of cli.cache for testing
+    default: bool = typer.Option(False, "-d", is_flag=True, help="Use default central account", show_default=False, rich_help_panel="Common Options"),
+    debug: bool = typer.Option(False, "--debug", envvar="ARUBACLI_DEBUG", help="Enable Additional Debug Logging",),
+    account: str = typer.Option(
+        "central_info",
+        envvar="ARUBACLI_ACCOUNT",
+        help="The Aruba Central Account to use (must be defined in the config)",
+        autocompletion=cli.cache.account_completion,
+    ),
+) -> None:
+    """
+    [cyan]Show Swarms (IAP Clusters)[/]
+    """
+    if down:
+        status = "Down"
+    elif up:
+        status = "Up"
+    else:
+        status = status or state
+
+    resp = cli.central.request(cli.central.get_swarms, group=group, status=status, public_ip_address=pub_ip, swarm_name=name)
+    tablefmt = cli.get_format(do_json=do_json, do_yaml=do_yaml, do_csv=do_csv, do_table=do_table, default="yaml")
+    cli.display_results(resp, tablefmt=tablefmt, pager=pager, outfile=outfile, sort_by=sort_by, reverse=reverse, cleaner=cleaner.show_interfaces)
+
+
 @app.command(short_help="Show switches/details")
 def switches(
     args: List[str] = typer.Argument(None, metavar=iden_meta.dev, autocompletion=cli.cache.dev_completion),
@@ -1654,76 +1698,6 @@ def roaming(
     cli.display_results(resp, title=f"Roaming history for {mac.cols}", tablefmt="rich", cleaner=cleaner.get_client_roaming_history)
 
 
-@app.command(short_help="Show Troubleshooting output")
-def tshoot(
-    device: str = typer.Argument(
-        ...,
-        metavar=iden_meta.dev,
-        help="Aruba Central Device",
-        autocompletion=cli.cache.dev_completion,
-    ),
-    session_id: str = typer.Argument(
-        None,
-        help="The troubleshooting session id.",
-    ),
-    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",
-        is_flag=True,
-        help="Use default central account",
-        show_default=False,
-    ),
-    debug: bool = typer.Option(
-        False,
-        "--debug",
-        envvar="ARUBACLI_DEBUG",
-        help="Enable Additional Debug Logging",
-        show_default=False,
-    ),
-    account: str = typer.Option(
-        "central_info",
-        envvar="ARUBACLI_ACCOUNT",
-        help="The Aruba Central Account to use (must be defined in the config)",
-        autocompletion=cli.cache.account_completion,
-    ),
-) -> None:
-    """Show Troubleshooting results from an existing session.
-
-    Use cencli tshoot ... to start a troubleshooting session.
-
-    """
-    central = cli.central
-    con = Console(emoji=False)
-    dev = cli.cache.get_dev_identifier(device)
-
-    # Fetch session ID if not provided
-    if not session_id:
-        resp = central.request(central.get_ts_session_id, dev.serial)
-        if resp.ok and "session_id" in resp.output:
-            session_id = resp.output["session_id"]
-        else:
-            print(f"No session id provided, unable to find active session id for {dev.name}")
-            cli.display_results(resp)
-            raise typer.Exit(1)
-
-    title = f"Troubleshooting output for {dev.name} session {session_id}"
-    resp = central.request(central.get_ts_output, dev.serial, session_id=session_id)
-    if not resp or resp.output.get("status", "") != "COMPLETED":
-        cli.display_results(resp, title=title, tablefmt="rich",)
-    elif verbose2:
-        cli.display_results(resp)
-    else:
-        con.print(resp)
-        con.print(f"\n   {resp.rl}")
-
-
-
 def show_logs_cencli_callback(ctx: typer.Context, cencli: bool):
     if ctx.resilient_parsing:  # tab completion, return without validating
         return cencli

centralcli-1.8/centralcli/clishowtshoot.py

@@ -0,0 +1,174 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+import typer
+import time
+import pendulum
+import asyncio
+import sys
+from typing import List, Union
+from pathlib import Path
+from rich import print
+from rich.console import Console
+
+try:
+    import psutil
+    hook_enabled = True
+except (ImportError, ModuleNotFoundError):
+    hook_enabled = False
+
+
+# Detect if called from pypi installed package or via cloned github repo (development)
+try:
+    from centralcli import cleaner, cli, utils
+except (ImportError, ModuleNotFoundError) as e:
+    pkg_dir = Path(__file__).absolute().parent
+    if pkg_dir.name == "centralcli":
+        sys.path.insert(0, str(pkg_dir.parent))
+        from centralcli import cleaner, cli, utils
+    else:
+        print(pkg_dir.parts)
+        raise e
+
+from centralcli.constants import (
+    IdenMetaVars, DevTypes, SortTsCmdOptions, TSDevTypes, lib_to_api  # noqa
+)
+
+app = typer.Typer()
+
+tty = utils.tty
+iden_meta = IdenMetaVars()
+
+
+@app.command(short_help="Show Troubleshooting output")
+def results(
+    device: str = typer.Argument(
+        ...,
+        metavar=iden_meta.dev,
+        help="Aruba Central Device",
+        autocompletion=cli.cache.dev_completion,
+    ),
+    session_id: str = typer.Argument(
+        None,
+        help="The troubleshooting session id.",
+    ),
+    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",
+        is_flag=True,
+        help="Use default central account",
+        show_default=False,
+    ),
+    debug: bool = typer.Option(
+        False,
+        "--debug",
+        envvar="ARUBACLI_DEBUG",
+        help="Enable Additional Debug Logging",
+        show_default=False,
+    ),
+    account: str = typer.Option(
+        "central_info",
+        envvar="ARUBACLI_ACCOUNT",
+        help="The Aruba Central Account to use (must be defined in the config)",
+        autocompletion=cli.cache.account_completion,
+    ),
+) -> None:
+    """
+    [cyan]Show Troubleshooting results from an existing session.[/]
+
+    Use [cyan]cencli tshoot...[/] to start a troubleshooting session.
+
+    """
+    central = cli.central
+    con = Console(emoji=False)
+    dev = cli.cache.get_dev_identifier(device)
+
+    # Fetch session ID if not provided
+    if not session_id:
+        resp = central.request(central.get_ts_session_id, dev.serial)
+        if resp.ok and "session_id" in resp.output:
+            session_id = resp.output["session_id"]
+        else:
+            print(f"No session id provided, unable to find active session id for {dev.name}")
+            cli.display_results(resp)
+            raise typer.Exit(1)
+
+    title = f"Troubleshooting output for {dev.name} session {session_id}"
+    resp = central.request(central.get_ts_output, dev.serial, session_id=session_id)
+    if not resp or resp.output.get("status", "") != "COMPLETED":
+        cli.display_results(resp, title=title, tablefmt="rich",)
+    elif verbose2:
+        cli.display_results(resp)
+    else:
+        con.print(resp)
+        con.print(f"\n   {resp.rl}")
+
+
+@app.command(short_help="Show available troubleshooting commands")
+def commands(
+    device_type: TSDevTypes = typer.Argument(..., metavar=iden_meta.dev_types_w_mas, show_default=False,),
+    sort_by: SortTsCmdOptions = typer.Option("id", "--sort",),
+    reverse: bool = typer.Option(False, "-r", help="Reverse output order", show_default=False,),
+    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",
+        is_flag=True,
+        help="Use default central account",
+        show_default=False,
+    ),
+    debug: bool = typer.Option(
+        False,
+        "--debug",
+        envvar="ARUBACLI_DEBUG",
+        help="Enable Additional Debug Logging",
+        show_default=False,
+    ),
+    account: str = typer.Option(
+        "central_info",
+        envvar="ARUBACLI_ACCOUNT",
+        help="The Aruba Central Account to use (must be defined in the config)",
+        autocompletion=cli.cache.account_completion,
+    ),
+) -> None:
+    """
+    [cyan]Show available troubleshooting commands for a given device type.[/]
+
+    Use [cyan]cencli tshoot...[/] to start a troubleshooting session.
+
+    """
+    if sort_by == "id":
+        sort_by = None
+    central = cli.central
+    con = Console(emoji=False)
+    dev_type = lib_to_api("tshoot", device_type)
+
+    resp = central.request(central.get_ts_commands, device_type=dev_type,)
+    cli.display_results(resp, tablefmt="rich", sort_by=sort_by, reverse=reverse, cleaner=cleaner.show_ts_commands)
+    # con.print(f"\n   {resp.rl}")
+
+
+
+
+
+@app.callback()
+def callback():
+    """
+    Show troubleshooting session details or available commands
+    """
+    pass
+
+
+if __name__ == "__main__":
+    app()

{centralcli-1.7 → centralcli-1.8}/centralcli/clitshoot.py

@@ -4,25 +4,34 @@
 import sys
 from pathlib import Path
 from time import sleep
+from typing import List
 
 import typer
 from rich import print
 from rich.console import Console
 from rich.progress import track
 
+try:
+    from fuzzywuzzy import process # type: ignore noqa
+    FUZZ = True
+except Exception:
+    FUZZ = False
+    pass
+
 # Detect if called from pypi installed package or via cloned github repo (development)
 try:
-    from centralcli import cli, utils
+    from centralcli import cli, utils, cleaner, render
 except (ImportError, ModuleNotFoundError) as e:
     pkg_dir = Path(__file__).absolute().parent
     if pkg_dir.name == "centralcli":
         sys.path.insert(0, str(pkg_dir.parent))
-        from centralcli import cli, utils
+        from centralcli import cli, utils, cleaner, render
     else:
         print(pkg_dir.parts)
         raise e
 
 from centralcli.constants import IdenMetaVars, lib_to_api
+from centralcli.cache import CentralObject
 
 app = typer.Typer()
 
@@ -30,11 +39,10 @@ tty = utils.tty
 iden_meta = IdenMetaVars()
 
 
-# TODO AP only completion
 @app.command(short_help="Show AP Overlay details")
 def ap_overlay(
-    device: str = typer.Argument(None, metavar=iden_meta.dev, autocompletion=cli.cache.dev_ap_completion),
-    outfile: Path = typer.Option(None, "--out", help="Output to file (and terminal)", writable=True),
+    device: str = typer.Argument(..., metavar=iden_meta.dev, autocompletion=cli.cache.dev_ap_completion, show_default=False,),
+    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"),
     default: bool = typer.Option(False, "-d", is_flag=True, help="Use default central account", show_default=False,),
     debug: bool = typer.Option(False, "--debug", envvar="ARUBACLI_DEBUG", help="Enable Additional Debug Logging",),
@@ -43,6 +51,13 @@ def ap_overlay(
                                 help="The Aruba Central Account to use (must be defined in the config)",
                                 autocompletion=cli.cache.account_completion),
 ):
+    """
+    [cyan]Returns the output of the following commands useful in troubleshooting overlay AP / gateway tunnels.[/]
+
+    [cyan]-[/] show ata endpoint
+    [cyan]-[/] show show overlay tunnel config
+    [cyan]-[/] show overlay ssid-cluster status
+    """
     console = Console(emoji=False)
     dev = cli.cache.get_dev_identifier(device, dev_type=("ap"))
     commands = [201, 203, 218]
@@ -144,6 +159,87 @@ def ping(
                 break
 
 
+def ts_send_command(device: CentralObject, cmd: str, outfile: Path, pager: bool,) -> None:
+    """Helper command to send troubleshooting output (user provides command) and print results
+
+    Args:
+        device (CentralObject): Device Object
+        cmd (str): User provided command
+        outfile (Path): Optional output to file
+        pager (bool): Optional Use Pager
+    """
+    console = Console(emoji=False)
+    dev = cli.cache.get_dev_identifier(device)
+    dev_type = lib_to_api("tshoot", dev.type)
+    if len(cmd) == 1:
+        cmd = cmd[0].split()
+    cmd = " ".join(cmd)
+    cmd = cmd.replace("  ", " ").strip().lower()
+    resp = cli.central.request(cli.central.get_ts_commands, dev_type)
+    if not resp:
+        print('[bright_red]Unable to get troubleshooting command list')
+        cli.display_results(resp)
+    else:
+        cmd_list = resp.output
+        cmd_id = [c["command_id"] for c in cmd_list if c["command"].strip() == cmd]
+        if not cmd_id:
+            if FUZZ:
+                fuzz_match, fuzz_confidence = process.extract(cmd, [c["command"].strip() for c in cmd_list], limit=1)[0]
+                print(f"[bright_red]{cmd}[/] is not a valid troubleshooting command (supported by API) for {dev.type}.")
+                confirm_str = render.rich_capture(f"Did you mean [green3]{fuzz_match}[/]?")
+                if fuzz_confidence >= 70 and typer.confirm(confirm_str):
+                    cmd_id = [c["command_id"] for c in cmd_list if c["command"].strip() == fuzz_match]
+
+        if not cmd_id:
+            caption = f'[bright_red]Error[/]: [cyan]{cmd}[/] not found in available troubleshooting commands for {dev.type}. See available commands above.'
+            cli.display_results(resp, tablefmt="rich", caption=caption, title=f"Available troubleshooting commands for {dev.type}", cleaner=cleaner.show_ts_commands)
+        else:
+            resp = cli.central.request(cli.central.start_ts_session, dev.serial, dev_type=dev_type, commands=cmd_id)
+            cli.display_results(resp, tablefmt="action", exit_on_fail=True)
+
+            complete = False
+            while not complete:
+                for x in range(3):
+                    with console.status("Waiting for Troubleshooting Response..."):
+                        sleep(10)
+                    ts_resp = cli.central.request(cli.central.get_ts_output, dev.serial, resp.session_id)
+
+                    if ts_resp.output.get("status", "") == "COMPLETED":
+                        print(ts_resp.output["output"])
+                        complete = True
+                        break
+                    else:
+                        print(f'{ts_resp.output.get("message", " . ").split(".")[0]}. [cyan]Waiting...[/]')
+
+
+                if not complete:
+                    print(f'[dark_orange3]WARNING[/] Central is still waiting on response from [cyan]{dev.name}[/]')
+                    if not typer.confirm("Continue to wait/retry?"):
+                        cli.display_results(ts_resp, tablefmt="action", pager=pager, outfile=outfile)
+                        break
+
+@app.command(short_help="Send troubleshooting command to a device")
+def command(
+    device: str = typer.Argument(..., metavar=iden_meta.dev, autocompletion=cli.cache.dev_completion,),
+    cmd: List[str] = typer.Argument(..., help="command to send to switch, must be supported by API."),
+    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"),
+    default: bool = typer.Option(False, "-d", is_flag=True, help="Use default central account", show_default=False,),
+    debug: bool = typer.Option(False, "--debug", envvar="ARUBACLI_DEBUG", help="Enable Additional Debug Logging",),
+    account: str = typer.Option("central_info",
+                                envvar="ARUBACLI_ACCOUNT",
+                                help="The Aruba Central Account to use (must be defined in the config)",
+                                autocompletion=cli.cache.account_completion),
+):
+    """
+    [cyan]Send a user provided troubleshooting commands to a device and wait for results.[/]
+
+    Returns response (from device) to troubleshooting commands.
+    Commands must be supported by the API, use [cyan]show tshoot commands <dev-type>[/] to see available commands
+    """
+    ts_send_command(device, cmd, outfile, pager)
+
+
 @app.callback()
 def callback():
     """

{centralcli-1.7 → centralcli-1.8}/centralcli/cliupgrade.py

@@ -179,6 +179,7 @@ def swarm(
         ...,
         metavar=iden.dev,
         help=f"Upgrade will be performed on the cluster the AP belongs to.",
+        autocompletion=cli.cache.dev_ap_completion,
     ),
     version: str = typer.Argument(None, help="Version to upgrade to",),
     at: datetime = typer.Option(

{centralcli-1.7 → centralcli-1.8}/centralcli/constants.py

@@ -31,6 +31,16 @@ class DevTypes(str, Enum):
     gw = "gw"
 
 
+class TSDevTypes(str, Enum):
+    ap = "ap"
+    sw = "sw"
+    switch = "switch"
+    cx = "cx"
+    gateway = "gateway"
+    gw = "gw"
+    mas = "mas"
+
+
 class SendConfigDevIdens(str, Enum):
     ap = "ap"
     gw = "gw"
@@ -47,6 +57,7 @@ class ShowInventoryArgs(str, Enum):
     others = "others"
 
 
+#  TODO can move to lib_to_api class below
 SHOWINVENTORY_LIB_TO_API = {
     "all": "all",
     "ap": "all_ap",
@@ -126,6 +137,7 @@ STRIP_KEYS = [
     "interfaces",
     "areas",
     "lsas",
+    "commands",
 ]
 
 
@@ -376,6 +388,14 @@ class ArgToWhat:
     def _init_test(self):
         self.webhooks = self.webhook = "webhook"
 
+    def _init_tshoot(self):
+        self.ap = self.aps = self.iap = "ap"
+        self.gateway = self.gateways = self.gw = "gateway"
+        self.switch = self.switch = self.switches = "switch"
+        self.cx = "cx"
+        self.mas = "mas"
+
+
     def _init_clone(self):
         self.group = self.groups = "group"
 
@@ -406,6 +426,10 @@ APIMethodType = Literal[
     "site",
     "monitoring",
     "event",
+    "template",
+    "firmware",
+    "event",
+    "tshoot"
 ]
 
 
@@ -471,9 +495,12 @@ class LibToAPI:
         }
         self.tshoot_to_api = {
             "gw": "CONTROLLER",
+            "gateway": "CONTROLLER",
             "ap": "IAP",
             "cx": "CX",
-            "sw": "SWITCH"
+            "sw": "SWITCH",
+            "switch": "SWITCH",
+            "mas": "MAS"
         }
 
     def __call__(self, method: APIMethodType, key: str, default: str = None) -> str:
@@ -724,6 +751,11 @@ class SortOspfDatabaseOptions(str, Enum):
     route_tag = "route_tag"
 
 
+class SortTsCmdOptions(str, Enum):
+    command_id = "id"
+    category = "category"
+
+
 class StatusOptions(str, Enum):
     up = "up"
     down = "down"
@@ -766,6 +798,7 @@ class IdenMetaVars:
         self.dev_words = f"Optional Identifying Attribute: {self.dev}"
         self.generic_dev_types = "[ap|gw|switch]"
         self.dev_types = "[ap|gw|cx|sw]"
+        self.dev_types_w_mas = "[ap|gw|cx|sw|mas]"
         self.group_or_dev = f"device {self.dev.upper()} | group [GROUP]"
         self.group_dev_cencli = f"{self.dev.upper().replace(']', '|GROUPNAME|cencli]')}"
         self.group_or_dev_or_site = "[DEVICE|\"all\"|GROUP|SITE]"

{centralcli-1.7 → centralcli-1.8}/pyproject.toml

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