networkapi.interface package¶
Submodules¶
networkapi.interface.models module¶
-
exception
networkapi.interface.models.
BackLinkNotFoundError
(cause, message=None)[source]¶ Bases:
networkapi.interface.models.InterfaceError
Retorna exceção quando ligacao_back informada for inexistente.
-
class
networkapi.interface.models.
EnvironmentInterface
(id, ambiente_id, interface_id, vlans)[source]¶ Bases:
networkapi.models.BaseModel.BaseModel
-
exception
DoesNotExist
¶ Bases:
django.core.exceptions.ObjectDoesNotExist
-
exception
MultipleObjectsReturned
¶ Bases:
django.core.exceptions.MultipleObjectsReturned
-
ambiente
¶
-
create_v3
(interface_environments)[source]¶ Set new relationship between an interface and an environment.
-
interface
¶
-
log
= <celery.utils.log.ProcessAwareLogger object>¶
-
objects
= <networkapi.models.BaseManager.BaseManager object>¶
-
exception
-
exception
networkapi.interface.models.
FrontLinkNotFoundError
(cause, message=None)[source]¶ Bases:
networkapi.interface.models.InterfaceError
Retorna exceção quando ligacao_front informada for inexistente.
-
class
networkapi.interface.models.
Interface
(equipamento_id, interface, protegida, descricao, id, ligacao_front_id, ligacao_back_id, vlan_nativa, tipo_id, channel_id)[source]¶ Bases:
networkapi.models.BaseModel.BaseModel
-
exception
DoesNotExist
¶ Bases:
django.core.exceptions.ObjectDoesNotExist
-
exception
MultipleObjectsReturned
¶ Bases:
django.core.exceptions.MultipleObjectsReturned
-
channel
¶
-
create
(authenticated_user)[source]¶ Add new interface
@param authenticated_user: User Authentication @return: Interface instance
@raise EquipamentoNotFoundError: Equipment doesn’t exist @raise EquipamentoError: Failed to find equipment @raise FrontLinkNotFoundError: FrontEnd interface doesn’t exist @raise BackLinkNotFoundError: BackEnd interface doesn’t exist @raise InterfaceForEquipmentDuplicatedError: An interface with the same name on the same equipment already exists @raise InterfaceError: Failed to add new interface
-
create_v3
(interface)[source]¶ Add new interface
@return: Interface instance @raise EquipamentoNotFoundError: Equipment doesn’t exist @raise EquipamentoError: Failed to find equipment @raise FrontLinkNotFoundError: FrontEnd interface doesn’t exist @raise BackLinkNotFoundError: BackEnd interface doesn’t exist @raise InterfaceForEquipmentDuplicatedError: An interface with the same name on the same equipment already exists @raise InterfaceError: Failed to add new interface
-
delete
()[source]¶ Override Django method to remove interface.
Before removing interface, removes all relationships between this interface and others.
-
environmentinterface_set
¶
-
equipamento
¶
-
get_server_switch_or_router_interface_from_host_interface
(protegida=None)[source]¶ A partir da ligacao_front da interface local busca uma interface ligada a um equipamento do tipo SWITCH.
@param protegida: Indicação do campo ‘protegida’ da interface do switch.
@return: Interface ligada a um equipamento do tipo SWITCH.
@raise InterfaceError: Falha ao pesquisar a interface do switch
@raise InterfaceNotFoundError: Interface do switch não encontrada.
@raise InterfaceProtectedError: A interface do switch está com o campo protegida diferente do parâmetro.
-
get_switch_and_router_interface_from_host_interface
(protegida=None)[source]¶ A partir da ligacao_front da interface local busca uma interface ligada a um equipamento do tipo SWITCH.
@param protegida: Indicação do campo ‘protegida’ da interface do switch.
@return: Interface ligada a um equipamento do tipo SWITCH.
@raise InterfaceError: Falha ao pesquisar a interface do switch
@raise InterfaceNotFoundError: Interface do switch não encontrada.
@raise InterfaceProtectedError: A interface do switch está com o campo protegida diferente do parâmetro.
-
get_switch_interface_from_host_interface
(protegida=None)[source]¶ A partir da ligacao_front da interface local busca uma interface ligada a um equipamento do tipo SWITCH. @param protegida: Indicação do campo ‘protegida’ da interface do switch @return: Interface ligada a um equipamento do tipo SWITCH. @raise InterfaceError: Falha ao pesquisar a interface do switch @raise InterfaceNotFoundError: Interface do switch não encontrada. @raise InterfaceProtectedError: A interface do switch está com o campo protegida diferente do parâmetr
-
interfaces_back
¶
-
interfaces_front
¶
-
ligacao_back
¶
-
ligacao_front
¶
-
log
= <celery.utils.log.ProcessAwareLogger object>¶
-
objects
= <networkapi.models.BaseManager.BaseManager object>¶
-
classmethod
remove
(authenticated_user, id_interface)[source]¶ Removes an interface
@param id_interface: Interface identifier
@return: Nothing
@raise InterfaceNotFoundError: Interface doesn’t exist @raise InterfaceUsedByOtherInterfaceError: Interface is connected to other interface and cannot be removed @raise InterfaceError: Failed to remove interface
-
search_front_back_interfaces
()[source]¶ Busca todas as interfaces ligadas no front e no back da interface.
Retorna um set vazio se não tiver nenhuma interface nas ligações.
@return: Set de interfaces.
@raise InterfaceError: Falha na consulta de interfaces.
-
search_interfaces
(from_interface)[source]¶ Retorna a interface e as todas as interfaces ligadas no front ou no back da mesma.
Se a interface do front é a interface “from_interface” então deverá seguir a ligação pelo back, caso contrário, deverá seguir pelo front.
A busca encerra quando não tem mais ligação ou quando encontra um “loop” por erro na configuração do banco de dados.
@param from_interface: Interface de origem da consulta.
@return: Lista de interfaces.
@raise InterfaceError: Falha na consulta de interfaces.
-
tipo
¶
-
classmethod
update
(authenticated_user, id_interface, **kwargs)[source]¶ Update interface according to arguments
@param id_interface: Interface identifier @param authenticated_user: User identifier
@return: Interface instance
@raise InterfaceNotFoundError: Interface doesn’t exist @raise FrontLinkNotFoundError: FrontEnd connection Interface doesn’t exist @raise BackLinkNotFoundError: BackEnd connection Interface doesn’t exist @raise InterfaceForEquipmentDuplicatedError: An interface with the same name on the same equipment already exists @raise InterfaceError: Failed to update interface
-
update_v3
(interface)[source]¶ Update an interface
@return: Interface instance @raise EquipamentoNotFoundError: Equipment doesn’t exist @raise EquipamentoError: Failed to find equipment @raise FrontLinkNotFoundError: FrontEnd interface doesn’t exist @raise BackLinkNotFoundError: BackEnd interface doesn’t exist @raise InterfaceForEquipmentDuplicatedError: An interface with the same name on the same equipment already exists @raise InterfaceError: Failed to add new interface
-
exception
-
exception
networkapi.interface.models.
InterfaceError
(cause, message=None)[source]¶ Bases:
exceptions.Exception
Representa um erro ocorrido durante acesso à tabela interfaces.
-
exception
networkapi.interface.models.
InterfaceForEquipmentDuplicatedError
(cause, message=None)[source]¶ Bases:
networkapi.interface.models.InterfaceError
Retorna exceção quando já existir uma interface com o mesmo nome para o equipamento informado.
-
exception
networkapi.interface.models.
InterfaceInvalidBackFrontError
(cause, message=None)[source]¶ Bases:
networkapi.interface.models.InterfaceError
Exception thrown when try to remove connection between interfaces
-
exception
networkapi.interface.models.
InterfaceNotFoundError
(cause, message=None)[source]¶ Bases:
networkapi.interface.models.InterfaceError
Retorna exceção quando não encontra a interface através da pesquisa por chave primária ou chave única.
-
exception
networkapi.interface.models.
InterfaceProtectedError
(cause, message=None)[source]¶ Bases:
networkapi.interface.models.InterfaceError
Retorna exceção quando a interface tem o status protegida diferente do pesquisado.
-
exception
networkapi.interface.models.
InterfaceUsedByOtherInterfaceError
(cause, message=None)[source]¶ Bases:
networkapi.interface.models.InterfaceError
Retorna exceção quando a interface a ser removida for utilizada por outra interface.
-
exception
networkapi.interface.models.
InvalidValueForProtectedError
(cause, message=None)[source]¶ Bases:
networkapi.interface.models.InterfaceError
Retorna exceção quando o valor informado para o atributo “protegida” da interface for inválido.
-
class
networkapi.interface.models.
PortChannel
(id, nome, lacp)[source]¶ Bases:
networkapi.models.BaseModel.BaseModel
-
exception
DoesNotExist
¶ Bases:
django.core.exceptions.ObjectDoesNotExist
-
exception
MultipleObjectsReturned
¶ Bases:
django.core.exceptions.MultipleObjectsReturned
-
interface_set
¶
-
log
= <celery.utils.log.ProcessAwareLogger object>¶
-
objects
= <networkapi.models.BaseManager.BaseManager object>¶
-
exception
-
class
networkapi.interface.models.
TipoInterface
(id, tipo)[source]¶ Bases:
networkapi.models.BaseModel.BaseModel
-
exception
DoesNotExist
¶ Bases:
django.core.exceptions.ObjectDoesNotExist
-
exception
MultipleObjectsReturned
¶ Bases:
django.core.exceptions.MultipleObjectsReturned
-
interface_set
¶
-
log
= <celery.utils.log.ProcessAwareLogger object>¶
-
objects
= <networkapi.models.BaseManager.BaseManager object>¶
-
exception