networkapi.equipamento package

Subpackages

• networkapi.equipamento.resource package
  • Submodules
  • networkapi.equipamento.resource.BrandAddResource module
  • networkapi.equipamento.resource.BrandAlterRemoveResource module
  • networkapi.equipamento.resource.BrandGetAllResource module
  • networkapi.equipamento.resource.EquipAccessEditResource module
  • networkapi.equipamento.resource.EquipAccessGetResource module
  • networkapi.equipamento.resource.EquipAccessListResource module
  • networkapi.equipamento.resource.EquipScriptListResource module
  • networkapi.equipamento.resource.EquipamentoAcessoResource module
  • networkapi.equipamento.resource.EquipamentoEditResource module
  • networkapi.equipamento.resource.EquipamentoGrupoResource module
  • networkapi.equipamento.resource.EquipamentoResource module
  • networkapi.equipamento.resource.EquipmentEnvironmentDeallocateResource module
  • networkapi.equipamento.resource.EquipmentFindResource module
  • networkapi.equipamento.resource.EquipmentGetAllResource module
  • networkapi.equipamento.resource.EquipmentGetByGroupEquipmentResource module
  • networkapi.equipamento.resource.EquipmentGetRealRelated module
  • networkapi.equipamento.resource.EquipmentListResource module
  • networkapi.equipamento.resource.EquipmentScriptAddResource module
  • networkapi.equipamento.resource.EquipmentScriptGetAllResource module
  • networkapi.equipamento.resource.EquipmentScriptRemoveResource module
  • networkapi.equipamento.resource.EquipmentTypeAddResource module
  • networkapi.equipamento.resource.EquipmentTypeGetAllResource module
  • networkapi.equipamento.resource.ModelAddResource module
  • networkapi.equipamento.resource.ModelAlterRemoveResource module
  • networkapi.equipamento.resource.ModelGetAllResource module
  • networkapi.equipamento.resource.ModelGetByBrandResource module
  • Module contents
• networkapi.equipamento.response package
  • Module contents
• networkapi.equipamento.test package
  • Submodules
  • networkapi.equipamento.test.test_Brand module
  • networkapi.equipamento.test.test_Equipment module
  • networkapi.equipamento.test.test_EquipmentAccess module
  • networkapi.equipamento.test.test_EquipmentEnvironment module
  • networkapi.equipamento.test.test_EquipmentScript module
  • networkapi.equipamento.test.test_EquipmentType module
  • networkapi.equipamento.test.test_Model module
  • Module contents

Submodules

networkapi.equipamento.models module

exception networkapi.equipamento.models.EquipTypeCantBeChangedError(cause, message=None)

Bases: networkapi.equipamento.models.EquipamentoError

class networkapi.equipamento.models.Equipamento(id, tipo_equipamento_id, modelo_id, nome, maintenance)

Bases: networkapi.models.BaseModel.BaseModel

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

asn

asn_id

asnequipment_set

create(authenticated_user, group_id)

Insere um novo Equipamento

Se o grupo do equipamento, informado nos dados da requisição, for igual à “Equipamentos Orquestracao” (id = 1) então o tipo do equipamento deverá ser igual a “Servidor Virtual” (id = 10).

@return: Nothing

@raise InvalidGroupToEquipmentTypeError: Equipamento do grupo “Equipamentos Orquestração” somente poderá ser criado com tipo igual a “Servidor Virtual”.

@raise EGrupoNotFoundError: Grupo não cadastrado.

@raise GrupoError: Falha ao pesquisar o Grupo.

@raise TipoEquipamentoNotFoundError: Tipo de equipamento nao cadastrado.

@raise ModeloNotFoundError: Modelo nao cadastrado.

@raise EquipamentoNameDuplicatedError: Nome do equipamento duplicado.

@raise EquipamentoError: Falha ou inserir o equipamento.

create_v3(equipment)

create_v4(equipment)

delete()

Sobrescreve o metodo do Django para remover um equipamento.

Antes de remover o equipamento remove todos os seus relacionamentos.

delete_v3()

Before removing the computer it eliminates all your relationships.

delete_v4()

Before removing the computer it eliminates all your relationships.

edit(user, nome, tipo_equip, modelo, maintenance=None)

environments

equipamento_ilo

equipamento_sw1

equipamento_sw2

equipamentoacesso_set

equipamentoambiente_set

equipamentogrupo_set

equipamentoroteiro_set

equipment_controller_environment

equipmentcontrollerenvironment_set

equipmentlistconfig_set

equipmentroutemap_set

classmethod get_by_name(name)

