controllers.banner_controller module¶

class controllers.banner_controller.BannerController(config=None, client=None, call_back=None)[source]¶

Bases: cohesity_management_sdk.controllers.base_controller.BaseController

A Controller to access Endpoints in the cohesity_management_sdk API.

get_banner()[source]¶

Does a GET request to /public/banners.

Currently it returns a cluster specific banner for all requests. Later, depending on who is requesting it (which can be inferred from the URL), we would like to return most appropriate banner if set by the cluster admin (or Service Provider).

Returns:

Banner: 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.

update_banner(body=None)[source]¶

Does a PUT request to /public/banners.

Returns the banner that was updated on the Cohesity Cluster.

Args:

body (BannerUpdateParameters): Request to update a View.

Returns:

Banner: 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.