controllers.routes_controller module¶
-
class
controllers.routes_controller.
RoutesController
(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.
-
add_route
(body=None)[source]¶ Does a POST request to /public/routes.
Returns the create status upon completion.
- Args:
body (Route, optional): TODO: type description here. Example:
- Returns:
Route: 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.
-
delete_route
(body=None)[source]¶ Does a DELETE request to /public/routes.
Returns the delete status upon completion.
- Args:
- body (DeleteRouteParam, optional): TODO: type description here.
Example:
- Returns:
void: Response from the API. No Content
- 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.
-
get_routes
()[source]¶ Does a GET request to /public/routes.
Returns the Static Routes for the Cohesity Cluster.
- Returns:
list of Route: 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.
-