hcs-cli 0.1.318__py3-none-any.whl → 0.1.320__py3-none-any.whl

hcs_cli/cmds/inventory/delete.py

@@ -0,0 +1,48 @@
+"""
+Copyright 2023-2023 VMware Inc.
+SPDX-License-Identifier: Apache-2.0
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+import click
+from hcs_core.ctxp import recent
+import hcs_core.sglib.cli_options as cli
+
+from hcs_cli.service import inventory
+from hcs_cli.support.param_util import parse_vm_path
+
+
+@click.command()
+@cli.org_id
+@click.argument("vm_path", type=str, required=False)
+def delete(org: str, vm_path: str):
+    """Delete a VM by path, e.g., template1/vm1, or 'vm1,vm2,vm3'."""
+
+    org_id = cli.get_org_id(org)
+
+    if vm_path.find(",") > 0:
+        vm_ids = [v.strip() for v in vm_path.split(",")]
+        template_id = recent.require("template", None)
+    else:
+        template_id, vm_id = parse_vm_path(vm_path)
+        ret = inventory.get(template_id, vm_id, org_id)
+        if not ret:
+            return "", 1
+        vm_ids = [vm_id]
+
+    ret = {"_requested_ids": vm_ids, "_accepted_ids": [], "_deleted": 0}
+    vms = inventory.begin_deleting_vms_by_id(template_id, org_id, vm_ids)
+    for vm in vms:
+        ret["_accepted_ids"].append(vm["id"])
+    actual_deleted = inventory.finish_deleting_vms(template_id, org_id, vm_ids)
+    ret["_deleted"] = actual_deleted
+    return ret

hcs_cli/cmds/lcm/provider/create.py

@@ -63,6 +63,12 @@ from hcs_cli.support import constant
     required=False,
     help="",
 )
+@click.option(
+    "--subscription-id",
+    type=str,
+    required=False,
+    help="",
+)
 @click.option(
     "--file",
     "-f",
@@ -80,6 +86,7 @@ def create(
     client_id: str,
     client_secret: str,
     tenant_id: str,
+    subscription_id: str,
     file: str,
     org: str,
     **kwargs,
@@ -108,7 +115,7 @@ def create(
             "description": description,
             "credentialId": credential_id,
         }
-    elif client_id or client_secret or tenant_id:
+    elif client_id or client_secret or tenant_id or subscription_id:
         if type != "AZURE":
             raise click.BadParameter("client-id is only supported for Azure provider.")
         if not client_id:
@@ -117,7 +124,8 @@ def create(
             raise click.BadParameter("client-secret is required for client-id.")
         if not tenant_id:
             raise click.BadParameter("tenant-id is required for Azure provider.")
-
+        if not subscription_id:
+            raise click.BadParameter("subscription-id is required for Azure provider.")
         data = {
             "id": id if id else _rand_id(8),
             "type": type,
@@ -126,6 +134,7 @@ def create(
             "description": description,
             "credentialId": credential_id,
             "tenantId": tenant_id,
+            "subscriptionId": subscription_id,
             "credentials": [
                 {
                     "clientId": client_id,

hcs_cli/cmds/lcm/template/expand.py

@@ -0,0 +1,46 @@
+"""
+Copyright 2023-2023 VMware Inc.
+SPDX-License-Identifier: Apache-2.0
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+import click
+import hcs_core.sglib.cli_options as cli
+
+import hcs_cli.service.lcm as lcm
+from hcs_cli.cmds.template.expand import expand_impl
+
+
+@click.command(hidden=True)
+@click.option(
+    "--number",
+    "-n",
+    type=int,
+    required=False,
+    default=0,
+    help="Number of VMs to expand. Use negative number to shrink.",
+)
+@click.option(
+    "--to",
+    "-t",
+    type=int,
+    required=False,
+    default=0,
+    help="Expected size of template.",
+)
+@click.argument("template_id", type=str, required=False)
+@cli.org_id
+@cli.wait
+def expand(number: int, to: int, template_id: str, org: str, wait: str):
+    """Update an existing template"""
+
+    return expand_impl(number, to, template_id, org, wait, lcm)

hcs_cli/cmds/lcm/vm/delete.py

@@ -24,8 +24,9 @@ from hcs_cli.support.param_util import parse_vm_path
 @click.argument("vm_path", type=str, required=False)
 @cli.org_id
 @cli.confirm
+@cli.force
 @cli.wait