classmethod get_by_pk(pk, *prefetch_list)

Get Equipament by id.

@return: Equipament.

@raise EquipamentoNotFoundError: Equipament is not registered. @raise EquipamentoError: Failed to search for the Equipament. @raise OperationalError: Lock wait timeout exceeded.

classmethod get_next_name_by_prefix(prefix)

groups

grupos

interface_set

ipequipamento_set

ipv4

ipv4_equipment

ipv6

ipv6_equipment

ipv6equipament_set

listconfigbgp_set

log = <celery.utils.log.ProcessAwareLogger object>

modelo

objects = <networkapi.models.BaseManager.BaseManager object>

remove(authenticated_user, equip_id)

Pesquisa e remove o equipamento.

@return: Nothing

@raise EquipamentoNotFoundError: Não existe um equipamento com equip_id .

@raise EquipamentoError: Falha ao remover o equipamento.

routemap_set

search(equip_name=None, equip_type_id=None, environment_id=None, ugroups=None)

tipo_equipamento

update_v3(equipment)

update_v4(equipment)

vrfequipment_set

vrfvlanequipment_set

exception networkapi.equipamento.models.EquipamentoAccessDuplicatedError(cause, message=None)

Bases: networkapi.equipamento.models.EquipamentoError

Retorna exceção porque já existe um Equipamento cadastrado com o mesmo nome.

exception networkapi.equipamento.models.EquipamentoAccessNotFoundError(cause, message=None)

Bases: networkapi.equipamento.models.EquipamentoError

Retorna exceção para pesquisa de modelo de equipamento por chave primária.

class networkapi.equipamento.models.EquipamentoAcesso(id, equipamento_id, fqdn, user, password, tipo_acesso_id, enable_pass)

Bases: networkapi.models.BaseModel.BaseModel

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

create(authenticated_user)

Efetua a inclusão de informações de acesso a equipamentos @return: Instância da informação de acesso a equipamento incluída @raise Equipamento.DoesNotExist: Equipamento informado é inexistente @raise TipoAcesso.DoesNotExist: Tipo de acesso informado é inexistente @raise EquipamentoAccessDuplicatedError: Já existe cadastrada a associação de equipamento e tipo de acesso informada @raise EquipamentoError: Falha ao incluir informações de acesso a equipamentos.

equipamento

classmethod get_by_pk(id)

Get EquipamentoAcesso by id.

@return: EquipamentoAcesso.

@raise EquipamentoAccessNotFoundError: EquipamentoAcesso is not registered. @raise VlanError: Failed to search for the EquipamentoAcesso. @raise OperationalError: Lock wait timeout exceed

log = <celery.utils.log.ProcessAwareLogger object>

objects = <networkapi.models.BaseManager.BaseManager object>

classmethod remove(authenticated_user, id_equipamento, id_tipo_acesso)

Efetua a remoção de um tipo de acesso @param id_equipamento: Identificador do equipamento da informação de acesso a equipamento a ser excluída @param id_tipo_acesso: Identificador do tipo de acesso da informação de acesso a equipamento a ser excluída @return: nothing @raise EquipamentoAcesso.DoesNotExist: Informação de acesso a equipamento informada é inexistente @raise EquipamentoError: Falha ao alterar informação de acesso a equipamento.

classmethod search(ugroups=None, equipamento=None, protocolo=None)

Efetua a pesquisa das informações de acesso a equipamentos @return: Um queryset contendo as informações de aceso a equipamentos cadastrados @raise EquipamentoError: Falha ao pesquisar as informações de acesso a equipamentos.

tipo_acesso

classmethod update(authenticated_user, id_equipamento, id_tipo_acesso, **kwargs)

Efetua a alteração de informações de acesso a equipamentos conforme argumentos recebidos @param id_equipamento: Identificador do equipamento da informação de acesso a equipamento a ser alterada @param id_tipo_acesso: Identificador do tipo de acesso da informação de acesso a equipamento a ser alterada @return: Instância da informação de acesso a equipamento alterada @raise EquipamentoAcesso.DoesNotExist: Informação de acesso a equipamento informada é inexistente @raise EquipamentoError: Falha ao alterar informação de acesso a equipamento.

class networkapi.equipamento.models.EquipamentoAmbiente(id, ambiente_id, equipamento_id, is_router)

Bases: networkapi.models.BaseModel.BaseModel

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

ambiente

create(authenticated_user=None)

Insere uma nova associação entre um Equipamento e um Ambiente.

@return: Nothing

@raise AmbienteNotFoundError: Ambiente não cadastrado.

