networkapi.api_vrf package

Submodules

networkapi.api_vrf.exceptions module

exception networkapi.api_vrf.exceptions.VrfAssociatedToVirtualInterface(detail=None)[source]

Bases: rest_framework.exceptions.APIException

default_detail = 'Error on deleting Vrf.'
status_code = 400
exception networkapi.api_vrf.exceptions.VrfAssociatedToVlanEquipment(detail=None)[source]

Bases: rest_framework.exceptions.APIException

default_detail = 'Error on deleting Vrf.'
status_code = 500
exception networkapi.api_vrf.exceptions.VrfError(msg=None)[source]

Bases: rest_framework.exceptions.APIException

default_detail = 'Error Internal.'
status_code = 500
exception networkapi.api_vrf.exceptions.VrfNotFoundError(detail=None)[source]

Bases: rest_framework.exceptions.APIException

default_detail = 'Vrf Does Not Exist.'
status_code = 404
exception networkapi.api_vrf.exceptions.VrfRelatedToEnvironment(detail=None)[source]

Bases: rest_framework.exceptions.APIException

default_detail = 'Error on deleting Vrf.'
status_code = 500

networkapi.api_vrf.facade module

networkapi.api_vrf.facade.create_vrf(vrf)[source]

Create vrf

Parameters:env – dict
networkapi.api_vrf.facade.delete_vrf(vrf_id)[source]

Delete vrf

Parameters:vrf_id – int
networkapi.api_vrf.facade.get_vrf_by_id(vrf_id)[source]

Return a vrf by id

Parameters:vrf_id – id of vrf
networkapi.api_vrf.facade.get_vrfs_by_ids(vrf_ids)[source]

Return vrf list by ids

Parameters:vrf_ids – ids list

Return a list of vrfs by dict

Parameters:search – dict
networkapi.api_vrf.facade.update_vrf(vrf)[source]

Update vrf

Parameters:vrf – dict

networkapi.api_vrf.models module

class networkapi.api_vrf.models.Vrf(id, vrf, internal_name)[source]

Bases: networkapi.models.BaseModel.BaseModel

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

ambiente_set
create(authenticated_user)[source]

Include new Vrf.

@return: Id new Vrf

@raise FilterNotFoundError: Dont’ exist filter for pk searched

classmethod get_by_pk(id_vrf)[source]

Get Vrf by id.

@return: Vrf.

@raise VrfNotFoundError: Vrf is not registered. @raise VrfError: Failed to search for the Vrf. @raise OperationalError: Lock wait timeout exceed

log = <celery.utils.log.ProcessAwareLogger object>
objects = <networkapi.models.BaseManager.BaseManager object>
classmethod remove(pk)[source]

Remove vrf.

@return: Nothing

@raise VrfNotFoundError: It doesn’ exist Vrf to searched id

@raise VrfRelatedToEnvironment: At least one Environment is using this Vrf

@raise VrfAssociatedToVlanEquipment: At least one Vlan and Equipment are
associated together to this Vrf
classmethod update(authenticated_user, pk, **kwargs)[source]

Change some Vrf.

@return: Nothing

@raise VrfNotFoundError: It doesn’t exist Vrf for searched pk.

@raise CannotDissociateFilterError: Filter in use, can’t be dissociated.

vrfequipment_set
vrfvlanequipment_set
class networkapi.api_vrf.models.VrfEquipment(id, vrf_id, equipment_id, internal_name)[source]

Bases: networkapi.models.BaseModel.BaseModel

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

equipment
log = <celery.utils.log.ProcessAwareLogger object>
objects = <networkapi.models.BaseManager.BaseManager object>
vrf
class networkapi.api_vrf.models.VrfVlanEquipment(id, vrf_id, vlan_id, equipment_id)[source]

Bases: networkapi.models.BaseModel.BaseModel

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

equipment
log = <celery.utils.log.ProcessAwareLogger object>
objects = <networkapi.models.BaseManager.BaseManager object>
vlan
vrf

networkapi.api_vrf.serializers module

networkapi.api_vrf.urls module

networkapi.api_vrf.views module

Module contents