controllers.dashboard_controller module

class controllers.dashboard_controller.DashboardController(config=None, client=None, call_back=None)

Bases: cohesity_management_sdk.controllers.base_controller.BaseController

A Controller to access Endpoints in the cohesity_management_sdk API.

get_dashboard(cluster_id=None, all_clusters=None, refresh=None, tile_types=None)

Does a GET request to /public/dashboard.

If no parameters are specified, dashboard for the local cluster is returned.

Args:

cluster_id (string, optional): Id of the remote cluster for which

to fetch the data. If value is not specified, it is assumed to be local cluster.

all_clusters (bool, optional): Summary data for all clusters. If

this is set to true, all other parameters will be ignored.

refresh (bool, optional): Specifies whether to refresh the tiles

selected.

tile_types (TileTypesEnum, optional): Specifies the opaque string returned in

the previous response. If this is set, next set of active opens just after the previous response are returned. If this is not set, first set of NLM locks are returned.

Returns:

DashboardResponse: Response from the API. Success

Raises:

APIException: When an error occurs while fetching the data from

the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request.