-def delete(vm_path: str, org: str, confirm: bool, wait: str, **kwargs):
+def delete(vm_path: str, org: str, confirm: bool, force: bool, wait: str, **kwargs):
     """Delete VM"""
     template_id, vm_id = parse_vm_path(vm_path)
     org_id = cli.get_org_id(org)
@@ -37,7 +38,7 @@ def delete(vm_path: str, org: str, confirm: bool, wait: str, **kwargs):
     if not confirm:
         click.confirm(f"Delete VM {template_id}/{vm_id}?", abort=True)
 
-    vm.delete(template_id, vm_id, org_id, **kwargs)
+    vm.delete(template_id, vm_id, org_id, force=force, **kwargs)
 
     if wait == "0":
         return

hcs_cli/cmds/scm/plan.py

@@ -16,11 +16,13 @@ limitations under the License.
 import json
 import re
 import sys
+from datetime import datetime, timedelta
 from os import path
 
 import click
 import hcs_core.sglib.cli_options as cli
-from hcs_core.ctxp import data_util, recent
+import yumako
+from hcs_core.ctxp import data_util, recent, util
 from hcs_core.sglib.client_util import wait_for_res_status
 
 import hcs_cli.service.scm as scm
@@ -33,6 +35,98 @@ def plan():
     pass
 
 
+def _get_next_slot_name():
+    """
+    Get the current and next half-hour aligned slot names and time delta based on current UTC time.
+
+    Slots are half-hour aligned (HH:00 or HH:30).
+
+    Returns:
+        tuple: (current_slot_name, next_slot_name, timedelta_to_next_slot)
+               where slot names are in format 'weekday/HH:MM' (e.g., 'monday/18:00')
+               and timedelta_to_next_slot is a timedelta object
+    """
+    current_time_utc = datetime.utcnow()
+
+    # Weekday names mapping (0=Monday, 6=Sunday in Python's weekday())
+    weekday_names = ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"]
+
+    # Get current half-hour aligned slot (round down)
+    current_minute = current_time_utc.minute
+    if current_minute < 30:
+        # Current slot is this hour:00
+        current_slot_time = current_time_utc.replace(minute=0, second=0, microsecond=0)
+    else:
+        # Current slot is this hour:30
+        current_slot_time = current_time_utc.replace(minute=30, second=0, microsecond=0)
+
+    current_weekday_name = weekday_names[current_slot_time.weekday()]
+    current_time_str = current_slot_time.strftime("%H:%M")
+    current_slot_name = f"{current_weekday_name}/{current_time_str}"
+
+    # Get next half-hour aligned slot
+    if current_minute < 30:
+        # Next slot is this hour:30
+        next_time = current_time_utc.replace(minute=30, second=0, microsecond=0)
+    else:
+        # Next slot is next hour:00
+        next_time = current_time_utc + timedelta(hours=1)
+        next_time = next_time.replace(minute=0, second=0, microsecond=0)
+
+    next_weekday_name = weekday_names[next_time.weekday()]
+    next_time_str = next_time.strftime("%H:%M")
+    next_slot_name = f"{next_weekday_name}/{next_time_str}"
+
+    timedelta_to_next = next_time - current_time_utc
+
+    return current_slot_name, next_slot_name, timedelta_to_next
+
+
+def _format_scm_plan_task_table(data):
+    fields_mapping = {
+        "location": "Location",
+        "_slot": "Slot",
+        "_timeCreatedStale": "Time Created",
+    }
+
+    current_slot_name, next_slot_name, timedelta_to_next = _get_next_slot_name()
+    time_str_to_next = yumako.time.display(timedelta_to_next.total_seconds())
+
+    for d in data:
+        d["_timeCreatedStale"] = yumako.time.stale(d["timeCreated"] / 1000)
+        meta = d["meta"]
+        input = d["input"]
+        my_slot_name = meta["scm_plan_day"] + "/" + meta["scm_plan_slot"]
+        d["_slot"] = my_slot_name
+
+        if d["worker"] == "com.vmware.horizon.sg.scm.task.CapacityOptimization":
+            d["_idealCapacity"] = input["idealCapacity"]
+            d["_forecastCapacity"] = input["forecastCapacity"]
+            d["_taskKey"] = d["key"]
+
+            if my_slot_name == next_slot_name:
+                d["_nextExecution"] = click.style(f"In {time_str_to_next}", fg="bright_blue")
+            else:
+                d["_nextExecution"] = ""
+            fields_mapping["_nextExecution"] = "Next"
+
+            if my_slot_name == current_slot_name:
+                # d['_lastExecutedStale'] = 'TODO'
+                # d['_lastExecutionStatus'] = 'TODO'
+                # fields_mapping['_lastExecutedStale'] = 'Executed'
+                # fields_mapping['_lastExecutionStatus'] = 'Status'
+                pass
+
+            fields_mapping["_idealCapacity"] = "Ideal"
+            fields_mapping["_forecastCapacity"] = "Forecast"
+            fields_mapping["_taskKey"] = "Task Key"
+        else:
+            # TODO other worker types
+            pass
+
+    return util.format_table(data, fields_mapping)
+
+
 @plan.command
 @click.option("--template", help="Filter plan by template.")
 @click.option("--task", help="Filter plan by task class name.")
