hcs-cli 0.1.352__tar.gz → 0.1.353__tar.gz

hcs_cli-0.1.353/.gitignore

@@ -0,0 +1,188 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintainted in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+
+tmp/
+state/
+*.log
+*.exe
+.DS_Store
+*.bak
+t.py
+logs/*.log
+lab/
+*.state.yml
+
+hcsenv/
+.govmomi/
+ops/*.json
+ops/*.txt
+ops/*.yaml
+ops/*.yml
+t.json
+t.py
+.ruff_cache/
+exp/.data
+/uag*
+*.key
+*.crt
+*.pem
+temp/

hcs_cli-0.1.353/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: hcs-cli
+Version: 0.1.353
+Summary: Horizon Cloud Service CLI.
+Project-URL: Homepage, https://github.com/euc-eng/hcs-cli
+Project-URL: Bug Tracker, https://github.com/euc-eng/hcs-cli/issues
+Project-URL: documentation, https://readthedocs.org
+Project-URL: repository, https://github.com/euc-eng/hcs-cli
+Project-URL: changelog, https://github.com/euc-eng/hcs-cli/blob/main/CHANGELOG.md
+Author-email: Nanw1103 <nanw1103@gmail.com>
+Keywords: CLI,Horizon,Horizon Cloud,Horizon Cloud Service
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Requires-Dist: hcs-core>=0.1.353
+Requires-Dist: inquirerpy>=0.3.4
+Requires-Dist: paho-mqtt>=2.1.0
+Requires-Dist: reportlab>=5.0.1
+Provides-Extra: dev
+Requires-Dist: bandit; extra == 'dev'
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: flake8; extra == 'dev'
+Requires-Dist: hatch; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pylint; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Requires-Dist: vulture; extra == 'dev'
+Requires-Dist: wheel; extra == 'dev'
+Requires-Dist: yamlfix; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# horizon-cloud-service-cli
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+
+- [horizon-cloud-service-cli](#horizon-cloud-service-cli)
+  - [Overview](#overview)
+  - [Try it out](#try-it-out)
+    - [Prerequisites](#prerequisites)
+    - [Installation](#installation)
+      - [Use the CLI](#use-the-cli)
+  - [Documentation](#documentation)
+  - [Contributing](#contributing)
+  - [License](#license)
+
+## Overview
+
+hcs-cli is a human-friendly command line toolbox for [Omnissa Horizon Cloud Service (HCS)](https://www.omnissa.com/products/horizon-cloud/), based on public REST APIs.
+
+## Try it out
+
+### Prerequisites
+
+- Python 3.9+
+- [uv](https://docs.astral.sh/uv/getting-started/installation/) or [pipx](https://pipx.pypa.io/stable/installation/)
+
+### Installation
+
+Using uv:
+
+```bash
+uv tool install hcs-cli
+```
+
+Or using pipx:
+
+```bash
+pipx install hcs-cli
+```
+
+#### Use the CLI
+
+Use with default public HCS service.
+
+```
+hcs login
+```
+
+Run a command, for example, list templates:
+
+```
+hcs svc admin template list
+```
+
+## Documentation
+
+- [HCS CLI - User Guide](../doc/hcs-cli-user-guide.md)
+- [HCS CLI - Cheatsheet](../doc/hcs-cli-cheatsheet.md)
+- [HCS CLI - Dev Guide](../doc/hcs-cli-dev-guide.md)
+- [HCS Plan - template engine for HCS](../doc/hcs-plan.md)
+- [Context Programming](https://github.com/nanw1103/context-programming)
+
+## License
+
+Licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). See the [LICENSE](../LICENSE) file in the repository root for the full text.

hcs_cli-0.1.353/README.md

@@ -0,0 +1,64 @@
+# horizon-cloud-service-cli
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+
+- [horizon-cloud-service-cli](#horizon-cloud-service-cli)
+  - [Overview](#overview)
+  - [Try it out](#try-it-out)
+    - [Prerequisites](#prerequisites)
+    - [Installation](#installation)
+      - [Use the CLI](#use-the-cli)
+  - [Documentation](#documentation)
+  - [Contributing](#contributing)
+  - [License](#license)
+
+## Overview
+
+hcs-cli is a human-friendly command line toolbox for [Omnissa Horizon Cloud Service (HCS)](https://www.omnissa.com/products/horizon-cloud/), based on public REST APIs.
+
+## Try it out
+
+### Prerequisites
+
+- Python 3.9+
+- [uv](https://docs.astral.sh/uv/getting-started/installation/) or [pipx](https://pipx.pypa.io/stable/installation/)
+
+### Installation
+
+Using uv:
+
+```bash
+uv tool install hcs-cli
+```
+
+Or using pipx:
+
+```bash
+pipx install hcs-cli
+```
+
+#### Use the CLI
+
+Use with default public HCS service.
+
+```
+hcs login
+```
+
+Run a command, for example, list templates:
+
+```
+hcs svc admin template list
+```
+
+## Documentation
+
+- [HCS CLI - User Guide](../doc/hcs-cli-user-guide.md)
+- [HCS CLI - Cheatsheet](../doc/hcs-cli-cheatsheet.md)
+- [HCS CLI - Dev Guide](../doc/hcs-cli-dev-guide.md)
+- [HCS Plan - template engine for HCS](../doc/hcs-plan.md)
+- [Context Programming](https://github.com/nanw1103/context-programming)
+
+## License
+
+Licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). See the [LICENSE](../LICENSE) file in the repository root for the full text.

hcs_cli-0.1.353/hcs_cli/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.353"

hcs_cli-0.1.353/hcs_cli/cmds/activity/get.py

@@ -0,0 +1,22 @@
+"""
+Copyright © 2025-2026 Omnissa, LLC.
+"""
+
+import hcs_core.sglib.cli_options as cli
+import rich_click as click
+from hcs_core.ctxp import recent
+
+from hcs_cli.service import activity
+
+
+@click.command()
+@click.argument("id", type=str, required=False)
+@cli.org_id
+def get(id: str, org: str):
+    """Get activity by ID."""
+    cli.get_org_id(org)
+    id = recent.require("activity", id)
+    ret = activity.get(id)
+    if ret:
+        return ret
+    return ret, 1

hcs_cli-0.1.353/hcs_cli/cmds/activity/list.py

@@ -0,0 +1,126 @@
+"""
+Copyright © 2025-2026 Omnissa, LLC.
+"""
+
+from datetime import timezone
+
+import hcs_core.sglib.cli_options as cli
+import rich_click as click
+import yumako
+from hcs_core.ctxp import recent
+
+from hcs_cli.service import activity
+
+_SEARCH_OPTS = (
+    ("edge", "edgeId"),
+    ("edge_name", "edgeName"),
+    ("site", "siteId"),
+    ("site_name", "siteName"),
+    ("type", "type"),
+    ("operation", "operation"),
+    ("resource", "resourceId"),
+    ("trace", "traceId"),
+    ("parent", "parentId"),
+    ("status", "status"),
+    ("severity", "severity"),
+)
+
+
+def _format_time(time: str) -> str:
+    dt = yumako.time.of(time, tz=timezone.utc)
+    return dt.strftime("%Y-%m-%dT%H:%M:%S.") + f"{dt.microsecond // 1000:03d}Z"
+
+
+def _build_search(**filters):
+    parts = []
+    for arg, field in _SEARCH_OPTS:
+        val = filters.get(arg)
+        if val:
+            parts.append(f"{field} $eq {val}")
+    return " AND ".join(parts) if parts else None
+
+
+@click.command()
+@click.option(
+    "--from",
+    "from_param",
+    type=str,
+    required=False,
+    default="-24h",
+    help="From date. E.g. '-1d', '-1h35m', '-1w', or '2023-12-04T00:19:22.854Z'.",
+)
+@click.option(
+    "--to",
+    type=str,
+    required=False,
+    default="now",
+    help="To date. E.g. 'now', '-1d', '-1h35m', '-1w', or '2023-12-04T00:19:22.854Z'.",
+)
+@click.option("--edge", type=str, required=False, help="Filter by edgeId.")
+@click.option("--edge-name", type=str, required=False, help="Filter by edgeName.")
+@click.option("--site", type=str, required=False, help="Filter by siteId.")
+@click.option("--site-name", type=str, required=False, help="Filter by siteName.")
+@click.option("--type", "type", type=str, required=False, help="Filter by type (AUDIT, SYSTEM).")
+@click.option("--operation", type=str, required=False, help="Filter by operation.")
+@click.option("--resource", type=str, required=False, help="Filter by resourceId.")
+@click.option("--trace", type=str, required=False, help="Filter by traceId.")
+@click.option("--parent", type=str, required=False, help="Filter by parentId.")
+@click.option("--status", type=str, required=False, help="Filter by status.")
+@click.option("--severity", type=str, required=False, help="Filter by severity.")
+@cli.limit(default=20)
+@cli.org_id
+@cli.formatter(
+    columns={
+        "id": "Id",
+        "utcTimestamp": "Time",
+        "type": "Type",
+        "operation": "Operation",
+        "status": "Status",
+        "severity": "Severity",
+        "resourceName": "Resource",
+        "edgeName": "Edge",
+        "siteName": "Site",
+    }
+)
+def list(
+    org: str,
+    from_param: str,
+    to: str,
+    edge: str,
+    edge_name: str,
+    site: str,
+    site_name: str,
+    type: str,
+    operation: str,
+    resource: str,
+    trace: str,
+    parent: str,
+    status: str,
+    severity: str,
+    limit: int,
+):
+    """List activities."""
+    org_id = cli.get_org_id(org)
+    search = _build_search(
+        edge=edge,
+        edge_name=edge_name,
+        site=site,
+        site_name=site_name,
+        type=type,
+        operation=operation,
+        resource=resource,
+        trace=trace,
+        parent=parent,
+        status=status,
+        severity=severity,
+    )
+    kwargs = {
+        "start_date": _format_time(from_param),
+        "end_date": _format_time(to),
+        "limit": limit,
+    }
+    if search:
+        kwargs["search"] = search
+    ret = activity.list(org_id, **kwargs)
+    recent.helper.default_list(ret, "activity")
+    return ret

hcs_cli-0.1.353/hcs_cli/cmds/ad/create.py

@@ -0,0 +1,43 @@
+"""
+Copyright © 2025 Omnissa, LLC.
+"""
+
+import json
+import sys
+
+import hcs_core.sglib.cli_options as cli
+import rich_click as click
+from hcs_core.ctxp import recent, util
+
+from hcs_cli.service import admin
+
+
+@click.command()
+@click.option(
+    "--file",
+    "-f",
+    type=click.File("rt"),
+    default=sys.stdin,
+    help="Specify the payload file name. If not specified, STDIN will be used.",
+)
+@cli.org_id
+def create(file: str, org: str, **kwargs):
+    """Create Active Directory record"""
+
+    org_id = cli.get_org_id(org)
+
+    with file:
+        payload = file.read()
+
+    try:
+        template = json.loads(payload)
+    except json.JSONDecodeError as e:
+        msg = "Invalid template: " + util.error_details(e)
+        return msg, 1
+
+    template["orgId"] = org_id
+
+    ret = admin.ad.create(template, **kwargs)
+    if ret:
+        recent.set("ad", ret["id"])
+    return ret

hcs_cli-0.1.353/hcs_cli/cmds/ad/delete.py

@@ -0,0 +1,31 @@
+"""
+Copyright © 2025-2026 Omnissa, LLC.
+"""
+
+import hcs_core.sglib.cli_options as cli
+import rich_click as click
+from hcs_core.ctxp import recent
+
+from hcs_cli.service import admin
+
+
+@click.command()
+@click.argument("id", type=str, required=False)
+@cli.org_id
+@cli.confirm
+def delete(id: str, org: str, confirm: bool, **kwargs):
+    """Delete Active Directory record by ID"""
+
+    org_id = cli.get_org_id(org)
+    id = recent.require("ad", id)
+
+    if not confirm:
+        ret = admin.ad.get(id, org_id=org_id)
+        if not ret:
+            return ""
+        click.confirm(f"Delete AD record {ret['name']} ({id})?", abort=True)
+
+    ret = admin.ad.delete(id, org_id)
+    if not ret:
+        return ""
+    return ret

hcs_cli-0.1.353/hcs_cli/cmds/ad/get.py

@@ -0,0 +1,21 @@
+"""
+Copyright © 2025-2026 Omnissa, LLC.
+"""
+
+import hcs_core.sglib.cli_options as cli
+import rich_click as click
+from hcs_core.ctxp import recent
+
+from hcs_cli.service import admin
+
+
+@click.command()
+@click.argument("id", type=str, required=False)
+@cli.org_id
+def get(id: str, org: str):
+    """Get Active Directory record by ID"""
+    id = recent.require("ad", id)
+    ret = admin.ad.get(id, org_id=cli.get_org_id(org))
+    if ret:
+        return ret
+    return "", 1

hcs_cli-0.1.353/hcs_cli/cmds/ad/list.py

@@ -0,0 +1,21 @@
+"""
+Copyright © 2025-2026 Omnissa, LLC.
+"""
+
+import hcs_core.sglib.cli_options as cli
+import rich_click as click
+from hcs_core.ctxp import recent
+
+from hcs_cli.service import admin
+
+
+@click.command()
+@cli.org_id
+@cli.search
+@cli.sort
+@cli.limit
+def list(org: str, **kwargs):
+    """List Active Directory records"""
+    ret = admin.ad.list(org_id=cli.get_org_id(org), **kwargs)
+    recent.helper.default_list(ret, "ad")
+    return ret