# -*- coding: utf-8 -*-
# Copyright 2021 Cohesity Inc.
import logging
from cohesity_management_sdk.api_helper import APIHelper
from cohesity_management_sdk.configuration import Configuration
from cohesity_management_sdk.controllers.base_controller import BaseController
from cohesity_management_sdk.http.auth.auth_manager import AuthManager
from cohesity_management_sdk.models.vlan import Vlan
from cohesity_management_sdk.models.bifrost_config import BifrostConfig
from cohesity_management_sdk.exceptions.request_error_error_exception import RequestErrorErrorException
from cohesity_management_sdk.exceptions.api_exception import APIException
[docs]class VlanController(BaseController):
"""A Controller to access Endpoints in the cohesity_management_sdk API."""
def __init__(self, config=None, client=None, call_back=None):
super(VlanController, self).__init__(client, call_back)
self.logger = logging.getLogger(__name__)
self.config = config
[docs] def get_bifrost_tenant_vlans(self):
"""Does a GET request to /public/bifrost/vlans.
Returns the Bifrost Tenant VLANs for the Cohesity Cluster.
Returns:
GetBifrostConfigsResponse: 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.
"""
try:
self.logger.info('get_bifrost_tenant_vlans called.')
# Prepare query URL
self.logger.info('Preparing query URL for get_bifrost_tenant_vlans.')
_url_path = '/public/bifrost/vlans'
_query_builder = self.config.get_base_uri()
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
self.logger.info('Preparing headers for get_bifrost_tenant_vlans.')
_headers = {'accept': 'application/json'}
# Prepare and execute request
self.logger.info(
'Preparing and executing request for get_bifrost_tenant_vlans.')
_request = self.http_client.get(_query_url, headers=_headers)
AuthManager.apply(_request, self.config)
_context = self.execute_request(_request,
name='get_bifrost_tenant_vlans')
# Endpoint and global error handling using HTTP status codes.
self.logger.info('Validating response for get_bifrost_tenant_vlans.')
if _context.response.status_code == 0:
raise RequestErrorErrorException('Error', _context)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body,
BifrostConfig.from_dictionary)
except Exception as e:
self.logger.error(e, exc_info=True)
raise
[docs] def create_bifrost_vlan(self):
"""Does a POST request to /public/bifrost/vlans.
Returns the created Bifrost VLAN on the Cohesity Cluster.
Args:
:TODO Add description here.
Returns:
BifrostConfig: 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.
"""
try:
self.logger.info('create_bifrost_vlan called.')
# Validate required parameters
self.logger.info(
'Validating required parameters for create_bifrost_vlan.')
# Prepare query URL
self.logger.info('Preparing query URL for create_bifrost_vlan.')
_url_path = '/public/bifrost/vlans'
_query_builder = self.config.get_base_uri()
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
self.logger.info('Preparing headers for create_bifrost_vlan.')
_headers = {
'accept': 'application/json',
'content-type': 'application/json; charset=utf-8'
}
# Prepare and execute request
self.logger.info(
'Preparing and executing request for create_bifrost_vlan.')
_request = self.http_client.post(
_query_url,
headers=_headers)
AuthManager.apply(_request, self.config)
_context = self.execute_request(_request,
name='create_bifrost_vlan')
# Endpoint and global error handling using HTTP status codes.
self.logger.info('Validating response for create_bifrost_vlan.')
if _context.response.status_code == 0:
raise RequestErrorErrorException('Error', _context)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body,
BifrostConfig.from_dictionary)
except Exception as e:
self.logger.error(e, exc_info=True)
raise
[docs] def get_vlans(self,
tenant_ids=None,
all_under_hierarchy=None,
skip_primary_and_bond_iface=None,
compress_ips_to_ranges=None,
vlan_id=None):
"""Does a GET request to /public/vlans.
Returns the VLANs for the Cohesity Cluster.
Args:
tenant_ids (list of string, optional): TenantIds contains ids of
the tenants for which objects are to be returned.
all_under_hierarchy (bool, optional): AllUnderHierarchy specifies
if objects of all the tenants under the hierarchy of the
logged in user's organization should be returned.
skip_primary_and_bond_iface (bool, optional):
SkipPrimaryAndBondIface is to filter interfaces entries which
are primary interface or bond interfaces.
compress_ips_to_ranges (bool): Compress Ips list to list of
contigous ip ranges with(startIp, endIp)
vlan_id (int): Vlan Id to filter vlans.
Returns:
list of Vlan: 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.
"""
try:
self.logger.info('get_vlans called.')
# Prepare query URL
self.logger.info('Preparing query URL for get_vlans.')
_url_path = '/public/vlans'
_query_builder = self.config.get_base_uri()
_query_builder += _url_path
_query_parameters = {
'tenantIds': tenant_ids,
'allUnderHierarchy': all_under_hierarchy,
'skipPrimaryAndBondIface': skip_primary_and_bond_iface,
'compressIpsToRanges': compress_ips_to_ranges,
'vlanId': vlan_id
}
_query_builder = APIHelper.append_url_with_query_parameters(
_query_builder, _query_parameters,
Configuration.array_serialization)
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
self.logger.info('Preparing headers for get_vlans.')
_headers = {'accept': 'application/json'}
# Prepare and execute request
self.logger.info('Preparing and executing request for get_vlans.')
_request = self.http_client.get(_query_url, headers=_headers)
AuthManager.apply(_request, self.config)
_context = self.execute_request(_request, name='get_vlans')
# Endpoint and global error handling using HTTP status codes.
self.logger.info('Validating response for get_vlans.')
if _context.response.status_code == 0:
raise RequestErrorErrorException('Error', _context)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body,
Vlan.from_dictionary)
except Exception as e:
self.logger.error(e, exc_info=True)
raise
[docs] def create_vlan(self, body):
"""Does a POST request to /public/vlans.
Returns the created VLAN on the Cohesity Cluster.
Args:
body (Vlan): TODO: type description here. Example:
Returns:
Vlan: 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.
"""
try:
self.logger.info('create_vlan called.')
# Validate required parameters
self.logger.info('Validating required parameters for create_vlan.')
self.validate_parameters(body=body)
# Prepare query URL
self.logger.info('Preparing query URL for create_vlan.')
_url_path = '/public/vlans'
_query_builder = self.config.get_base_uri()
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
self.logger.info('Preparing headers for create_vlan.')
_headers = {
'accept': 'application/json',
'content-type': 'application/json; charset=utf-8'
}
# Prepare and execute request
self.logger.info(
'Preparing and executing request for create_vlan.')
_request = self.http_client.post(
_query_url,
headers=_headers,
parameters=APIHelper.json_serialize(body))
AuthManager.apply(_request, self.config)
_context = self.execute_request(_request, name='create_vlan')
# Endpoint and global error handling using HTTP status codes.
self.logger.info('Validating response for create_vlan.')
if _context.response.status_code == 0:
raise RequestErrorErrorException('Error', _context)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body,
Vlan.from_dictionary)
except Exception as e:
self.logger.error(e, exc_info=True)
raise
[docs] def remove_vlan(self, id):
"""Does a DELETE request to /public/vlans/{id}.
Returns the delete status upon completion.
Args:
id (int): Specifies the id of the VLAN.
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.
"""
try:
self.logger.info('remove_vlan called.')
# Validate required parameters
self.logger.info('Validating required parameters for remove_vlan.')
self.validate_parameters(id=id)
# Prepare query URL
self.logger.info('Preparing query URL for remove_vlan.')
_url_path = '/public/vlans/{id}'
_url_path = APIHelper.append_url_with_template_parameters(
_url_path, {'id': id})
_query_builder = self.config.get_base_uri()
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare and execute request
self.logger.info(
'Preparing and executing request for remove_vlan.')
_request = self.http_client.delete(_query_url)
AuthManager.apply(_request, self.config)
_context = self.execute_request(_request, name='remove_vlan')
# Endpoint and global error handling using HTTP status codes.
self.logger.info('Validating response for remove_vlan.')
if _context.response.status_code == 0:
raise RequestErrorErrorException('Error', _context)
self.validate_response(_context)
except Exception as e:
self.logger.error(e, exc_info=True)
raise
[docs] def get_vlan_by_id(self, id):
"""Does a GET request to /public/vlans/{id}.
Returns the VLAN corresponding to the specified VLAN ID or a
specified
vlan interface group name.
Example: /public/vlans/intf_group1.20
Args:
id (int): Specifies the id of the VLAN.
Returns:
Vlan: 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.
"""
try:
self.logger.info('get_vlan_by_id called.')
# Validate required parameters
self.logger.info(
'Validating required parameters for get_vlan_by_id.')
self.validate_parameters(id=id)
# Prepare query URL
self.logger.info('Preparing query URL for get_vlan_by_id.')
_url_path = '/public/vlans/{id}'
_url_path = APIHelper.append_url_with_template_parameters(
_url_path, {'id': id})
_query_builder = self.config.get_base_uri()
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
self.logger.info('Preparing headers for get_vlan_by_id.')
_headers = {'accept': 'application/json'}
# Prepare and execute request
self.logger.info(
'Preparing and executing request for get_vlan_by_id.')
_request = self.http_client.get(_query_url, headers=_headers)
AuthManager.apply(_request, self.config)
_context = self.execute_request(_request, name='get_vlan_by_id')
# Endpoint and global error handling using HTTP status codes.
self.logger.info('Validating response for get_vlan_by_id.')
if _context.response.status_code == 404:
raise APIException('Not Found', _context)
elif (_context.response.status_code <
200) or (_context.response.status_code > 208):
raise RequestErrorErrorException('Error', _context)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body,
Vlan.from_dictionary)
except Exception as e:
self.logger.error(e, exc_info=True)
raise
[docs] def update_vlan(self, id, body=None):
"""Does a PUT request to /public/vlans/{id}.
Returns the created or updated VLAN on the Cohesity Cluster.
Args:
id (int): Specifies the id of the VLAN.
body (Vlan, optional): TODO: type description here. Example:
Returns:
Vlan: 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.
"""
try:
self.logger.info('update_vlan called.')
# Validate required parameters
self.logger.info('Validating required parameters for update_vlan.')
self.validate_parameters(id=id)
# Prepare query URL
self.logger.info('Preparing query URL for update_vlan.')
_url_path = '/public/vlans/{id}'
_url_path = APIHelper.append_url_with_template_parameters(
_url_path, {'id': id})
_query_builder = self.config.get_base_uri()
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
self.logger.info('Preparing headers for update_vlan.')
_headers = {
'accept': 'application/json',
'content-type': 'application/json; charset=utf-8'
}
# Prepare and execute request
self.logger.info(
'Preparing and executing request for update_vlan.')
_request = self.http_client.put(
_query_url,
headers=_headers,
parameters=APIHelper.json_serialize(body))
AuthManager.apply(_request, self.config)
_context = self.execute_request(_request, name='update_vlan')
# Endpoint and global error handling using HTTP status codes.
self.logger.info('Validating response for update_vlan.')
if _context.response.status_code == 0:
raise RequestErrorErrorException('Error', _context)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body,
Vlan.from_dictionary)
except Exception as e:
self.logger.error(e, exc_info=True)
raise