@raise EquipamentoAmbienteDuplicatedError: Equipamento já está cadastrado no Ambiente.

@raise EquipamentoError: Falha ao inserir a associação Equipamento e Ambiente.

create_v3(eqpt_env_map)

Insert a new relashionship between an equipment and an environment.

@return: Nothing

@raise AmbienteNotFoundError: Environment not registered. @raise EquipamentoAmbienteDuplicatedError: Equipment already

registered in environment.

@raise EquipamentoError: Failure to insert the relashionship

between equipment and environment.

equipamento

get_by_environment(environment_id)

classmethod get_by_equipment(equipment_id)

get_by_equipment_environment(equipment_id, environment_id)

classmethod get_routers_by_environment(environment_id)

log = <celery.utils.log.ProcessAwareLogger object>

objects = <networkapi.models.BaseManager.BaseManager object>

classmethod remove(authenticated_user, equip_id, environ_id)

Pesquisa e remove uma associação entre um Equipamento e um Ambiente.

@return: Nothing

@raise EquipamentoAmbienteNotFoundError: Não existe associação entre o equipamento e o ambiente.

@raise EquipamentoError: Falha ao remover uma associação entre um Equipamento e um Ambiente.

exception networkapi.equipamento.models.EquipamentoAmbienteDuplicatedError(cause, message=None)

Bases: networkapi.equipamento.models.EquipamentoError

Retorna exceção quando o equipamento_ambiente já existe.

exception networkapi.equipamento.models.EquipamentoAmbienteNotFoundError(cause, message=None)

Bases: networkapi.equipamento.models.EquipamentoError

Retorna exceção para pesquisa de equipamento_ambiente por chave primária ou equipamento e ambiente.

exception networkapi.equipamento.models.EquipamentoError(cause, message=None)

Bases: exceptions.Exception

Representa um erro ocorrido durante acesso à tabelas relacionadas com Equipamento.

class networkapi.equipamento.models.EquipamentoGrupo(id, egrupo_id, equipamento_id)

Bases: networkapi.models.BaseModel.BaseModel

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

create(authenticated_user=None)

Insere uma nova associação entre um Equipamento e um Grupo.

@return: Nothing

@raise EGrupoNotFoundError: Grupo não cadastrado.

@raise GrupoError: Falha ao pesquisar o grupo do equipamento.

@raise EquipamentoGrupoDuplicatedError: Equipamento já está cadastrado no grupo

@raise EquipamentoError: Falha ao inserir o equipamento no grupo.

egrupo

equipamento

classmethod get_by_equipment(equipment_id)

get_by_equipment_group(equipment_id, egroup_id)

log = <celery.utils.log.ProcessAwareLogger object>

objects = <networkapi.models.BaseManager.BaseManager object>

classmethod remove(authenticated_user, equip_id, egroup_id)

Pesquisa e remove uma associação entre um Equipamento e um Grupo.

@return: Nothing

@raise EquipamentoGrupoNotFoundError: Associação entre o equipamento e o grupo não cadastrada.

@raise EquipamentoError: Falha ao remover uma associação entre um Equipamento e um Grupo.

exception networkapi.equipamento.models.EquipamentoGrupoDuplicatedError(cause, message=None)

Bases: networkapi.equipamento.models.EquipamentoError

Retorna exceção quando o equipamento_grupo já existe.

exception networkapi.equipamento.models.EquipamentoGrupoNotFoundError(cause, message=None)

Bases: networkapi.equipamento.models.EquipamentoError

Retorna exceção para pesquisa de equipamento_grupo por chave primária.

exception networkapi.equipamento.models.EquipamentoNameDuplicatedError(cause, message=None)

Bases: networkapi.equipamento.models.EquipamentoError

Retorna exceção porque já existe um Equipamento cadastrado com o mesmo nome.

exception networkapi.equipamento.models.EquipamentoNotFoundError(cause, message=None)

Bases: networkapi.equipamento.models.EquipamentoError

Retorna exceção para pesquisa de equipamento por chave primária.

class networkapi.equipamento.models.EquipamentoRoteiro(id, equipamento_id, roteiro_id)

Bases: networkapi.models.BaseModel.BaseModel

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

create(authenticated_user)

Insere uma nova associação entre um Equipamento e um Roteiro.

@return: Nothing

@raise RoteiroNotFoundError: Roteiro não cadastrado.

@raise RoteiroError: Falha ao pesquisar o roteiro.

@raise EquipamentoRoteiroDuplicatedError: Equipamento já está associado ao roteiro.

@raise EquipamentoError: Falha ao inserir o equipamento no roteiro.

equipamento

