vcfops_dashboard

VCF Operations — dashboards.

VCF Operations exposes dashboard management at /suite-api/api/dashboards. A dashboard is a named collection of widgets scoped to a user or shared with other users. The API supports the usual CRUD lifecycle plus two extras:

• POST /suite-api/api/dashboards/{id}/share/{userId} — grant userId access to the dashboard.

• POST /suite-api/api/dashboards/import — recreate a dashboard from a previously exported payload (typically produced by the export endpoint or captured out-of-band).

All requests are token-authenticated via saltext.vcf.utils.vcfops.

saltext.vcf.clients.vcfops_dashboard.list_(opts, profile=None)

Return every dashboard visible to the current user.

saltext.vcf.clients.vcfops_dashboard.get(opts, dashboard_id, profile=None)

Return the dashboard identified by dashboard_id.

Raises requests.HTTPError (404) if the dashboard is missing; use get_or_none() for the idempotent variant.

saltext.vcf.clients.vcfops_dashboard.get_or_none(opts, dashboard_id, profile=None)

Like get() but returns None when the dashboard is absent.

saltext.vcf.clients.vcfops_dashboard.create(opts, dashboard_spec, profile=None)

Create a dashboard.

dashboard_spec is the JSON body accepted by POST /suite-api/api/dashboards. Example:

{
    "name": "capacity-overview",
    "description": "Cluster-level capacity trends",
    "widgets": [...]
}

saltext.vcf.clients.vcfops_dashboard.update(opts, dashboard_id, dashboard_spec, profile=None)

Replace the dashboard identified by dashboard_id with dashboard_spec.

saltext.vcf.clients.vcfops_dashboard.delete(opts, dashboard_id, profile=None)

Delete the dashboard identified by dashboard_id.

saltext.vcf.clients.vcfops_dashboard.share(opts, dashboard_id, user_id, profile=None)

Share dashboard_id with the user identified by user_id.

saltext.vcf.clients.vcfops_dashboard.import_(opts, spec, profile=None)

Import a dashboard from a previously exported payload.

spec is the exported dashboard JSON structure accepted by POST /suite-api/api/dashboards/import.