@@ -99,7 +193,7 @@ def delete(org: str, name: str, confirm: bool, **kwargs):
 
 @plan.command
 @cli.org_id
-@cli.limit
+@cli.limit(default=336)
 @click.option("--day", required=False, help="Search by day-identifier. Example: Monday")
 @click.option("--time", required=False, help="Search by time. Example: 13:30")
 @click.option("--slot", required=False, help="Search by time slot. Example: Mon/13:30")
@@ -111,6 +205,7 @@ def delete(org: str, name: str, confirm: bool, **kwargs):
     help="Search by task state, as comma-separated values. E.g. 'init,running,success,error', or 'all'.",
 )
 @click.argument("name", required=False)
+@cli.formatter(_format_scm_plan_task_table)
 def tasks(org: str, limit: int, day: str, time: str, slot: str, name: str, state: str, **kwargs):
     """Get tasks of a named calendar plan."""
     org = cli.get_org_id(org)
@@ -134,6 +229,40 @@ def tasks(org: str, limit: int, day: str, time: str, slot: str, name: str, state
     ret = scm.plan.tasks(org_id=org, id=name, limit=limit, day=day, slot=time, states=state, **kwargs)
     if ret is None:
         return "", 1
+
+    # sort tasks by slot.
+    for t in ret:
+        meta = t["meta"]
+        d = meta["scm_plan_day"]
+        if d == "sunday":
+            d = "0"
+        elif d == "monday":
+            d = "1"
+        elif d == "tuesday":
+            d = "2"
+        elif d == "wednesday":
+            d = "3"
+        elif d == "thursday":
+            d = "4"
+        elif d == "friday":
+            d = "5"
+        elif d == "saturday":
+            d = "6"
+        else:
+            raise ValueError("Invalid day name in task meta: " + d)
+        t["_slot"] = d + "/" + meta["scm_plan_slot"]
+    ret = sorted(ret, key=lambda x: x["_slot"])
+    for t in ret:
+        del t["_slot"]
+
+    # identify the current task result
+    # current_slot_name, next_slot_name, timedelta_to_next = _get_next_slot_name()
+    # for t in ret:
+    #     meta = t['meta']
+    #     my_slot_name = meta['scm_plan_day'] + '/' + meta['scm_plan_slot']
+    #     if current_slot_name == my_slot_name:
+    #         break
+
     return ret
 
 
@@ -343,7 +472,6 @@ def run(org: str, name: str, slot: str, config: str, wait: str, **kwargs):
 
 
 def _wait_for_task(org_id: str, name: str, task_key: str, timeout: str):
-
     return wait_for_res_status(
         resource_name=name + "/" + task_key,
         fn_get=lambda: scm.plan.get_task(org_id, name, task_key),

hcs_cli/cmds/task.py

@@ -13,8 +13,6 @@ See the License for the specific language governing permissions and
 limitations under the License.
 """
 
-import json
-
 import click
 import hcs_core.sglib.cli_options as cli
 import yumako
@@ -29,9 +27,9 @@ def _format_task_table(data):
         schedule = d.get("schedule")
         if schedule:
             if schedule.get("intervalMs"):
-                recurring = f'Every {yumako.time.display(schedule["intervalMs"] / 1000)}'
+                recurring = f"Every {yumako.time.display(schedule['intervalMs'] / 1000)}"
             elif schedule.get("cronExpression"):
-                recurring = f'{schedule["cronExpression"]}'
+                recurring = f"{schedule['cronExpression']}"
             else:
                 recurring = "<No>"
         else:

hcs_cli/cmds/template/expand.py

@@ -27,39 +27,84 @@ import hcs_cli.service.admin as admin
     "-n",
     type=int,
     required=False,
-    default=1,
+    default=0,
     help="Number of VMs to expand. Use negative number to shrink.",
 )
+@click.option(
+    "--to",
+    "-t",
+    type=int,
+    required=False,
+    default=0,
+    help="Expected size of template.",
+)
 @click.argument("template_id", type=str, required=False)
 @cli.org_id
 @cli.wait
-def expand(number: int, template_id: str, org: str, wait: str, **kwargs):
+def expand(number: int, to: int, template_id: str, org: str, wait: str):
     """Update an existing template"""
+    return expand_impl(number, to, template_id, org, wait, admin)
+
+
+def expand_impl(number: int, to: int, template_id: str, org: str, wait: str, service):
+    if to != 0 and number != 0:
+        return "Specify either --to or --number, not both.", 1
+    if to < 0:
+        return "--to must be non-negative.", 1
+    if to > 5000:
+        return "--to exceeds maximum limit of 5000.", 1
 
     org_id = cli.get_org_id(org)
 
     template_id = recent.require("template", template_id)
-    template = admin.template.get(template_id, org_id)
+    template = service.template.get(template_id, org_id)
 
     if not template:
-        return "Template not found: " + template_id
+        return "Template not found: " + template_id, 1
 
     spare_policy = template.get("sparePolicy", {})
-    patch = {
-        "sparePolicy": {
-            "min": spare_policy.get("min", 0) + number,
-            "max": spare_policy.get("max", 0) + number,
-            "limit": spare_policy.get("limit", 0) + number,
-        }
+    new_spare_policy = {
+        "min": spare_policy.get("min", 0),
+        "max": spare_policy.get("max", 0),
+        "limit": spare_policy.get("limit", 0),
     }
-    if patch["sparePolicy"]["min"] < 0:
-        patch["sparePolicy"]["min"] = 0
-    if patch["sparePolicy"]["max"] < 0:
-        patch["sparePolicy"]["max"] = 0
-    if patch["sparePolicy"]["limit"] < 0:
-        patch["sparePolicy"]["limit"] = 0
-
-    ret = admin.template.update(template_id, org_id, patch)
+
+    if to != 0:
+        new_spare_policy["min"] = to
+        new_spare_policy["max"] = to
+        new_spare_policy["limit"] = to
+    else:
+        if number == 0:
+            number = 1  # default to expand by 1
+        new_spare_policy["min"] += number
+        new_spare_policy["max"] += number
+        new_spare_policy["limit"] += number
+
+        if new_spare_policy["limit"] < 0:
+            new_spare_policy["limit"] = 0
+        elif new_spare_policy["limit"] > 5000:
+            new_spare_policy["limit"] = 5000
+
+        if new_spare_policy["min"] < 0:
+            new_spare_policy["min"] = 0
+        elif new_spare_policy["min"] > new_spare_policy["limit"]:
+            new_spare_policy["min"] = new_spare_policy["limit"]
+        if new_spare_policy["max"] < 0:
+            new_spare_policy["max"] = 0
+        elif new_spare_policy["max"] > new_spare_policy["limit"]:
+            new_spare_policy["max"] = new_spare_policy["limit"]
+
+    if (
+        new_spare_policy["min"] == spare_policy.get("min", 0)
+        and new_spare_policy["max"] == spare_policy.get("max", 0)
+        and new_spare_policy["limit"] == spare_policy.get("limit", 0)
+    ):
+        # no change
+        ret = template
+    else:
+        patch = {"sparePolicy": new_spare_policy}
+        ret = service.template.patch(template_id, org_id, patch)
+
     if wait != "0":
-        ret = admin.template.wait_for_ready(template_id, org_id, duration.to_seconds(wait))
+        ret = service.template.wait_for_ready(template_id, org_id, duration.to_seconds(wait))
     return ret

hcs_cli/cmds/template/list_usage.py

@@ -111,8 +111,8 @@ def list_usage(org: str, **kwargs):
             "addedVmHours": summary.get("addedVmHours"),
             "offloadVmHours": summary.get("offloadVmHours"),
             "reducedVmHours": summary.get("reducedVmHours"),
-            "historyVmUtilizationPercent": f'{summary.get("historyVmUtilizationPercent", 0)}%',
-            "predictionVmUtilizationPercent": f'{summary.get("predictionVmUtilizationPercent", 0)}%',
+            "historyVmUtilizationPercent": f"{summary.get('historyVmUtilizationPercent', 0)}%",
+            "predictionVmUtilizationPercent": f"{summary.get('predictionVmUtilizationPercent', 0)}%",
         }
 
         ret2.append(item)

hcs_cli/cmds/template/update.py

@@ -43,7 +43,7 @@ def update(template_id: str, update, org: str, wait: str, **kwargs):
     template = admin.template.get(template_id, org_id)
 
     if not template:
-        return "Template not found: " + template_id
+        return "Template not found: " + template_id, 1
 
     allowed_fields = ["name", "description", "powerPolicy", "sparePolicy", "applicationProperties", "flags"]
 
@@ -52,7 +52,7 @@ def update(template_id: str, update, org: str, wait: str, **kwargs):
     if not patch:
         return template
 
-    ret = admin.template.update(template_id, org_id, patch)
+    ret = admin.template.patch(template_id, org_id, patch)
     if wait != "0":
         ret = admin.template.wait_for_ready(template_id, org_id, duration.to_seconds(wait))
     return ret

hcs_cli/cmds/template/usage.py

@@ -13,6 +13,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 """
 
+import json
 import os
 import tempfile
 import time
@@ -32,17 +33,28 @@ def _timestamp_to_date(timestamp: int):
 
 
 @click.command(hidden=True)
+@click.option(
+    "--local-plan-file",
+    type=str,
+    required=False,
+    help="Instead of reading from API, read from local file for the template usage data. Debug only.",
+)
 @click.argument("id", type=str, required=False)
 @cli.org_id
-def usage(id: str, org: str, **kwargs):
+def usage(id: str, org: str, local_plan_file: str = None, **kwargs):
     """Show usage visualization"""
 
     org_id = cli.get_org_id(org)
     id = recent.require("template", id)
 
-    usage = scm.template_usage(org_id, id)
-    if not usage:
-        return "No usage data found", 1
+    if local_plan_file:
+        with open(local_plan_file, "r") as f:
+            plan_data = json.load(f)
+            usage = plan_data["meta"]
+    else:
+        usage = scm.template_usage(org_id, id)
+        if not usage:
+            return "No usage data found", 1
 
     x_axis = []
     consumed_capacity = []
@@ -61,8 +73,9 @@ def usage(id: str, org: str, **kwargs):
         x_axis.append(_timestamp_to_date(t))
         max_capacity = history["maxCapacity"][i]
         min_free = history["minFree"][i]
-        consumed_capacity.append(max_capacity - min_free)
-        spare_capacity.append(min_free)
+        # consumed_capacity.append(max_capacity - min_free)
+        consumed_capacity.append(history["poweredOnAssignedVms"][i])
+        spare_capacity.append(max_capacity - consumed_capacity[-1])
         no_spare_error.append(history["noSpare"][i])
 
     start_timestamp = prediction["startTimestamp"]
@@ -72,7 +85,7 @@ def usage(id: str, org: str, **kwargs):
         max_capacity = prediction["maxCapacity"][i]
         min_free = prediction["minFree"][i]
         ideal_capacity = prediction["idealCapacity"][i]
-        consumed_capacity_predicated.append(ideal_capacity - min_free)
+        consumed_capacity_predicated.append(ideal_capacity)
         spare_capacity_predicated.append(min_free)
         optimized_capacity.append(ideal_capacity)
         no_spare_error_predicated.append(prediction["noSpare"][i])

hcs_cli/cmds/vm/delete.py

@@ -23,10 +23,11 @@ from hcs_cli.support.param_util import parse_vm_path
 
 @click.command()
 @click.argument("vm_path", type=str, required=False)
+@cli.force
 @cli.org_id
 @cli.confirm
 @cli.wait
-def delete(vm_path: str, org: str, confirm: bool, wait: str, **kwargs):
+def delete(vm_path: str, org: str, confirm: bool, force: bool, wait: str, **kwargs):
     """Delete a VM by ID"""
     org_id = cli.get_org_id(org)
     template_id, vm_id = parse_vm_path(vm_path)
@@ -41,7 +42,7 @@ def delete(vm_path: str, org: str, confirm: bool, wait: str, **kwargs):
     if not confirm:
         click.confirm(f"Delete vm {existing['id']} from template {template['name']} ({template['id']})?", abort=True)
 
-    vm.delete()
+    vm.delete(force=force)
 
     if wait == "0":
         return