log = <celery.utils.log.ProcessAwareLogger object>

objects = <networkapi.models.BaseManager.BaseManager object>

classmethod remove(authenticated_user, equip_id, script_id)

Pesquisa e remove uma associação entre um Equipamento e um Roteiro.

@return: Nothing

@raise EquipamentoRoteiroNotFoundError: Não existe associação entre o equipamento e o roteiro.

@raise EquipamentoError: Falha ao remover uma associação entre um Equipamento e um Roteiro.

roteiro

classmethod search(ugroups=None, equip_id=None, roteiro_type=None)

exception networkapi.equipamento.models.EquipamentoRoteiroDuplicatedError(cause, message=None)

Bases: networkapi.equipamento.models.EquipamentoError

Retorna exceção quando o equipamento_roteiro já existe.

exception networkapi.equipamento.models.EquipamentoRoteiroNotFoundError(cause, message=None)

Bases: networkapi.equipamento.models.EquipamentoError

Retorna exceção para pesquisa de equipamento_roteiro.

class networkapi.equipamento.models.EquipmentControllerEnvironment(id, environment_id, equipment_id)

Bases: networkapi.models.BaseModel.BaseModel

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

create(eqpt_env_map)

Insert a new relashionship between an equipment and an environment.

@return: Nothing

@raise AmbienteNotFoundError: Environment not registered. @raise EquipmentControllerEnvironmentDuplicatedError: Equipment already

registered in environment.

@raise EquipamentoError: Failure to insert the relashionship

between equipment and environment.

environment

equipment

get_by_environment(environment_id)

classmethod get_by_equipment(equipment_id)

get_by_equipment_environment(equipment_id, environment_id)

log = <celery.utils.log.ProcessAwareLogger object>

objects = <networkapi.models.BaseManager.BaseManager object>

exception networkapi.equipamento.models.EquipmentControllerEnvironmentDuplicatedError(cause, message=None)

Bases: networkapi.equipamento.models.EquipamentoError

Retorna exceção quando o equipment_controller_environment já existe.

exception networkapi.equipamento.models.EquipmentControllerEnvironmentNotFoundError(cause, message=None)

Bases: networkapi.equipamento.models.EquipamentoError

Retorna exceção quando o equipment_controller_environment não existe.

exception networkapi.equipamento.models.EquipmentDontRemoveError(cause, message=None)

Bases: networkapi.equipamento.models.EquipamentoError

exception networkapi.equipamento.models.InvalidGroupToEquipmentTypeError(cause, message=None)

Bases: networkapi.equipamento.models.EquipamentoError

Equipamento do grupo “Equipamentos Orquestração” somente poderá ser criado com tipo igual a “Servidor Virtual”.

class networkapi.equipamento.models.Marca(id, nome)

Bases: networkapi.models.BaseModel.BaseModel

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

classmethod get_by_name(name)

“Get Brand by name.

@return: Brand.

@raise MarcaNotFoundError: Brand is not registered. @raise EquipamentoError: Failed to search for the Brand.

classmethod get_by_pk(idt)

“Get Brand id.

@return: Brand L3.

@raise MarcaNotFoundError: Brand is not registered. @raise EquipamentoError: Failed to search for the Brand.

log = <celery.utils.log.ProcessAwareLogger object>

modelo_set

objects = <networkapi.models.BaseManager.BaseManager object>

exception networkapi.equipamento.models.MarcaModeloNameDuplicatedError(cause, message=None)

Bases: networkapi.equipamento.models.EquipamentoError

Retorna exceção se houver um Modelo e Marca com mesmo nome já cadastrado..

exception networkapi.equipamento.models.MarcaNameDuplicatedError(cause, message=None)

Bases: networkapi.equipamento.models.EquipamentoError

Retorna exceção porque já existe uma marca cadastrado com o mesmo nome.

exception networkapi.equipamento.models.MarcaNotFoundError(cause, message=None)

Bases: networkapi.equipamento.models.EquipamentoError

Retorna exceção para pesquisa de modelo de equipamento por chave primária.

exception networkapi.equipamento.models.MarcaUsedByModeloError(cause, message=None)

Bases: networkapi.equipamento.models.EquipamentoError

Retorna exceção se houver tentativa de exclusão de marca utilizada por algum modelo.

class networkapi.equipamento.models.Modelo(id, nome, marca_id)

Bases: networkapi.models.BaseModel.BaseModel

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

equipamento_set

classmethod get_by_brand(id_brand)

“Get Model by Brand.

@return: Model.

@raise ModeloNotFoundError: Model is not registered. @raise EquipamentoError: Failed to search for the Model.

