controllers.interface_group_controller module¶
-
class
controllers.interface_group_controller.InterfaceGroupController(config=None, client=None, call_back=None)[source]¶ Bases:
cohesity_management_sdk.controllers.base_controller.BaseControllerA Controller to access Endpoints in the cohesity_management_sdk API.
-
create_interface_group(body=None)[source]¶ Does a POST request to /public/interfaceGroups.
Returns the create status upon completion.
- Args:
- body (InterfaceGroup, optional): TODO: type description here.
Example:
- Returns:
InterfaceGroup: 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_interface_group(name)[source]¶ Does a DELETE request to /public/interfaceGroups/{name}.
Returns the delete status upon completion.
- Args:
name (string): Request to delete one interface group.
- 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_interface_groups()[source]¶ Does a GET request to /public/interfaceGroups.
Returns the interface groups for the Cohesity Cluster.
- Returns:
list of InterfaceGroup: 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_interface_group(body=None)[source]¶ Does a PUT request to /public/interfaceGroups.
Returns the update status upon completion.
- Args:
- body (InterfaceGroup, optional): TODO: type description here.
Example:
- Returns:
InterfaceGroup: 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.
-