qualys-cli 0.1.1__py3-none-any.whl

qualys_cli/commands/pm.py

@@ -0,0 +1,412 @@
+# Auto-generated from api-model.json — run scripts/generate_commands.py to regenerate.
+# Patch Management API  (JWT auth, JSON responses)
+from __future__ import annotations
+
+import typer
+
+from .. import client as _c
+from ..formatters import DEFAULT_LIMIT, output, output_success
+
+app = typer.Typer(name="pm", help="Patch Management APIs (JWT Bearer auth)")
+
+# ── job ─────────────────────────────────────────────────────────────────────
+_job = typer.Typer(help="Deployment job operations")
+app.add_typer(_job, name="job")
+
+
+@_job.command("list")
+def job_list(
+    ctx: typer.Context,
+    limit: int = typer.Option(DEFAULT_LIMIT, "--limit", "-n"),
+    all_: bool = typer.Option(False, "--all", help="Fetch all pages"),
+    output_file: str | None = typer.Option(None, "--output-file", "-o"),
+    format: str = typer.Option("table", "--format", "-f", help="table|json|yaml"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """List deployment jobs.
+
+    Source: https://docs.qualys.com/en/pm/api/deployment_job_resource/get_deployment_job_list.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    if all_:
+        rows: list = []
+        for page in client.paginate_json("/pm/v1/deploymentjobs"):
+            items = page if isinstance(page, list) else page.get("data", [page])
+            rows.extend(items)
+        data: object = rows
+    else:
+        data = client.get_json("/pm/v1/deploymentjobs", {"pageSize": limit})
+    output(data, format=format, limit=None if all_ else limit, output_file=output_file)
+
+
+@_job.command("get")
+def job_get(
+    ctx: typer.Context,
+    job_id: str = typer.Argument(..., help="Deployment job ID"),
+    format: str = typer.Option("table", "--format", "-f"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Get a deployment job by ID.
+
+    Source: https://docs.qualys.com/en/pm/api/deployment_job_resource/get_deployment_job_by_id.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    data = client.get_json(f"/pm/v1/deploymentjob/{job_id}")
+    output(data, format=format)
+
+
+@_job.command("create")
+def job_create(
+    ctx: typer.Context,
+    name: str = typer.Option(..., "--name", help="Job name"),
+    schedule_type: str = typer.Option(..., "--schedule-type", help="On-demand|Once|Daily|Weekly|Monthly"),
+    platform: str = typer.Option("Windows", "--platform", help="Windows|Linux"),
+    start_date_time: str | None = typer.Option(None, "--start", help="Start datetime YYYY-MM-DD HH:MM:SS"),
+    tag_ids: str | None = typer.Option(None, "--tag-ids", help="Comma-separated tag UUIDs"),
+    format: str = typer.Option("table", "--format", "-f"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Create a deployment job.
+
+    Source: https://docs.qualys.com/en/pm/api/deployment_job_resource/create_deployment_job.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    body: dict = {"name": name, "scheduleType": schedule_type, "platform": platform}
+    if start_date_time:
+        body["startDateTime"] = start_date_time
+    if tag_ids:
+        body["tagIds"] = [t.strip() for t in tag_ids.split(",")]
+    data = client.post_json("/pm/v1/deploymentjob", body)
+    output(data, format=format)
+
+
+@_job.command("update")
+def job_update(
+    ctx: typer.Context,
+    job_id: str = typer.Argument(..., help="Deployment job ID"),
+    name: str | None = typer.Option(None, "--name"),
+    schedule_type: str | None = typer.Option(None, "--schedule-type"),
+    format: str = typer.Option("table", "--format", "-f"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Update a deployment job.
+
+    Source: https://docs.qualys.com/en/pm/api/deployment_job_resource/update_deployment_jobs.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    body: dict = {}
+    if name:
+        body["name"] = name
+    if schedule_type:
+        body["scheduleType"] = schedule_type
+    data = client.patch_json(f"/pm/v1/deploymentjob/update/{job_id}", body)
+    output(data, format=format)
+
+
+@_job.command("delete")
+def job_delete(
+    ctx: typer.Context,
+    job_id: str = typer.Argument(..., help="Deployment job ID"),
+    yes: bool = typer.Option(False, "--yes", "-y", help="Skip confirmation"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Delete a deployment job.
+
+    Source: https://docs.qualys.com/en/pm/api/deployment_job_resource/delete_deployment_jobs.htm
+    """
+    if not yes:
+        typer.confirm(f"Delete deployment job {job_id}?", abort=True)
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    client.delete_json(f"/pm/v1/deploymentjobs/{job_id}")
+    output_success(f"Deployment job {job_id} deleted.")
+
+
+@_job.command("change-status")
+def job_change_status(
+    ctx: typer.Context,
+    job_ids: str = typer.Argument(..., help="Comma-separated deployment job IDs"),
+    action: str = typer.Argument(..., help="Enabled|Disabled"),
+    format: str = typer.Option("table", "--format", "-f"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Enable or disable one or more deployment jobs.
+
+    Source: https://docs.qualys.com/en/pm/api/deployment_job_resource/change_the_status_of_deployment_jobs.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    ids = [j.strip() for j in job_ids.split(",") if j.strip()]
+    data = client.post_json(
+        f"/pm/v1/deploymentjobs/update/status/{action}", {"jobIds": ids}
+    )
+    output(data, format=format)
+
+
+@_job.command("runs")
+def job_runs(
+    ctx: typer.Context,
+    job_id: str = typer.Argument(..., help="Deployment job ID"),
+    limit: int = typer.Option(DEFAULT_LIMIT, "--limit", "-n"),
+    format: str = typer.Option("table", "--format", "-f"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """List runs for a deployment job.
+
+    Source: https://docs.qualys.com/en/pm/api/deployment_job_resource/get_list_of_runs_for_particular_deployment_job.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    data = client.get_json(f"/pm/v1/deploymentjob/{job_id}/runs")
+    output(data, format=format, limit=limit)
+
+
+@_job.command("summary")
+def job_summary(
+    ctx: typer.Context,
+    job_id: str = typer.Argument(..., help="Deployment job ID"),
+    format: str = typer.Option("table", "--format", "-f"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Get result summary for a deployment job.
+
+    Source: https://docs.qualys.com/en/pm/api/deployment_job_resource/get_deployment_job_result_summary.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    data = client.get_json(
+        f"/pm/v1/deploymentjob/{job_id}/deploymentjobresult/summary"
+    )
+    output(data, format=format)
+
+
+# ── mitigation ──────────────────────────────────────────────────────────────
+_mtg = typer.Typer(help="Mitigation job operations")
+app.add_typer(_mtg, name="mitigation")
+
+
+@_mtg.command("list")
+def mitigation_list(
+    ctx: typer.Context,
+    limit: int = typer.Option(DEFAULT_LIMIT, "--limit", "-n"),
+    format: str = typer.Option("table", "--format", "-f"),
+    output_file: str | None = typer.Option(None, "--output-file", "-o"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """List mitigation deployment jobs.
+
+    Source: https://docs.qualys.com/en/pm/api/mitigation_apis/get_list_of_all_mitigation_jobs.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    # The mitigation jobs endpoint is under the same /pm/v1/deploymentjobs path
+    # but filtered by type. Try /pm/v1/deploymentjobs with type filter first.
+    data = client.get_json("/pm/v1/deploymentjobs", {"type": "Mitigate"})
+    output(data, format=format, limit=limit, output_file=output_file)
+
+
+@_mtg.command("create")
+def mitigation_create(
+    ctx: typer.Context,
+    name: str = typer.Option(..., "--name"),
+    schedule_type: str = typer.Option(..., "--schedule-type"),
+    format: str = typer.Option("table", "--format", "-f"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Create a mitigation job.
+
+    Source: https://docs.qualys.com/en/pm/api/mitigation_apis/create_mitigation_job.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    data = client.post_json("/pm/v1/deploymentjob", {"name": name, "scheduleType": schedule_type, "type": "Mitigate"})
+    output(data, format=format)
+
+
+@_mtg.command("delete")
+def mitigation_delete(
+    ctx: typer.Context,
+    job_id: str = typer.Argument(...),
+    yes: bool = typer.Option(False, "--yes", "-y"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Delete mitigation jobs.
+
+    Source: https://docs.qualys.com/en/pm/api/mitigation_apis/delete_mitigation_jobs.htm
+    """
+    if not yes:
+        typer.confirm(f"Delete mitigation job {job_id}?", abort=True)
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    client.delete_json("/pm/v1/deploymentjobs", params={"ids": job_id})
+    output_success(f"Mitigation job {job_id} deleted.")
+
+
+# ── patch ────────────────────────────────────────────────────────────────────
+_patch = typer.Typer(help="Patch catalog operations")
+app.add_typer(_patch, name="patch")
+
+
+@_patch.command("list")
+def patch_list(
+    ctx: typer.Context,
+    platform: str | None = typer.Option(None, "--platform", help="Windows|Linux"),
+    severity: str | None = typer.Option(None, "--severity", help="Critical|Important|Moderate|Low"),
+    limit: int = typer.Option(DEFAULT_LIMIT, "--limit", "-n"),
+    all_: bool = typer.Option(False, "--all"),
+    output_file: str | None = typer.Option(None, "--output-file", "-o"),
+    format: str = typer.Option("table", "--format", "-f"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """List patches from the patch catalog.
+
+    Source: https://docs.qualys.com/en/pm/api/patch_catalog_resource/get_patch_catalog_patches.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    params: dict = {}
+    if platform:
+        params["platform"] = platform
+    if severity:
+        params["severityList"] = severity
+    if all_:
+        rows: list = []
+        for page in client.paginate_json("/pm/v1/patchcatalog/patches", params):
+            items = page if isinstance(page, list) else page.get("data", [page])
+            rows.extend(items)
+        output(rows, format=format, output_file=output_file)
+    else:
+        params["pageSize"] = limit
+        data = client.get_json("/pm/v1/patchcatalog/patches", params)
+        output(data, format=format, limit=limit, output_file=output_file)
+
+
+@_patch.command("count")
+def patch_count(
+    ctx: typer.Context,
+    platform: str | None = typer.Option(None, "--platform"),
+    output_file: str | None = typer.Option(None, "--output-file", "-o"),
+    format: str = typer.Option("table", "--format", "-f"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Get patch count.
+
+    Source: https://docs.qualys.com/en/pm/api/scan_result_patch_resource/get_patch_count.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    params: dict = {}
+    if platform:
+        params["platform"] = platform
+    data = client.get_json("/pm/v1/patches/count", params)
+    output(data, format=format, output_file=output_file)
+
+
+@_patch.command("products")
+def patch_products(
+    ctx: typer.Context,
+    patch_id: str = typer.Argument(..., help="Patch ID to list products for"),
+    limit: int = typer.Option(DEFAULT_LIMIT, "--limit", "-n"),
+    format: str = typer.Option("table", "--format", "-f"),
+    output_file: str | None = typer.Option(None, "--output-file", "-o"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """List products affected by a specific patch.
+
+    Source: https://docs.qualys.com/en/pm/api/patch_catalog_resource/get_patch_catalog_products.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    data = client.get_json(f"/pm/v1/patchcatalog/patch/{patch_id}/products")
+    output(data, format=format, limit=limit, output_file=output_file)
+
+
+# ── report ───────────────────────────────────────────────────────────────────
+_report = typer.Typer(help="Patch Management report operations")
+app.add_typer(_report, name="report")
+
+
+@_report.command("list")
+def report_list(
+    ctx: typer.Context,
+    limit: int = typer.Option(DEFAULT_LIMIT, "--limit", "-n"),
+    format: str = typer.Option("table", "--format", "-f"),
+    output_file: str | None = typer.Option(None, "--output-file", "-o"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """List generated PM reports.
+
+    Source: https://docs.qualys.com/en/pm/api/patch_report_resource/get_list_of_generated_reports.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    data = client.get_json("/pm/v1/reports")
+    output(data, format=format, limit=limit, output_file=output_file)
+
+
+@_report.command("generate")
+def report_generate(
+    ctx: typer.Context,
+    job_id: str = typer.Argument(..., help="Deployment job ID"),
+    report_format: str = typer.Option("CSV", "--report-format", help="CSV|PDF"),
+    name: str | None = typer.Option(None, "--name"),
+    output_file: str | None = typer.Option(None, "--output-file", "-o"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Generate a deployment job progress report.
+
+    Source: https://docs.qualys.com/en/pm/api/patch_report_resource/generate_patch_insights_report.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    body: dict = {"reportFormat": report_format}
+    if name:
+        body["name"] = name
+    data = client.post_json(f"/pm/v1/report/deplymentjobprogress/{job_id}", body)
+    output(data, output_file=output_file)
+
+
+@_report.command("download")
+def report_download(
+    ctx: typer.Context,
+    report_id: str = typer.Argument(..., help="Report ID"),
+    output_file: str = typer.Option("report.csv", "--output-file", "-o", help="Save path"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Download a generated report to a local file.
+
+    Source: https://docs.qualys.com/en/pm/api/patch_report_resource/get_report_in_csv_format.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    resp = client.request("GET", f"/pm/v1/reports/{report_id}/download")
+    from pathlib import Path
+    Path(output_file).write_bytes(resp.content)
+    from ..formatters import output_success
+    output_success(f"Report saved to {output_file} ({len(resp.content):,} bytes)")
+
+
+@_report.command("columns")
+def report_columns(
+    ctx: typer.Context,
+    platform: str = typer.Option(..., "--platform", help="Windows|Linux"),
+    report_section: str = typer.Option(..., "--report-section", help="Asset|Patch|JobProgress"),
+    format: str = typer.Option("table", "--format", "-f"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """Fetch available report columns.
+
+    Source: https://docs.qualys.com/en/pm/api/patch_report_resource/get_list_of_report_columns.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    data = client.get_json("/pm/v1/report/columns", {"platform": platform, "reportSection": report_section})
+    output(data, format=format)
+
+
+# ── asset ────────────────────────────────────────────────────────────────────
+_asset = typer.Typer(help="PM asset operations")
+app.add_typer(_asset, name="asset")
+
+
+@_asset.command("list")
+def asset_list(
+    ctx: typer.Context,
+    limit: int = typer.Option(DEFAULT_LIMIT, "--limit", "-n"),
+    format: str = typer.Option("table", "--format", "-f"),
+    output_file: str | None = typer.Option(None, "--output-file", "-o"),
+    verbose: int = typer.Option(0, "--verbose", "-v", count=True),
+):
+    """List PM-managed assets.
+
+    Source: https://docs.qualys.com/en/pm/api/scan_result_asset_resource/get_pm_assets.htm
+    """
+    client = _c.make(ctx.obj, auth_type="jwt", verbose=verbose, use_gateway=True)
+    data = client.get_json("/pm/v1/assets", {"pageSize": limit})
+    output(data, format=format, limit=limit, output_file=output_file)