networkapi.interface package

Subpackages

• networkapi.interface.resource package
  • Submodules
  • networkapi.interface.resource.InterfaceDisconnectResource module
  • networkapi.interface.resource.InterfaceGetResource module
  • networkapi.interface.resource.InterfaceResource module
  • Module contents
• networkapi.interface.test package
  • Submodules
  • networkapi.interface.test.test_Interface module
  • Module contents

Submodules

networkapi.interface.models module

exception networkapi.interface.models.BackLinkNotFoundError(cause, message=None)

Bases: networkapi.interface.models.InterfaceError

Retorna exceção quando ligacao_back informada for inexistente.

class networkapi.interface.models.EnvironmentInterface(*args, **kwargs)

Bases: networkapi.models.BaseModel.BaseModel

EnvironmentInterface(id, ambiente_id, interface_id, vlans)

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception EnvironmentInterface.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

EnvironmentInterface.ambiente

EnvironmentInterface.create(authenticated_user)

Add new interface_do_ambiente

EnvironmentInterface.create_v3(interface_environments)

Set new relationship between an interface and an environment.

classmethod EnvironmentInterface.get_by_interface(id)

EnvironmentInterface.interface

EnvironmentInterface.log = <celery.utils.log.ProcessAwareLogger object at 0x7fdee2e35050>

EnvironmentInterface.objects = <networkapi.models.BaseManager.BaseManager object at 0x7fdee2e35c90>

EnvironmentInterface.remove_v3()

exception networkapi.interface.models.FrontLinkNotFoundError(cause, message=None)

Bases: networkapi.interface.models.InterfaceError

Retorna exceção quando ligacao_front informada for inexistente.

class networkapi.interface.models.Interface(*args, **kwargs)

Bases: networkapi.models.BaseModel.BaseModel

Interface(equipamento_id, interface, protegida, descricao, id, ligacao_front_id, ligacao_back_id, vlan_nativa, tipo_id, channel_id)

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception Interface.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

Interface.channel

Interface.connecting_interfaces(interfaces)

Interface.create(authenticated_user)

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

Interface.create_connection(front=None, back=None)

Interface.create_v3(interface)

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

Interface.delete()

Override Django method to remove interface.

Before removing interface, removes all relationships between this interface and others.

Interface.disconnecting_interfaces(interfaces)

Interface.environmentinterface_set

Interface.equipamento

classmethod Interface.get_by_interface_equipment(interface, equipment_id)

classmethod Interface.get_by_pk(id)

Interface.get_server_switch_or_router_interface_from_host_interface(protegida=None)

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.

Interface.get_switch_and_router_interface_from_host_interface(protegida=None)

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.

Interface.get_switch_interface_from_host_interface(protegida=None)

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

Interface.interfaces_back

Interface.interfaces_front

Interface.ligacao_back

Interface.ligacao_front

Interface.log = <celery.utils.log.ProcessAwareLogger object at 0x7fdee2e44d90>

Interface.objects = <networkapi.models.BaseManager.BaseManager object at 0x7fdee2e35450>

classmethod Interface.remove(authenticated_user, id_interface)

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

Interface.remove_connection(front=None, back=None)

Interface.remove_v3()

Before removing it eliminates all your relationships.

classmethod Interface.search(equipment_id=None)

Interface.search_front_back_interfaces()

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.

Interface.search_interfaces(from_interface)

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.

Interface.tipo

classmethod Interface.update(authenticated_user, id_interface, **kwargs)

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

Interface.update_v3(interface)

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 networkapi.interface.models.InterfaceError(cause, message=None)

Bases: exceptions.Exception

Representa um erro ocorrido durante acesso à tabela interfaces.

exception networkapi.interface.models.InterfaceForEquipmentDuplicatedError(cause, message=None)

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)

Bases: networkapi.interface.models.InterfaceError

Exception thrown when try to remove connection between interfaces

exception networkapi.interface.models.InterfaceNotFoundError(cause, message=None)

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)

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)

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)

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(*args, **kwargs)

Bases: networkapi.models.BaseModel.BaseModel

PortChannel(id, nome, lacp)

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception PortChannel.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

PortChannel.create(authenticated_user=None)

Add new port channel

PortChannel.delete(user=None)

Override Django method to remove port channel.

classmethod PortChannel.get_by_name(name)

classmethod PortChannel.get_by_pk(id)

PortChannel.interface_set

PortChannel.list_interfaces()

Override Django method to remove port channel.

PortChannel.log = <celery.utils.log.ProcessAwareLogger object at 0x7fdee2e443d0>

PortChannel.objects = <networkapi.models.BaseManager.BaseManager object at 0x7fdee2e44890>

class networkapi.interface.models.TipoInterface(*args, **kwargs)

Bases: networkapi.models.BaseModel.BaseModel

TipoInterface(id, tipo)

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception TipoInterface.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

classmethod TipoInterface.get_by_name(name)

“Get TipoInterface by tipo. @return: TipoInterface.

classmethod TipoInterface.get_by_pk(ids)

TipoInterface.interface_set

TipoInterface.log = <celery.utils.log.ProcessAwareLogger object at 0x7fdee2e44290>

TipoInterface.objects = <networkapi.models.BaseManager.BaseManager object at 0x7fdee2e44450>

Module contents