centralcli 2.3.0__tar.gz → 2.3.1__tar.gz

{centralcli-2.3.0 → centralcli-2.3.1}/PKG-INFO

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

@@ -4028,6 +4028,25 @@ class CentralApi(Session):
         else:
             return await self.post(url, json_data=json_data)
 
+    async def cop_delete_device_from_inventory(
+        self,
+        devices: List[str] = None,
+    ) -> Response:
+        """Delete devices using Serial number.  Only applies to CoP deployments.
+
+        Args:
+            devices (list, optional): List of devices to be deleted from
+                GreenLake inventory.  Only applies to CoP
+
+        Returns:
+            Response: CentralAPI Response object
+        """
+        url = "/platform/device_inventory/v1/devices"
+
+        devices = [{"serial": serial} for serial in devices]
+
+        return await self.delete(url, json_data=devices)
+
     # TODO maybe helper method to delete_device that calls these
     async def delete_gateway(
         self,
@@ -5477,6 +5496,72 @@ class CentralApi(Session):
 
         return await self.get(url)
 
+
+    async def get_auto_subscribe(
+        self,
+    ) -> Response:
+        """Get the services which have auto subscribe enabled.
+
+        Returns:
+            Response: CentralAPI Response object
+        """
+        url = "/platform/licensing/v1/customer/settings/autolicense"
+
+        return await self.get(url)
+
+    async def enable_auto_subscribe(
+        self,
+        services: List[str] | str,
+    ) -> Response:
+        """Standalone Customer API: Assign licenses to all devices and enable auto subscribe for
+        given services.
+
+        Args:
+            services (List[str]): list of services e.g. ['pa', 'ucc', foundation_ap,
+                advanced_switch_6200, foundation_70XX etc ...]. Check
+                /platform/licensing/v1/services/config API response to know the list of supported
+                services.
+
+        Returns:
+            Response: CentralAPI Response object
+        """
+        url = "/platform/licensing/v1/customer/settings/autolicense"
+
+        if isinstance(services, str):
+            services = [services]
+
+        json_data = {
+            'services': services
+        }
+
+        return await self.post(url, json_data=json_data)
+
+    async def disable_auto_subscribe(
+        self,
+        services: List[str] | str,
+    ) -> Response:
+        """Standalone Customer API: Disable auto licensing for given services.
+
+        Args:
+            services (List[str]): list of services e.g. ['pa', 'ucc', foundation_ap,
+                advanced_switch_6200, foundation_70XX etc ...]. Check
+                /platform/licensing/v1/services/config API response to know the list of supported
+                services.
+
+        Returns:
+            Response: CentralAPI Response object
+        """
+        url = "/platform/licensing/v1/customer/settings/autolicense"
+
+        if isinstance(services, str):
+            services = [services]
+
+        json_data = {
+            'services': services
+        }
+
+        return await self.delete(url, json_data=json_data)
+
     # // -- Not used by commands yet.  undocumented kms api -- //
     async def kms_get_synced_aps(self, mac: str) -> Response:
         url = f"/keymgmt/v1/syncedaplist/{mac}"

{centralcli-2.3.0 → centralcli-2.3.1}/centralcli/cliassign.py

@@ -24,10 +24,10 @@ except (ImportError, ModuleNotFoundError) as e:
 app = typer.Typer()
 
 
-@app.command(short_help="Assign License to device(s)", hidden=False)
+@app.command()
 def license(
     license: cli.cache.LicenseTypes = typer.Argument(..., show_default=False),
-    serial_nums: List[str] = typer.Argument(..., show_default=False),
+    serial_nums: List[str] = typer.Argument(..., help="device serial numbers or 'auto' to enable auto-subscribe.", show_default=False),
     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",),
     default: bool = typer.Option(False, "-d", is_flag=True, help="Use default central account", show_default=False,),
@@ -36,7 +36,7 @@ def license(
                                 help="The Aruba Central Account to use (must be defined in the config)",
                                 autocompletion=cli.cache.account_completion),
 ) -> None:
-    """Assign Licenses to devices by serial number.
+    """Assign Licenses to devices by serial number(s) or enable auto-subscribe for the license type.
 
     Device must already be added to Central.  Use '[cyan]cencli show inventory[/]' to see devices that have been added.
     Use '--license' option with '[cyan]cencli add device ...[/]' to add device and assign license in one command.
@@ -44,16 +44,27 @@ def license(
     # devices = [cli.cache.get_dev_identifier(dev) for dev in devices]
 
     # TODO add confirmation method builder to output class
-    _msg = f"Assign [bright_green]{license}[/bright_green] to"
-    if len(serial_nums) > 1:
-        _dev_msg = '\n    '.join([f'[cyan]{dev}[/]' for dev in serial_nums])
-        _msg = f"{_msg}:\n    {_dev_msg}"
+    do_auto = True if "auto" in [s.lower() for s in serial_nums] else False
+    if do_auto:
+        _msg = f"Enable Auto-assignment of [bright_green]{license}[/bright_green] to applicable devices."
+        if len(serial_nums) > 1:
+            print(f'[cyan]auto[/] keyword provided remaining entries will be [bright_red]ignored[/]')
     else:
-        dev = serial_nums[0]
-        _msg = f"{_msg} [cyan]{dev}[/]"
+        _msg = f"Assign [bright_green]{license}[/bright_green] to"
+        if len(serial_nums) > 1:
+            _dev_msg = '\n    '.join([f'[cyan]{dev}[/]' for dev in serial_nums])
+            _msg = f"{_msg}:\n    {_dev_msg}"
+        else:
+            dev = serial_nums[0]
+            _msg = f"{_msg} [cyan]{dev}[/]"
+
     print(_msg)
     if yes or typer.confirm("\nProceed?"):
-        resp = cli.central.request(cli.central.assign_licenses, serial_nums, services=license.name)
+        if not do_auto:
+            resp = cli.central.request(cli.central.assign_licenses, serial_nums, services=license.name)
+        else:
+            resp = cli.central.request(cli.central.enable_auto_subscribe, services=license.name)
+
         cli.display_results(resp, tablefmt="action")
     # TODO cache update similar to batch unsubscribe
 

{centralcli-2.3.0 → centralcli-2.3.1}/centralcli/clibatch.py

@@ -1011,6 +1011,11 @@ def batch_delete_devices(data: Union[list, dict], *, ui_only: bool = False, yes:
         br(cli.central.unarchive_devices, (inv_del_serials,)),
     ]
 
+    # cop only delete devices from GreenLake inventory
+    cop_del_reqs = [] if not inv_del_serials or not config.is_cop else [
+        br(cli.central.cop_delete_device_from_inventory, inv_del_serials)
+    ]
+
     # build reqs to remove devs from monit views.  Down devs now, Up devs delayed to allow time to disc.
     mon_del_reqs, delayed_mon_del_reqs = [], []
     for dev_type, _devs in zip(["ap", "switch", "gateway"], [aps, switches, gws]):
@@ -1034,7 +1039,7 @@ def batch_delete_devices(data: Union[list, dict], *, ui_only: bool = False, yes:
         print("")
 
     # None of the provided devices were found in cache or inventory
-    if not [*reqs, *mon_del_reqs, *delayed_mon_del_reqs]:
+    if not [*reqs, *mon_del_reqs, *delayed_mon_del_reqs, *cop_del_reqs]:
         print("Everything is as it should be, nothing to do.")
         raise typer.Exit(0)
 
@@ -1043,7 +1048,7 @@ def batch_delete_devices(data: Union[list, dict], *, ui_only: bool = False, yes:
     if len(cache_devs) > 1:
         _msg += "\n".join([f"       {d.summary_text}" for d in cache_devs[1:]])
 
-    _total_reqs = len([*reqs, *mon_del_reqs, *delayed_mon_del_reqs]) if not ui_only else len(mon_del_reqs)
+    _total_reqs = len([*reqs, *cop_del_reqs, *mon_del_reqs, *delayed_mon_del_reqs]) if not ui_only else len(mon_del_reqs)
 
     if ui_only:
         if delayed_mon_del_reqs:
@@ -1066,7 +1071,7 @@ def batch_delete_devices(data: Union[list, dict], *, ui_only: bool = False, yes:
             console.print("[italic]Cache has not been updated, [cyan]cencli show all -v[/ cyan] will result in a full cache update.[/ italic]")
             cli.display_results(batch_resp, exit_on_fail=True, caption="Re-run command to perform remaining actions.")
 
-    if not delayed_mon_del_reqs:
+    if not delayed_mon_del_reqs and not cop_del_reqs:
         # if all reqs OK cache is updated by deleting specific items, otherwise it's a full cache refresh
         all_ok = True if all(r.ok for r in batch_resp) else False
 
@@ -1096,33 +1101,47 @@ def batch_delete_devices(data: Union[list, dict], *, ui_only: bool = False, yes:
         cli.display_results(batch_resp, tablefmt="action")
         raise typer.Exit(0)
 
-    del_resp = []
-    del_reqs_try = delayed_mon_del_reqs.copy()
-    _delay = 10 if not switches else 30  # switches take longer to drop off
-    for _try in range(4):
-        _word = "more " if _try > 0 else ""
-        _prefix = "" if _try == 0 else f"\[Attempt {_try + 1}] "
-        _delay -= (5 * _try) # reduce delay by 5 secs for each request
-        for _ in track(range(_delay), description=f"{_prefix}[green]Allowing {_word}time for devices to disconnect."):
-            sleep(1)
-
-        _del_resp = cli.central.batch_request(del_reqs_try, continue_on_fail=True)
-        if _try == 3:
-            if not all([r.ok for r in _del_resp]):
-                print("\n[dark_orange]:warning:[/] Retries exceeded. Devices still remain Up in central and cannot be deleted.  This command can be re-ran once they have disconnected.")
-            del_resp += _del_resp
-        else:
-            del_resp += [r for r in _del_resp if r.ok or isinstance(r.output, dict) and r.output.get("error_code", "") != "0007"]
+    elif delayed_mon_del_reqs:
+        del_resp = []
+        del_reqs_try = delayed_mon_del_reqs.copy()
+        _delay = 10 if not switches else 30  # switches take longer to drop off
+        for _try in range(4):
+            _word = "more " if _try > 0 else ""
+            _prefix = "" if _try == 0 else f"\[Attempt {_try + 1}] "
+            _delay -= (5 * _try) # reduce delay by 5 secs for each request
+            for _ in track(range(_delay), description=f"{_prefix}[green]Allowing {_word}time for devices to disconnect."):
+                sleep(1)
 
-        del_reqs_try = [del_reqs_try[idx] for idx, r in enumerate(_del_resp) if not r.ok and isinstance(r.output, dict) and r.output.get("error_code", "") == "0007"]
-        if del_reqs_try:
-            print(f"{len(del_reqs_try)} out of {len(*mon_del_reqs, *delayed_mon_del_reqs)} device{'s are' if len(del_reqs_try) > 1 else ' is'} still [bright_green]Up[/] in Central")
-        else:
-            break
+            _del_resp = cli.central.batch_request(del_reqs_try, continue_on_fail=True)
+            if _try == 3:
+                if not all([r.ok for r in _del_resp]):
+                    print("\n[dark_orange]:warning:[/] Retries exceeded. Devices still remain Up in central and cannot be deleted.  This command can be re-ran once they have disconnected.")
+                del_resp += _del_resp
+            else:
+                del_resp += [r for r in _del_resp if r.ok or isinstance(r.output, dict) and r.output.get("error_code", "") != "0007"]
 
-    batch_resp += del_resp or _del_resp
+            del_reqs_try = [del_reqs_try[idx] for idx, r in enumerate(_del_resp) if not r.ok and isinstance(r.output, dict) and r.output.get("error_code", "") == "0007"]
+            if del_reqs_try:
+                print(f"{len(del_reqs_try)} out of {len(*mon_del_reqs, *delayed_mon_del_reqs)} device{'s are' if len(del_reqs_try) > 1 else ' is'} still [bright_green]Up[/] in Central")
+            else:
+                break
+
+        batch_resp += del_resp or _del_resp
+
+    # On COP delete devices from GreenLake inventory (only available on CoP)
+    # TODO test against a cop system
+    # TODO add to cencli delete device ...
+    if cop_del_reqs:
+        cop_del_resp = cli.central.batch_request(cop_del_reqs)
+        if not all(r.ok for r in cop_del_resp):
+            print("[bright_red]Errors occured during CoP GreenLake delete")
+            cli.display_results(cop_del_resp, tablefmt="action")
+        else:
+            # display results (below) with results of previous calls
+            batch_resp += cop_del_resp
 
     # TODO need to update cache after ui-only delete
+    # TODO need to improve logic throughout and update inventory cache
     if batch_resp:
         with console.status("Performing cache updates..."):
             db_updates = []
@@ -1804,7 +1823,7 @@ def move(
     elif not import_file:
         _msg = [
             "Usage: cencli batch move [OPTIONS] WHAT:[devices] IMPORT_FILE",
-            "Try 'cencli batch add ?' for help.",
+            "Try 'cencli batch move ?' for help.",
             "",
             "Error: One of 'IMPORT_FILE' or --example should be provided.",
         ]
@@ -1814,6 +1833,109 @@ def move(
         resp = batch_move_devices(import_file, yes=yes, do_group=do_group, do_site=do_site, do_label=do_label)
         cli.display_results(resp, tablefmt="action")
 
+
+@app.command()
+def archive(
+    import_file: Path = typer.Argument(None, exists=True, show_default=False,),
+    show_example: bool = typer.Option(False, "--example", help="Show Example import file format.", show_default=False),
+    yes: bool = typer.Option(False, "-Y", "-y", help="Bypass confirmation prompts - Assume Yes"),
+    default: bool = typer.Option(
+        False, "-d", is_flag=True, help="Use default central account", show_default=False,
+        callback=cli.default_callback,
+    ),
+    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)",
+    ),
+) -> None:
+    """Batch archive devices based on import data from file.
+
+    This will archive the devices in GreenLake
+    """
+    if show_example:
+        print(examples.archive)
+        return
+
+    elif not import_file:
+        _msg = [
+            "Usage: cencli batch archive [OPTIONS] WHAT:[devices] IMPORT_FILE",
+            "Try 'cencli batch archive ?' for help.",
+            "",
+            "Error: One of 'IMPORT_FILE' or --example should be provided.",
+        ]
+        print("\n".join(_msg))
+        raise typer.Exit(1)
+    else:
+        data = config.get_file_data(import_file, text_ok=True)
+        if data and isinstance(data, list):
+            if all([isinstance(x, dict) for x in data]):
+                serials = [x.get("serial") or x.get("serial_num") for x in data]
+            elif all(isinstance(x, str) for x in data):
+                serials = data if not data[0].lower().startswith("serial") else data[1:]
+        else:
+            print(f"[bright_red]Error[/] Unexpected data structure returned from {import_file.name}")
+            print("Use [cyan]cencli batch archive --example[/] to see expected format.")
+            raise typer.Exit(1)
+
+        res = cli.central.request(cli.central.archive_devices, (serials,))
+        cli.display_results(res)
+
+
+@app.command()
+def unarchive(
+    import_file: Path = typer.Argument(None, exists=True, show_default=False,),
+    show_example: bool = typer.Option(False, "--example", help="Show Example import file format.", show_default=False),
+    yes: bool = typer.Option(False, "-Y", "-y", help="Bypass confirmation prompts - Assume Yes"),
+    default: bool = typer.Option(
+        False, "-d", is_flag=True, help="Use default central account", show_default=False,
+        callback=cli.default_callback,
+    ),
+    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)",
+    ),
+) -> None:
+    """Batch unarchive devices based on import data from file.
+
+    This will unarchive the devices (previously archived) in GreenLake
+    """
+    if show_example:
+        print(examples.unarchive)
+        return
+
+    elif not import_file:
+        _msg = [
+            "Usage: cencli batch unarchive [OPTIONS] WHAT:[devices] IMPORT_FILE",
+            "Try 'cencli batch unarchive ?' for help.",
+            "",
+            "Error: One of 'IMPORT_FILE' or --example should be provided.",
+        ]
+        print("\n".join(_msg))
+        raise typer.Exit(1)
+    else:
+        data = config.get_file_data(import_file, text_ok=True)
+        if data and isinstance(data, list):
+            if all([isinstance(x, dict) for x in data]):
+                serials = [x.get("serial") or x.get("serial_num") for x in data]
+            elif all(isinstance(x, str) for x in data):
+                serials = data if not data[0].lower().startswith("serial") else data[1:]
+        else:
+            print(f"[bright_red]Error[/] Unexpected data structure returned from {import_file.name}")
+            print("Use [cyan]cencli batch unarchive --example[/] to see expected format.")
+            raise typer.Exit(1)
+
+        res = cli.central.request(cli.central.unarchive_devices, (serials,))
+        cli.display_results(res)
+
+
 @app.callback()
 def callback():
     """

{centralcli-2.3.0 → centralcli-2.3.1}/centralcli/clishow.py

@@ -580,6 +580,13 @@ def subscription(
         title = "Subscription Details"
         _cleaner = cleaner.get_subscriptions
         set_width_cols = {"name": 40}
+    elif what == "auto":
+        resp = cli.central.request(cli.central.get_auto_subscribe)
+        if resp and "services" in resp.output:
+            resp.output = resp.output["services"]
+        title = "Services with auto-subscribe enabled"
+        _cleaner = None
+        set_width_cols = None
     elif what == "stats":
         resp = cli.central.request(cli.central.get_subscription_stats)
         title = "Subscription Stats"
@@ -603,6 +610,7 @@ def subscription(
         set_width_cols=set_width_cols
     )
 
+
 # TODO need sort_by enum
 @app.command(short_help="Show Swarms (IAP Clusters)")
 def swarms(

{centralcli-2.3.0 → centralcli-2.3.1}/centralcli/cliunassign.py

@@ -27,10 +27,10 @@ iden = IdenMetaVars()
 app = typer.Typer()
 
 
-@app.command(help="unassign License from device(s)")
+@app.command()
 def license(
     license: cli.cache.LicenseTypes = typer.Argument(..., help="License type to unassign from device(s).", show_default=False),
-    devices: List[str] = typer.Argument(..., metavar=iden.dev_many, autocompletion=cli.cache.dev_completion),
+    devices: List[str] = typer.Argument(..., help="device serial numbers or 'auto' to disable auto-subscribe.", metavar=iden.dev_many, autocompletion=cli.cache.dev_completion),
     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",),
     default: bool = typer.Option(False, "-d", is_flag=True, help="Use default central account", show_default=False,),
@@ -39,6 +39,19 @@ def license(
                                 help="The Aruba Central Account to use (must be defined in the config)",
                                 autocompletion=cli.cache.account_completion),
 ) -> None:
+    """Unssign Licenses from devices by serial number(s) or disable auto-subscribe for the license type.
+    """
+    do_auto = True if "auto" in [s.lower() for s in devices] else False
+    if do_auto:
+        _msg = f"Disable Auto-assignment of [bright_green]{license}[/bright_green] to applicable devices."
+        if len(devices) > 1:
+            print(f'[cyan]auto[/] keyword provided remaining entries will be [bright_red]ignored[/]')
+        print(_msg)
+        if yes or typer.confirm("\nProceed?"):
+            resp = cli.central.request(cli.central.disable_auto_subscribe, services=license.name)
+            cli.display_results(resp, tablefmt="action")
+            return
+
     try:
         devices: CentralObject = [cli.cache.get_dev_identifier(dev) for dev in devices]
     except typer.Exit:  # allows un-assignment of devices that never checked into Central

{centralcli-2.3.0 → centralcli-2.3.1}/centralcli/config.py

@@ -279,6 +279,7 @@ class Config:
         self.debugv: bool = self.data.get("debugv", False)
         self.sanitize: bool = self.data.get("sanitize", False)
         self.account = self.get_account_from_args()
+        self.base_url = self.data.get(self.account, {}).get("base_url")
         try:
             self.webhook = WebHook(**self.data.get(self.account, {}).get("webhook", {}))
         except ValidationError:
@@ -319,6 +320,10 @@ class Config:
         else:
             return self.data.get("central_info", {}).get(item, default)
 
+    @property
+    def is_cop(self):
+        return False if self.base_url.endswith("arubanetworks.com") else True
+
     # not used but may be handy
     @property
     def tokens(self):

{centralcli-2.3.0 → centralcli-2.3.1}/centralcli/constants.py

@@ -333,6 +333,7 @@ class SubscriptionArgs(str, Enum):
     details = "details"
     stats = "stats"
     names = "names"
+    auto = "auto"
 
 class ArgToWhat:
     def __init__(self):

{centralcli-2.3.0 → centralcli-2.3.1}/centralcli/strings.py

@@ -352,6 +352,8 @@ class ImportExamples:
         self.deploy = clibatch_deploy
         self.subscribe = clibatch_subscribe
         self.unsubscribe = clibatch_unsubscribe
+        self.archive = clibatch_unsubscribe.replace("unsubscribe", "archive")
+        self.unarchive = clibatch_unsubscribe.replace("unsubscribe", "unarchive")
         self.move_devices = clibatch_move_devices
 
     def __getattr__(self, key: str):

{centralcli-2.3.0 → centralcli-2.3.1}/pyproject.toml

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