classmethod get_by_name(name)

“Get Model by name.

@return: Model.

@raise ModeloNotFoundError: Model is not registered. @raise EquipamentoError: Failed to search for the Model.

classmethod get_by_name_brand(name, id_brand)

“Get Model by Name and Brand.

@return: Model.

@raise ModeloNotFoundError: Model is not registered. @raise EquipamentoError: Failed to search for the Model.

classmethod get_by_pk(idt)

“Get Model by id.

@return: Model.

@raise RoteiroNotFoundError: Model is not registered. @raise EquipamentoError: Failed to search for the Model.

log = <celery.utils.log.ProcessAwareLogger object>

marca

modeloroteiro_set

objects = <networkapi.models.BaseManager.BaseManager object>

exception networkapi.equipamento.models.ModeloNotFoundError(cause, message=None)

Bases: networkapi.equipamento.models.EquipamentoError

Retorna exceção para pesquisa de modelo de equipamento por chave primária.

class networkapi.equipamento.models.ModeloRoteiro(id, modelo_id, roteiro_id)

Bases: networkapi.models.BaseModel.BaseModel

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

create(authenticated_user)

Insere uma nova associação entre um Modelo e um Roteiro. @return: Nothing @raise RoteiroNotFoundError: Roteiro não cadastrado. @raise RoteiroError: Falha ao pesquisar o roteiro. @raise ModeloRoteiroDuplicatedError: Equipamento já está associado ao roteiro. @raise ModeloError: Falha ao inserir o modelo no roteiro.

classmethod get_by_pk(idt)

log = <celery.utils.log.ProcessAwareLogger object>

modelo

objects = <networkapi.models.BaseManager.BaseManager object>

classmethod remover(authenticated_user, model_id, script_id)

roteiro

exception networkapi.equipamento.models.ModeloRoteiroDuplicatedError(cause, message=None)

Bases: networkapi.equipamento.models.EquipamentoError

Retorna exceção quando o modelo_roteiro já existe.

exception networkapi.equipamento.models.ModeloRoteiroNotFoundError(cause, message=None)

Bases: networkapi.equipamento.models.EquipamentoError

Retorna exceção para pesquisa de modelo_roteiro.

exception networkapi.equipamento.models.ModeloUsedByEquipamentoError(cause, message=None)

Bases: networkapi.equipamento.models.EquipamentoError

Retorna exceção se houver tentativa de exclusão de um modelo utilizado por algum equipamento.

class networkapi.equipamento.models.TipoEquipamento(id, tipo_equipamento)

Bases: networkapi.models.BaseModel.BaseModel

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

TIPO_EQUIPAMENTO_ROUTER = 3

TIPO_EQUIPAMENTO_SERVIDOR = 2

TIPO_EQUIPAMENTO_SERVIDOR_VIRTUAL = 10

TIPO_EQUIPAMENTO_SWITCH = 1

equipamento_set

filterequiptype_set

classmethod get_by_name(name)

“Get Equipment Type by name.

@return: Equipment Type.

@raise ModeloNotFoundError: Equipment Type is not registered. @raise EquipamentoError: Failed to search for the Equipment Type.

classmethod get_by_pk(idt)

“Get Equipment Type by id.

@return: Equipment Type.

@raise TipoEquipamentoNotFoundError: Equipment Type is not registered. @raise EquipamentoError: Failed to search for the Equipment Type.

classmethod get_tipo(tipo)

“Get Equipment Type by Type.

@return: Equipment Type.

@raise TipoEquipamentoNotFoundError: Equipment Type is not registered. @raise EquipamentoError: Failed to search for the Equipment Type.

classmethod get_tipo_balanceador()

“Get Equipment Type by Type is balanceador.

@return: Equipment Type.

@raise TipoEquipamentoNotFoundError: Equipment Type is not registered. @raise EquipamentoError: Failed to search for the Equipment Type.

insert_new(authenticated_user, name)

log = <celery.utils.log.ProcessAwareLogger object>

objects = <networkapi.models.BaseManager.BaseManager object>

search()

exception networkapi.equipamento.models.TipoEquipamentoDuplicateNameError(cause, message=None)

Bases: networkapi.equipamento.models.EquipamentoError

Retorna exceção porque já existe um tipo de equipamento cadastrado com o mesmo nome.

exception networkapi.equipamento.models.TipoEquipamentoNotFoundError(cause, message=None)

Bases: networkapi.equipamento.models.EquipamentoError

Retorna exceção para pesquisa de tipo de equipamento por chave primária.

Module contents