Submodules¶

networkapiclient.Ambiente module¶

class networkapiclient.Ambiente.Ambiente(networkapi_url, user, password, user_ldap=None)[source]¶

Bases: networkapiclient.GenericClient.GenericClient

add_expect_string_healthcheck(expect_string)[source]¶

Inserts a new healthckeck_expect with only expect_string.

Parameters:	expect_string – expect_string.
Returns:	Dictionary with the following structure:

{'healthcheck_expect': {'id': < id >}}

Raises:	InvalidParameterError – The value of expect_string is invalid. HealthCheckExpectJaCadastradoError – There is already a healthcheck_expect registered with the same data. HealthCheckExpectNaoExisteError – Healthcheck_expect not registered. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

add_healthcheck_expect(id_ambiente, expect_string, match_list)[source]¶

Insere um novo healthckeck_expect e retorna o seu identificador.

Parameters:	expect_string – expect_string. id_ambiente – Identificador do ambiente lógico. match_list – match list.
Returns:	Dicionário com a seguinte estrutura: {‘healthcheck_expect’: {‘id’: < id >}}
Raises:	InvalidParameterError – O identificador do ambiente, match_lis,expect_string, são inválidos ou nulo. HealthCheckExpectJaCadastradoError – Já existe um healthcheck_expect com os mesmos dados cadastrados. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao ler o XML de requisição ou gerar o XML de resposta.

add_ip_range(id_environment, id_ip_config)[source]¶

Makes relationship of environment with ip config and returns your id.

Parameters:	id_environment – Environment ID. id_ip_config – IP Configuration ID.
Returns:	Following dictionary:

{‘config_do_ambiente’: {‘id_config_do_ambiente’: < id_config_do_ambiente >}}

Raises:	InvalidParameterError – Some parameter was invalid. ConfigEnvironmentDuplicateError – Error saving duplicate Environment Configuration. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

alterar(id_ambiente, id_grupo_l3, id_ambiente_logico, id_divisao, link, id_filter=None, acl_path=None, ipv4_template=None, ipv6_template=None, min_num_vlan_1=None, max_num_vlan_1=None, min_num_vlan_2=None, max_num_vlan_2=None, vrf=None)[source]¶

Altera os dados de um ambiente a partir do seu identificador.

Parameters:	id_ambiente – Identificador do ambiente. id_grupo_l3 – Identificador do grupo layer 3. id_ambiente_logico – Identificador do ambiente lógico. id_divisao – Identificador da divisão data center. id_filter – Filter identifier. link – Link acl_path – Path where the ACL will be stored ipv4_template – Template that will be used in Ipv6 ipv6_template – Template that will be used in Ipv4 min_num_vlan_1 – Min 1 num vlan valid for this environment max_num_vlan_1 – Max 1 num vlan valid for this environment min_num_vlan_2 – Min 2 num vlan valid for this environment max_num_vlan_2 – Max 2 num vlan valid for this environment
Returns:	None
Raises:	InvalidParameterError – O identificador do ambiente, o identificador do grupo l3, o identificador do ambiente lógico, e/ou o identificador da divisão de data center são nulos ou inválidos. GrupoL3NaoExisteError – Grupo layer 3 não cadastrado. AmbienteLogicoNaoExisteError – Ambiente lógico não cadastrado. DivisaoDcNaoExisteError – Divisão data center não cadastrada. AmbienteDuplicadoError – Ambiente com o mesmo id_grupo_l3, id_ambiente_logico e id_divisao já cadastrado. AmbienteNaoExisteError – Ambiente não cadastrado. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao ler o XML de requisição ou gerar o XML de resposta.

associate(environment_id, environment_vip_id)[source]¶

Associate a news Environment on Environment VIP and returns its identifier.

Parameters:	environment_id – Identifier of the Environment. Integer value and greater than zero. environment_vip_id – Identifier of the Environment VIP. Integer value and greater than zero.
Returns:	Following dictionary:

{'environment_environment_vip': {'id': < id >}}

Raises:	InvalidParameterError – The value of environment_id or environment_vip_id is invalid. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

buscar_healthcheck_por_id(id_healthcheck)[source]¶

Get HealthCheck by id.

Parameters:	id_healthcheck – HealthCheck ID.
Returns:	Following dictionary:

{'healthcheck_expect': {'match_list': < match_list >,
 'expect_string': < expect_string >,
 'id': < id >,
 'ambiente': < ambiente >}}

Raises:	HealthCheckNaoExisteError – HealthCheck not registered. InvalidParameterError – HealthCheck identifier is null and invalid. DataBaseError – Can’t connect to networkapi database. XMLError – Failed to generate the XML response.

buscar_por_equipamento(nome_equipamento, ip_equipamento)[source]¶

Obtém um ambiente a partir do ip e nome de um equipamento.

Parameters:	nome_equipamento – Nome do equipamento. ip_equipamento – IP do equipamento no formato XXX.XXX.XXX.XXX.
Returns:	Dicionário com a seguinte estrutura:

{'ambiente': {'id': < id_ambiente >,
'link': < link >,
'id_divisao': < id_divisao >,
'nome_divisao': < nome_divisao >,
'id_ambiente_logico': < id_ambiente_logico >,
'nome_ambiente_logico': < nome_ambiente_logico >,
'id_grupo_l3': < id_grupo_l3 >,
'nome_grupo_l3': < nome_grupo_l3 >,
'id_filter': < id_filter >,
'filter_name': < filter_name >,
'ambiente_rede': < ambiente_rede >}}

Raises:	IpError – IP não cadastrado para o equipamento. InvalidParameterError – O nome e/ou o IP do equipamento são vazios ou nulos, ou o IP é inválido. EquipamentoNaoExisteError – Equipamento não cadastrado. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao gerar o XML de resposta.

buscar_por_id(id_ambiente)[source]¶

Obtém um ambiente a partir da chave primária (identificador).

Parameters:	id_ambiente – Identificador do ambiente.
Returns:	Dicionário com a seguinte estrutura:

{'ambiente': {'id': < id_ambiente >,
'link': < link >,
'id_divisao': < id_divisao >,
'nome_divisao': < nome_divisao >,
'id_ambiente_logico': < id_ambiente_logico >,
'nome_ambiente_logico': < nome_ambiente_logico >,
'id_grupo_l3': < id_grupo_l3 >,
'nome_grupo_l3': < nome_grupo_l3 >,
'id_filter': < id_filter >,
'filter_name': < filter_name >,
'acl_path': < acl_path >,
'ipv4_template': < ipv4_template >,
'ipv6_template': < ipv6_template >,
'ambiente_rede': < ambiente_rede >}}

Raises:	AmbienteNaoExisteError – Ambiente não cadastrado. InvalidParameterError – Identificador do ambiente é nulo ou inválido. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao gerar o XML de resposta.

configuration_list_all(environment_id)[source]¶

List all prefix configurations by environment in DB

Returns:	Following dictionary:

{'lists_configuration': [{
'id': <id_ipconfig>,
'subnet': <subnet>,
'type': <type>,
'new_prefix': <new_prefix>,
}, ... ]}

Raises:	InvalidValueError – Invalid ID for Environment. AmbienteNotFoundError – Environment not registered. DataBaseError – Failed into networkapi access data base. XMLError – Networkapi failed to generate the XML response.

configuration_remove(environment_id, configuration_id)[source]¶

Remove Prefix Configuration

Returns:	None
Raises:	InvalidValueError – Invalid Id for Environment or IpConfig. IPConfigNotFoundError – Ipconfig not resgistred. AmbienteNotFoundError – Environment not registered. DataBaseError – Failed into networkapi access data base. XMLError – Networkapi failed to generate the XML response.

configuration_save(id_environment, network, prefix, ip_version, network_type)[source]¶

Add new prefix configuration

Parameters:	id_environment – Identifier of the Environment. Integer value and greater than zero. network – Network Ipv4 or Ipv6. prefix – Prefix 0-32 to Ipv4 or 0-128 to Ipv6. ip_version – v4 to IPv4 or v6 to IPv6 network_type – type network
Returns:	Following dictionary:

{'network':{'id_environment': <id_environment>,
'id_vlan': <id_vlan>,
'network_type': <network_type>,
'network': <network>,
'prefix': <prefix>} }

Raises:	ConfigEnvironmentInvalidError – Invalid Environment Configuration or not registered. InvalidValueError – Invalid Id for environment or network or network_type or prefix. AmbienteNotFoundError – Environment not registered. DataBaseError – Failed into networkapi access data base. XMLError – Networkapi failed to generate the XML response.

delete_rule(id_rule)[source]¶

Removes an environment rule

Parameters:	id_rule – Rule id
Returns:	None
Raises:	AmbienteNaoExisteError – Ambiente não cadastrado. InvalidValueError – Invalid parameter. UserNotAuthorizedError – Permissão negada. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao ler o XML de requisição ou gerar o XML de resposta.

disassociate(environment_id, environment_vip_id)[source]¶

Remove a relationship of Environment with EnvironmentVip.

Parameters:	environment_id – Identifier of the Environment. Integer value and greater than zero. environment_vip_id – Identifier of the Environment VIP. Integer value and greater than zero.
Returns:	Nothing
Raises:	InvalidParameterError – Environment/Environment VIP identifier is null and/or invalid. EnvironmentNotFoundError – Environment not registered. EnvironmentVipNotFoundError – Environment VIP not registered. EnvironmentError – Option vip is not associated with the environment vip UserNotAuthorizedError – User does not have authorization to make this association. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

get_all_rules(id_env)[source]¶

Save an environment rule

Parameters:	id_env – Environment id
Returns:	Estrutura:

{ 'rules': [{'id': < id >,
'environment': < Environment Object >,
'content': < content >,
'name': < name >,
'custom': < custom > },... ]}

Raises:	AmbienteNaoExisteError – Ambiente não cadastrado. UserNotAuthorizedError – Permissão negada. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao ler o XML de requisição ou gerar o XML de resposta.

get_blocks(id_env)[source]¶

Get blocks by environment

Parameters:	id_env – Environment id
Returns:	Following dictionary:

{'blocks': [{'id' : <id>, 'content' : <content>},...] }

Raises:	UserNotAuthorizedError – Permissão negada. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao ler o XML de requisição ou gerar o XML de resposta.

get_environment_template(name, network)[source]¶

Get environments by template name

Parameters:	name – Template name. network – IPv4 or IPv6.
Returns:	Following dictionary:

{'ambiente': [divisao_dc - ambiente_logico - grupo_l3, other envs...] }

Raises:	InvalidParameterError – Invalid param. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao ler o XML de requisição ou gerar o XML de resposta.

get_related_environment_list(environment_vip_id)[source]¶

Get all Environment by Environment Vip.

Returns:	Following dictionary:

{'ambiente': [{ 'id': <id_environment>,
'grupo_l3': <id_group_l3>,
'grupo_l3_name': <name_group_l3>,
'ambiente_logico': <id_logical_environment>,
'ambiente_logico_name': <name_ambiente_logico>,
'divisao_dc': <id_dc_division>,
'divisao_dc_name': <name_divisao_dc>,
'filter': <id_filter>,
'filter_name': <filter_name>,
'link': <link> }, ... ]}

Raises:	EnvironmentVipNotFoundError – Environment VIP not registered. DataBaseError – Can’t connect to networkapi database. XMLError – Failed to generate the XML response.

get_rule_by_pk(id_rule)[source]¶

Get a rule by its identifier

Parameters:	id_rule – Rule identifier.
Returns:	Seguinte estrutura

{ 'rule': {'id': < id >,
  'environment': < Environment Object >,
  'content': < content >,
  'name': < name >,
  'custom': < custom > }}

Raises:	AmbienteNaoExisteError – Ambiente não cadastrado. InvalidValueError – Invalid parameter. UserNotAuthorizedError – Permissão negada. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao ler o XML de requisição ou gerar o XML de resposta.

inserir(id_grupo_l3, id_ambiente_logico, id_divisao, link, id_filter=None, acl_path=None, ipv4_template=None, ipv6_template=None, min_num_vlan_1=None, max_num_vlan_1=None, min_num_vlan_2=None, max_num_vlan_2=None, vrf=None)[source]¶

Insere um novo ambiente e retorna o seu identificador.

Parameters:	id_grupo_l3 – Identificador do grupo layer 3. id_ambiente_logico – Identificador do ambiente lógico. id_divisao – Identificador da divisão data center. id_filter – Filter identifier. link – Link acl_path – Path where the ACL will be stored ipv4_template – Template that will be used in Ipv6 ipv6_template – Template that will be used in Ipv4 min_num_vlan_1 – Min 1 num vlan valid for this environment max_num_vlan_1 – Max 1 num vlan valid for this environment min_num_vlan_2 – Min 2 num vlan valid for this environment max_num_vlan_2 – Max 2 num vlan valid for this environment
Returns:	Dicionário com a seguinte estrutura: {‘ambiente’: {‘id’: < id >}}
Raises:	InvalidParameterError – O identificador do grupo l3, o identificador do ambiente lógico, e/ou o identificador da divisão de data center são nulos ou inválidos. GrupoL3NaoExisteError – Grupo layer 3 não cadastrado. AmbienteLogicoNaoExisteError – Ambiente lógico não cadastrado. DivisaoDcNaoExisteError – Divisão datacenter não cadastrada. AmbienteDuplicadoError – Ambiente com o mesmo id_grupo_l3, id_ambiente_logico e id_divisao já cadastrado. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao ler o XML de requisição ou gerar o XML de resposta.

insert_with_ip_range(id_l3_group, id_logical_environment, id_division, id_ip_config, link, id_filter=None)[source]¶

Insert new environment with ip config and returns your id.

Parameters:	id_l3_group – Layer 3 Group ID. id_logical_environment – Logical Environment ID. id_division – Data Center Division ID. id_filter – Filter identifier. id_ip_config – IP Configuration ID. link – Link.
Returns:	Following dictionary: {‘ambiente’: {‘id’: < id >}}
Raises:	ConfigEnvironmentDuplicateError – Error saving duplicate Environment Configuration. InvalidParameterError – Some parameter was invalid. GrupoL3NaoExisteError – Layer 3 Group not found. AmbienteLogicoNaoExisteError – Logical Environment not found. DivisaoDcNaoExisteError – Data Center Division not found. AmbienteDuplicadoError – Environment with this parameters already exists. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

list_acl_path()[source]¶

Get all distinct acl paths.

Returns:	Dictionary with the following structure:

{'acl_paths': [
 < acl_path >,
 ... ]}

Raises:	DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

list_all()[source]¶

List all environments in DB

Returns:	Following dictionary:

{'ambiente': [{ 'id': <id_environment>,
'grupo_l3': <id_group_l3>,
'grupo_l3_name': <name_group_l3>,
'ambiente_logico': <id_logical_environment>,
'ambiente_logico_name': <name_ambiente_logico>,
'divisao_dc': <id_dc_division>,
'divisao_dc_name': <name_divisao_dc>,
'filter': <id_filter>,
'filter_name': <filter_name>,
'link': <link> }, ... ]}

Raises DataBaseError:
	Falha na networkapi ao acessar o banco de dados.

list_no_blocks()[source]¶

List all environments in DB without blocks

Returns:	Following dictionary:

{'ambiente': [{'id': <id_environment>,
  'grupo_l3': <id_group_l3>,
  'grupo_l3_name': <name_group_l3>
  'ambiente_logico': <id_logical_environment>,
  'ambiente_logico_name': <name_ambiente_logico>
  'divisao_dc': <id_dc_division>,
  'divisao_dc_name': <name_divisao_dc>,
  'filter': <id_filter>,
  'filter_name': <filter_name>,
  'link': <link> }, ... ]}

Raises DataBaseError:
	Falha na networkapi ao acessar o banco de dados.

listar(id_divisao=None, id_ambiente_logico=None)[source]¶

Lista os ambientes filtrados conforme parâmetros informados.

Se os dois parâmetros têm o valor None então retorna todos os ambientes. Se o id_divisao é diferente de None então retorna os ambientes filtrados pelo valor de id_divisao. Se o id_divisao e id_ambiente_logico são diferentes de None então retorna os ambientes filtrados por id_divisao e id_ambiente_logico.

Parameters:	id_divisao – Identificador da divisão de data center. id_ambiente_logico – Identificador do ambiente lógico.
Returns:	Dicionário com a seguinte estrutura:

{'ambiente': [{'id': < id_ambiente >,
'link': < link >,
'id_divisao': < id_divisao >,
'nome_divisao': < nome_divisao >,
'id_ambiente_logico': < id_ambiente_logico >,
'nome_ambiente_logico': < nome_ambiente_logico >,
'id_grupo_l3': < id_grupo_l3 >,
'nome_grupo_l3': < nome_grupo_l3 >,
'id_filter': < id_filter >,
'filter_name': < filter_name >,
'ambiente_rede': < ambiente_rede >},
... demais ambientes ... ]}

Raises:	DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao gerar o XML de resposta.

listar_healtchcheck_expect_distinct()[source]¶

Get all expect_string.

Returns:	Dictionary with the following structure:

{'healthcheck_expect': [
 'expect_string': < expect_string >,
 ... demais healthcheck_expects ...]}

Raises:	InvalidParameterError – Identifier is null and invalid. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

listar_healthcheck_expect(id_ambiente)[source]¶

Lista os healthcheck_expect´s de um ambiente.

Parameters:	id_ambiente – Identificador do ambiente.
Returns:	Dicionário com a seguinte estrutura:

{'healthcheck_expect': [{'id': < id_healthcheck_expect >,
 'expect_string': < expect_string >,
 'match_list': < match_list >,
 'id_ambiente': < id_ambiente >},
 ... demais healthcheck_expects ...]}

Raises:	InvalidParameterError – O identificador do ambiente é nulo ou inválido. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao gerar o XML de resposta.

listar_por_equip(equip_id)[source]¶

Lista todos os ambientes por equipamento especifico.

Returns:	Dicionário com a seguinte estrutura:

{'ambiente': {'id': < id_ambiente >,
'link': < link >,
'id_divisao': < id_divisao >,
'nome_divisao': < nome_divisao >,
'id_ambiente_logico': < id_ambiente_logico >,
'nome_ambiente_logico': < nome_ambiente_logico >,
'id_grupo_l3': < id_grupo_l3 >,
'nome_grupo_l3': < nome_grupo_l3 >,
'id_filter': < id_filter >,
'filter_name': < filter_name >,
'ambiente_rede': < ambiente_rede >}}

Raises:	DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao gerar o XML de resposta.

remover(id_ambiente)[source]¶

Remove um ambiente a partir de seu identificador.

Parameters:	id_ambiente – Identificador do ambiente.
Returns:	None
Raises:	AmbienteNaoExisteError – Ambiente não cadastrado. AmbienteError – Ambiente está associado a um equipamento e/ou a uma VLAN. InvalidParameterError – O identificador do ambiente é nulo ou inválido. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao gerar o XML de resposta.

save_blocks(id_env, blocks)[source]¶

Save blocks from environment

Parameters:	id_env – Environment id blocks – Lists of blocks in order. Ex: [‘content one’, ‘content two’, ...]
Returns:	None
Raises:	AmbienteNaoExisteError – Ambiente não cadastrado. InvalidValueError – Invalid parameter. UserNotAuthorizedError – Permissão negada. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao ler o XML de requisição ou gerar o XML de resposta.

save_rule(name, id_env, contents, blocks_id)[source]¶

Save an environment rule

Parameters:	name – Name of the rule id_env – Environment id contents – Lists of contents in order. Ex: [‘content one’, ‘content two’, ...] blocks_id – Lists of blocks id or 0 if is as custom content. Ex: [‘0’, ‘5’, ‘0’ ...]
Returns:	None
Raises:	AmbienteNaoExisteError – Ambiente não cadastrado. InvalidValueError – Invalid parameter. UserNotAuthorizedError – Permissão negada. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao ler o XML de requisição ou gerar o XML de resposta.

set_template(id_environment, name, network)[source]¶

Set template value. If id_environment = 0, set ‘’ to all environments related with the template name.

Parameters:	id_environment – Environment Identifier. name – Template Name. network – IPv4 or IPv6.
Returns:	None
Raises:	InvalidParameterError – Invalid param. AmbienteNaoExisteError – Ambiente não cadastrado. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao ler o XML de requisição ou gerar o XML de resposta.

update_blocks(id_env, blocks)[source]¶

Update blocks from environment

Parameters:	id_env – Environment id blocks – Lists of blocks in order. Ex: [‘content one’, ‘content two’, ...]
Returns:	None
Raises:	AmbienteNaoExisteError – Ambiente não cadastrado. InvalidValueError – Invalid parameter. UserNotAuthorizedError – Permissão negada. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao ler o XML de requisição ou gerar o XML de resposta.

update_rule(name, id_env, contents, blocks_id, id_rule)[source]¶

Save an environment rule

Parameters:	name – Name of the rule id_env – Environment id contents – Lists of contents in order. Ex: [‘content one’, ‘content two’, ...] blocks_id – Lists of blocks id or 0 if is as custom content. Ex: [‘0’, ‘5’, ‘0’ ...] id_rule – Rule id
Returns:	None
Raises:	AmbienteNaoExisteError – Ambiente não cadastrado. InvalidValueError – Invalid parameter. UserNotAuthorizedError – Permissão negada. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao ler o XML de requisição ou gerar o XML de resposta.

networkapiclient.AmbienteLogico module¶

class networkapiclient.AmbienteLogico.AmbienteLogico(networkapi_url, user, password, user_ldap=None)[source]¶

Bases: networkapiclient.GenericClient.GenericClient

alterar(id_logicalenvironment, name)[source]¶

Change Logical Environment from by the identifier.

Parameters:	id_logicalenvironment – Identifier of the Logical Environment. Integer value and greater than zero. name – Logical Environment name. String with a minimum 2 and maximum of 80 characters
Returns:	None
Raises:	InvalidParameterError – The identifier of Logical Environment or name is null and invalid. NomeAmbienteLogicoDuplicadoError – There is already a registered Logical Environment with the value of name. AmbienteLogicoNaoExisteError – Logical Environment not registered. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

inserir(name)[source]¶

Inserts a new Logical Environment and returns its identifier.

Parameters:	name – Logical Environment name. String with a minimum 2 and maximum of 80 characters
Returns:	Dictionary with the following structure:

{'logical_environment': {'id': < id_logical_environment >}}

Raises:	InvalidParameterError – Name is null and invalid. NomeAmbienteLogicoDuplicadoError – There is already a registered Logical Environment with the value of name. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

listar()[source]¶

List all Logical Environment.

Returns:	Dictionary with the following structure:

{'logical_environment':
[{'id': < id >,
'nome': < nome >}, ...more Logical Environment...]}

Raises:	DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

remover(id_logicalenvironment)[source]¶

Remove Logical Environment from by the identifier.

Parameters:	id_logicalenvironment – Identifier of the Logical Environment. Integer value and greater than zero.
Returns:	None
Raises:	InvalidParameterError – The identifier of Logical Environment is null and invalid. AmbienteLogicoNaoExisteError – Logical Environment not registered. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

networkapiclient.ApiGenericClient module¶

class networkapiclient.ApiGenericClient.ApiGenericClient(networkapi_url, user, password, user_ldap=None, log_level='INFO')[source]¶

Bases: object

Class inherited by all NetworkAPI-Client classes who implements access methods to new pattern rest networkAPI.

delete(uri, data=None)[source]¶

Sends a DELETE request.

@param uri: Uri of Service API.

@raise NetworkAPIClientError: Client failed to access the API.

get(uri)[source]¶

Sends a GET request.

@param uri: Uri of Service API. @param data: Requesting Data. Default: None

@raise NetworkAPIClientError: Client failed to access the API.

post(uri, data=None, files=None)[source]¶

Sends a POST request.

@param uri: Uri of Service API. @param data: Requesting Data. Default: None

@raise NetworkAPIClientError: Client failed to access the API.

prepare_url(uri, kwargs)[source]¶

Convert dict for URL params

put(uri, data=None)[source]¶

Sends a PUT request.

@param uri: Uri of Service API. @param data: Requesting Data. Default: None

@raise NetworkAPIClientError: Client failed to access the API.

networkapiclient.ApiVipRequest module¶

class networkapiclient.ApiVipRequest.ApiVipRequest(networkapi_url, user, password, user_ldap=None, log_level='INFO')[source]¶

Bases: networkapiclient.ApiGenericClient.ApiGenericClient

create(vips)[source]¶

Method to create vip’s

Parameters:	vips – List containing vip’s desired to be created on database
Returns:	None

create_vip(vip_request_ids)[source]¶

Method to create vip request

param vip_request_ids: vip_request ids

delete(ids)[source]¶

Method to delete vip’s by their id’s

Parameters:	ids – Identifiers of vip’s
Returns:	None

delete_vip_request(vip_request_ids)[source]¶

Method to delete vip request

param vip_request_ids: vip_request ids

deploy(ids)[source]¶

Method to deploy vip’s

Parameters:	vips – List containing vip’s desired to be deployed on equipment
Returns:	None

get(ids, **kwargs)[source]¶

Method to get vips by their id’s

Parameters:	ids – List containing identifiers of vip’s include – Array containing fields to include on response. exclude – Array containing fields to exclude on response. fields – Array containing fields to override default fields. kind – Determine if result will be detailed (‘detail’) or basic (‘basic’).
Returns:	Dict containing vip’s

get_vip_request(vip_request_id)[source]¶

Method to get vip request

param vip_request_id: vip_request id

get_vip_request_details(vip_request_id)[source]¶

Method to get details of vip request

param vip_request_id: vip_request id

list_environment_by_environmet_vip(environment_vip_id)[source]¶

option_vip_by_environmentvip(environment_vip_id)[source]¶

List Option Vip by Environment Vip

param environment_vip_id: Id of Environment Vip

redeploy(vips)[source]¶

Method to redeploy vip’s

Parameters:	vips – List containing vip’s desired to updated on equipment
Returns:	None

remove_vip(vip_request_ids)[source]¶

Method to delete vip request

param vip_request_ids: vip_request ids

save_vip_request(vip_request)[source]¶

Method to save vip request

param vip_request: vip_request object

search(**kwargs)[source]¶

Method to search vip’s based on extends search.

Parameters:	search – Dict containing QuerySets to find vip’s. include – Array containing fields to include on response. exclude – Array containing fields to exclude on response. fields – Array containing fields to override default fields. kind – Determine if result will be detailed (‘detail’) or basic (‘basic’).
Returns:	Dict containing vip’s

search_vip_request(search)[source]¶

Method to list vip request

param search: search

search_vip_request_details(search)[source]¶

Method to list vip request

param search: search

undeploy(ids, clean_up=0)[source]¶

Method to undeploy vip’s

Parameters:	vips – List containing vip’s desired to be undeployed on equipment
Returns:	None

update(vips)[source]¶

Method to update vip’s

Parameters:	vips – List containing vip’s desired to updated
Returns:	None

update_vip(vip_request, vip_request_id)[source]¶

Method to update vip request

param vip_request: vip_request object param vip_request_id: vip_request id

update_vip_request(vip_request, vip_request_id)[source]¶

Method to update vip request

param vip_request: vip_request object param vip_request_id: vip_request id

networkapiclient.BlockRule module¶

class networkapiclient.BlockRule.BlockRule(networkapi_url, user, password, user_ldap=None)[source]¶

Bases: networkapiclient.GenericClient.GenericClient

get_rule_by_id(rule_id)[source]¶

Get rule by indentifier.

Parameters:	rule_id – Rule identifier
Returns:	Dictionary with the following structure:

{'rule': {'environment': < environment_id >,
'content': < content >,
'custom': < custom >,
'id': < id >,
'name': < name >}}

Raises:	UserNotAuthorizedError – User dont have permition. InvalidParameterError – RULE identifier is null or invalid. DataBaseError – Can’t connect to networkapi database.

networkapiclient.ClientFactory module¶

class networkapiclient.ClientFactory.ClientFactory(networkapi_url, user, password, user_ldap=None, log_level='INFO')[source]¶

Bases: object

Factory to create entities for NetworkAPI-Client.

create_ambiente()[source]¶

Get an instance of ambiente services facade.

create_ambiente_logico()[source]¶

Get an instance of ambiente_logico services facade.

create_api_environment()[source]¶

Get an instance of Api Environment services facade.

create_api_environment_vip()[source]¶

Get an instance of Api Environment Vip services facade.

create_api_equipment()[source]¶

Get an instance of Api Equipment services facade.

create_api_interface_request()[source]¶

Get an instance of Api Vip Requests services facade.

create_api_ipv4()[source]¶

Get an instance of Api IPv4 services facade.

create_api_ipv6()[source]¶

Get an instance of Api IPv6 services facade.

create_api_network_ipv4()[source]¶

Get an instance of Api Networkv4 services facade.

create_api_network_ipv6()[source]¶

Get an instance of Api Networkv6 services facade.

create_api_object_group_permission()[source]¶

Get an instance of Api Vip Requests services facade.

create_api_object_group_permission_general()[source]¶

Get an instance of Api Vip Requests services facade.

create_api_object_type()[source]¶

Get an instance of Api Vip Requests services facade.

create_api_option_vip()[source]¶

Get an instance of Api Option Vip services facade.

create_api_pool()[source]¶

Get an instance of Api Pool services facade.

create_api_pool_deploy()[source]¶

Get an instance of Api Pool Deploy services facade.

create_api_v4_as()[source]¶

Get an instance of Api As services facade.

create_api_v4_equipment()[source]¶

Get an instance of Api Equipment services facade.

create_api_v4_ipv4()[source]¶

Get an instance of Api V4 IPv4 services facade.

create_api_v4_ipv6()[source]¶

Get an instance of Api V4 IPv6 services facade.

create_api_v4_neighbor()[source]¶

Get an instance of Api Neighbor services facade.

create_api_v4_virtual_interface()[source]¶

Get an instance of Api Virtual Interface services facade.

create_api_vip_request()[source]¶

Get an instance of Api Vip Requests services facade.

create_api_vlan()[source]¶

Get an instance of Api Vlan services facade.

create_api_vrf()[source]¶

Get an instance of Api Vrf services facade.

create_apirack()[source]¶

Get an instance of Api Rack Variables services facade.

create_dhcprelay_ipv4()[source]¶

Get an instance of DHCPRelayIPv4 services facade.

create_dhcprelay_ipv6()[source]¶

Get an instance of DHCPRelayIPv6 services facade.

create_direito_grupo_equipamento()[source]¶

Get an instance of direito_grupo_equipamento services facade.

create_divisao_dc()[source]¶

Get an instance of divisao_dc services facade.

create_environment_vip()[source]¶

Get an instance of environment_vip services facade.

create_equipamento()[source]¶

Get an instance of equipamento services facade.

create_equipamento_acesso()[source]¶

Get an instance of equipamento_acesso services facade.

create_equipamento_ambiente()[source]¶

Get an instance of equipamento_ambiente services facade.

create_equipamento_roteiro()[source]¶

Get an instance of equipamento_roteiro services facade.

create_filter()[source]¶

Get an instance of filter services facade.

create_grupo_equipamento()[source]¶

Get an instance of grupo_equipamento services facade.

create_grupo_l3()[source]¶

Get an instance of grupo_l3 services facade.

create_grupo_usuario()[source]¶

Get an instance of grupo_usuario services facade.

create_grupo_virtual()[source]¶

Get an instance of grupo_virtual services facade.

create_healthcheck()[source]¶

Get an instance of Poll services facade.

create_interface()[source]¶

Get an instance of interface services facade.

create_ip()[source]¶

Get an instance of ip services facade.

create_log()[source]¶

Get an instance of log services facade.

create_marca()[source]¶

Get an instance of marca services facade.

create_modelo()[source]¶

Get an instance of modelo services facade.

create_network()[source]¶

Get an instance of vlan services facade.

create_option_pool()[source]¶

Get an instance of option_pool services facade.

create_option_vip()[source]¶

Get an instance of option_vip services facade.

create_permissao_administrativa()[source]¶

Get an instance of permissao_administrativa services facade.

create_permission()[source]¶

Get an instance of permission services facade.

create_pool()[source]¶

Get an instance of Poll services facade.

create_rack()[source]¶

Get an instance of rack services facade.

create_rackservers()[source]¶

Get an instance of rackservers services facade.

create_roteiro()[source]¶

Get an instance of roteiro services facade.

create_rule()[source]¶

Get an instance of block rule services facade.

create_system()[source]¶

Get an instance of Api System Variables services facade.

create_tipo_acesso()[source]¶

Get an instance of tipo_acesso services facade.

create_tipo_equipamento()[source]¶

Get an instance of tipo_equipamento services facade.

create_tipo_rede()[source]¶

Get an instance of tipo_rede services facade.

create_tipo_roteiro()[source]¶

Get an instance of tipo_roteiro services facade.

create_usuario()[source]¶

Get an instance of usuario services facade.

create_usuario_grupo()[source]¶

Get an instance of usuario_grupo services facade.

create_vip()[source]¶

Get an instance of vip services facade.

create_vlan()[source]¶

Get an instance of vlan services facade.

networkapiclient.Config module¶

class networkapiclient.Config.IP_VERSION[source]¶

IPv4 = ('v4', 'IPv4')¶

IPv6 = ('v6', 'IPv6')¶

List = (('v4', 'IPv4'), ('v6', 'IPv6'))¶

networkapiclient.DireitoGrupoEquipamento module¶

class networkapiclient.DireitoGrupoEquipamento.DireitoGrupoEquipamento(networkapi_url, user, password, user_ldap=None)[source]¶

Bases: networkapiclient.GenericClient.GenericClient

alterar(id_direito, leitura, escrita, alterar_config, exclusao)[source]¶

Altera os direitos de um grupo de usuário em um grupo de equipamento a partir do seu identificador.

Parameters:	id_direito – Identificador do direito grupo equipamento. leitura – Indicação de permissão de leitura (‘0’ ou ‘1’). escrita – Indicação de permissão de escrita (‘0’ ou ‘1’). alterar_config – Indicação de permissão de alterar_config (‘0’ ou ‘1’). exclusao – Indicação de permissão de exclusão (‘0’ ou ‘1’).
Returns:	None
Raises:	InvalidParameterError – Pelo menos um dos parâmetros é nulo ou inválido. ValorIndicacaoDireitoInvalidoError – Valor de leitura, escrita, alterar_config e/ou exclusão inválido. DireitoGrupoEquipamentoNaoExisteError – Direito Grupo Equipamento não cadastrado. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao ler o XML de requisição ou gerar o XML de resposta.

buscar_por_id(id_direito)[source]¶

Obtém os direitos de um grupo de usuário e um grupo de equipamento.

Parameters:	id_direito – Identificador do direito grupo equipamento.
Returns:	Dicionário com a seguinte estrutura:

{'direito_grupo_equipamento':
{'id_grupo_equipamento': < id_grupo_equipamento >,
'exclusao': < exclusao >,
'alterar_config': < alterar_config >,
'nome_grupo_equipamento': < nome_grupo_equipamento >,
'id_grupo_usuario': < id_grupo_usuario >,
'escrita': < escrita >,
'nome_grupo_usuario': < nome_grupo_usuario >,
'id': < id >,
'leitura': < leitura >}}

Raises:	InvalidParameterError – O identificador do direito grupo equipamento é nulo ou inválido. DireitoGrupoEquipamentoNaoExisteError – Direito Grupo Equipamento não cadastrado. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao gerar o XML de resposta.

inserir(id_grupo_usuario, id_grupo_equipamento, leitura, escrita, alterar_config, exclusao)[source]¶

Cria um novo direito de um grupo de usuário em um grupo de equipamento e retorna o seu identificador.

Parameters:	id_grupo_usuario – Identificador do grupo de usuário. id_grupo_equipamento – Identificador do grupo de equipamento. leitura – Indicação de permissão de leitura (‘0’ ou ‘1’). escrita – Indicação de permissão de escrita (‘0’ ou ‘1’). alterar_config – Indicação de permissão de alterar_config (‘0’ ou ‘1’). exclusao – Indicação de permissão de exclusão (‘0’ ou ‘1’).
Returns:	Dicionário com a seguinte estrutura: {‘direito_grupo_equipamento’: {‘id’: < id>}}
Raises:	InvalidParameterError – Pelo menos um dos parâmetros é nulo ou inválido. GrupoEquipamentoNaoExisteError – Grupo de Equipamento não cadastrado. GrupoUsuarioNaoExisteError – Grupo de Usuário não cadastrado. ValorIndicacaoDireitoInvalidoError – Valor de leitura, escrita, alterar_config e/ou exclusão inválido. DireitoGrupoEquipamentoDuplicadoError – Já existe direitos cadastrados para o grupo de usuário e grupo de equipamento informados. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao ler o XML de requisição ou gerar o XML de resposta.

listar()[source]¶

Lista todos os direitos de grupos de usuário em grupos de equipamento.

Returns:	Dicionário com a seguinte estrutura:

{'direito_grupo_equipamento':
[{'id_grupo_equipamento': < id_grupo_equipamento >,
'exclusao': < exclusao >,
'alterar_config': < alterar_config >,
'nome_grupo_equipamento': < nome_grupo_equipamento >,
'id_grupo_usuario': < id_grupo_usuario >,
'escrita': < escrita >,
'nome_grupo_usuario': < nome_grupo_usuario >,
'id': < id >,
'leitura': < leitura >}, … demais direitos …]}

Raises:	DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao gerar o XML de resposta.

listar_por_grupo_equipamento(id_grupo_equipamento)[source]¶

Lista todos os direitos de grupos de usuário em um grupo de equipamento.

Parameters:	id_grupo_equipamento – Identificador do grupo de equipamento para filtrar a pesquisa.
Returns:	Dicionário com a seguinte estrutura:

{'direito_grupo_equipamento':
[{'id_grupo_equipamento': < id_grupo_equipamento >,
'exclusao': < exclusao >,
'alterar_config': < alterar_config >,
'nome_grupo_equipamento': < nome_grupo_equipamento >,
'id_grupo_usuario': < id_grupo_usuario >,
'escrita': < escrita >,
'nome_grupo_usuario': < nome_grupo_usuario >,
'id': < id >,
'leitura': < leitura >}, … demais direitos …]}

Raises:	InvalidParameterError – O identificador do grupo de equipamento é nulo ou inválido. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao gerar o XML de resposta.

listar_por_grupo_usuario(id_grupo_usuario)[source]¶

Lista todos os direitos de um grupo de usuário em grupos de equipamento.

Parameters:	id_grupo_usuario – Identificador do grupo de usuário para filtrar a pesquisa.
Returns:	Dicionário com a seguinte estrutura:

{'direito_grupo_equipamento':
[{'id_grupo_equipamento': < id_grupo_equipamento >,
'exclusao': < exclusao >,
'alterar_config': < alterar_config >,
'nome_grupo_equipamento': < nome_grupo_equipamento >,
'id_grupo_usuario': < id_grupo_usuario >,
'escrita': < escrita >,
'nome_grupo_usuario': < nome_grupo_usuario >,
'id': < id >,
'leitura': < leitura >}, … demais direitos …]}

Raises:	InvalidParameterError – O identificador do grupo de usuário é nulo ou inválido. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao gerar o XML de resposta.

remover(id_direito)[source]¶

Remove os direitos de um grupo de usuário em um grupo de equipamento a partir do seu identificador.

Parameters:	id_direito – Identificador do direito grupo equipamento
Returns:	None
Raises:	DireitoGrupoEquipamentoNaoExisteError – Direito Grupo Equipamento não cadastrado. InvalidParameterError – O identificador do direito grupo equipamento é nulo ou inválido. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao gerar o XML de resposta.

networkapiclient.DivisaoDc module¶

class networkapiclient.DivisaoDc.DivisaoDc(networkapi_url, user, password, user_ldap=None)[source]¶

Bases: networkapiclient.GenericClient.GenericClient

alterar(id_divisiondc, name)[source]¶

Change Division Dc from by the identifier.

Parameters:	id_divisiondc – Identifier of the Division Dc. Integer value and greater than zero. name – Division Dc name. String with a minimum 2 and maximum of 80 characters
Returns:	None
Raises:	InvalidParameterError – The identifier of Division Dc or name is null and invalid. NomeDivisaoDcDuplicadoError – There is already a registered Division Dc with the value of name. DivisaoDcNaoExisteError – Division Dc not registered. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

inserir(name)[source]¶

Inserts a new Division Dc and returns its identifier.

Parameters:	name – Division Dc name. String with a minimum 2 and maximum of 80 characters
Returns:	Dictionary with the following structure:

{'division_dc': {'id': < id_division_dc >}}

Raises:	InvalidParameterError – Name is null and invalid. NomeDivisaoDcDuplicadoError – There is already a registered Division Dc with the value of name. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

listar()[source]¶

List all Division Dc.

Returns:	Dictionary with the following structure:

{'division_dc':
[{'id': < id >,
'name': < name >}, ...more Division Dc...]}

Raises:	DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

remover(id_divisiondc)[source]¶

Remove Division Dc from by the identifier.

Parameters:	id_divisiondc – Identifier of the Division Dc. Integer value and greater than zero.
Returns:	None
Raises:	InvalidParameterError – The identifier of Division Dc is null and invalid. DivisaoDcNaoExisteError – Division Dc not registered. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

networkapiclient.EnvironmentVIP module¶

class networkapiclient.EnvironmentVIP.EnvironmentVIP(networkapi_url, user, password, user_ldap=None)[source]¶

Bases: networkapiclient.GenericClient.GenericClient

add(finalidade_txt, cliente_txt, ambiente_p44_txt, description)[source]¶

Inserts a new Environment VIP and returns its identifier.

Parameters:	finalidade_txt – Finality. String with a maximum of 50 characters and respect [a-zA-Z_-] cliente_txt – ID Client. String with a maximum of 50 characters and respect [a-zA-Z_-] ambiente_p44_txt – Environment P44. String with a maximum of 50 characters and respect [a-zA-Z_-]
Returns:	Following dictionary:

{'environment_vip': {'id': < id >}}

Raises:	InvalidParameterError – The value of finalidade_txt, cliente_txt or ambiente_p44_txt is invalid. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

alter(id_environment_vip, finalidade_txt, cliente_txt, ambiente_p44_txt, description)[source]¶

Change Environment VIP from by the identifier.

Parameters:	id_environment_vip – Identifier of the Environment VIP. Integer value and greater than zero. finalidade_txt – Finality. String with a maximum of 50 characters and respect [a-zA-Z_-] cliente_txt – ID Client. String with a maximum of 50 characters and respect [a-zA-Z_-] ambiente_p44_txt – Environment P44. String with a maximum of 50 characters and respect [a-zA-Z_-]
Returns:	None
Raises:	InvalidParameterError – Environment VIP identifier is null and invalid. InvalidParameterError – The value of finalidade_txt, cliente_txt or ambiente_p44_txt is invalid. EnvironmentVipNotFoundError – Environment VIP not registered. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

buscar_ambientep44_por_finalidade_cliente(finalidade_txt, cliente_txt)[source]¶

Search ambiente_p44_txt environment vip

Returns:	Dictionary with the following structure:

{‘ambiente_p44_txt’:
'id':<'id_ambientevip'>,
‘finalidade’: <'finalidade_txt'>,
'cliente_txt: <'cliente_txt'>',
'ambiente_p44: <'ambiente_p44'>',}

Raises:	InvalidParameterError – finalidade_txt and cliente_txt is null and invalid. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

buscar_cliente_por_finalidade(finalidade_txt)[source]¶

Search cliente_txt environment vip

Returns:	Dictionary with the following structure:

{‘cliente_txt’:
‘finalidade’: <'finalidade_txt'>,
'cliente_txt: <'cliente_txt'>'}

Raises:	InvalidParameterError – finalidade_txt is null and invalid. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

buscar_finalidade()[source]¶

Search finalidade_txt environment vip

Returns:	Dictionary with the following structure:

::

{‘finalidade’: ‘finalidade’: <’finalidade_txt’>}

Raises:	DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

get_vips(id_environment_vip)[source]¶

Get to list all the VIPs related to Environment VIP from by the identifier.

Parameters:	id_environment_vip – Identifier of the Environment VIP. Integer value and greater than zero.
Returns:	Dictionary with the following structure:

{‘vip_< id >’:
{‘id’: < id >,
‘validado’: < validado >,
‘finalidade’: < finalidade >,
‘cliente’: < cliente >,
‘ambiente’: < ambiente >,
‘cache’: < cache >,
‘metodo_bal’: < método_bal >,
‘persistencia’: < persistencia >,
‘healthcheck_type’: <  healthcheck_type >,
‘healthcheck’: < healthcheck >,
‘timeout’: < timeout >,
‘host’: < host >,
‘maxcon’: < maxcon >,
‘dsr’: < dsr >,
‘bal_ativo’: < bal_ativo >,
‘transbordos’:{‘transbordo’:[< transbordo >]},
‘reals’:{‘real’:[{‘real_name’:< real_name >, ‘real_ip’:< real_ip >}]},
‘portas_servicos’:{‘porta’:[< porta >]},
‘vip_criado’: < vip_criado >,
‘id_ip’: < id_ip >,
‘id_ipv6’: < id_ipv6 >,
‘id_healthcheck_expect’: < id_healthcheck_expect >}}

Raises:	InvalidParameterError – Environment VIP identifier is null and invalid. EnvironmentVipNotFoundError – Environment VIP not registered. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

list_all()[source]¶

List all environment vips

Returns:	Following dictionary:

{'environment_vip': [{'id': <id>,
'finalidade_txt': <finalidade_txt>,
'cliente_txt': <cliente_txt>,
'ambiente_p44_txt': <ambiente_p44_txt> } {... other environments vip ...}]}

Raises:	DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

list_all_available(id_vlan)[source]¶

List all environment vips availables

Returns:	Following dictionary:

{'environment_vip': [{'id': <id>,
'finalidade_txt': <finalidade_txt>,
'cliente_txt': <cliente_txt>,
'ambiente_p44_txt': <ambiente_p44_txt> }
{... other environments vip ...}]}

Raises:	DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

remove(id_environment_vip)[source]¶

Remove Environment VIP from by the identifier.

Parameters:	id_environment_vip – Identifier of the Environment VIP. Integer value and greater than zero.
Returns:	None
Raises:	InvalidParameterError – Environment VIP identifier is null and invalid. EnvironmentVipNotFoundError – Environment VIP not registered. EnvironmentVipError – There networkIPv4 or networkIPv6 associated with environment vip. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

search(id_environment_vip=None, finalidade_txt=None, cliente_txt=None, ambiente_p44_txt=None)[source]¶

Search Environment VIP from by parameters.

Case the id parameter has been passed, the same it has priority over the other parameters.

Parameters:	id_environment_vip – Identifier of the Environment VIP. Integer value and greater than zero. finalidade_txt – Finality. String with a maximum of 50 characters and respect [a-zA-Z_-] cliente_txt – ID Client. String with a maximum of 50 characters and respect [a-zA-Z_-] ambiente_p44_txt – Environment P44. String with a maximum of 50 characters and respect [a-zA-Z_-]
Returns:	Following dictionary:

{‘environment_vip’:
{‘id’: < id >,
‘finalidade_txt’: < finalidade_txt >,
‘finalidade’: < finalidade >,
‘cliente_txt’: < cliente_txt >,
‘ambiente_p44_txt’: < ambiente_p44_txt >}}

Raises:	InvalidParameterError – The value of id_environment_vip, finalidade_txt, cliente_txt or ambiente_p44_txt is invalid. EnvironmentVipNotFoundError – Environment VIP not registered. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

networkapiclient.Equipamento module¶

class networkapiclient.Equipamento.Equipamento(networkapi_url, user, password, user_ldap=None)[source]¶

Bases: networkapiclient.GenericClient.GenericClient

add_ipv4(id_network_ipv4, id_equipamento, descricao)[source]¶

Allocate an IP on a network to an equipment. Insert new IP for network and associate to the equipment

Parameters:	id_network_ipv4 – ID for NetworkIPv4. id_equipamento – ID for Equipment. descricao – Description for IP.
Returns:	Following dictionary:

{'ip': {'id': < id_ip >,
'id_network_ipv4': < id_network_ipv4 >,
'oct1’: < oct1 >,
'oct2': < oct2 >,
'oct3': < oct3 >,
'oct4': < oct4 >,
'descricao': < descricao >}}

Raises:

InvalidParameterError – Invalid ID for NetworkIPv4 or Equipment. InvalidParameterError – The value of description is invalid. EquipamentoNaoExisteError – Equipment not found. RedeIPv4NaoExisteError – NetworkIPv4 not found. IPNaoDisponivelError – There is no network address is available to create the VLAN. ConfigEnvironmentInvalidError – Invalid Environment Configuration or not registered DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

add_ipv6(id_network_ipv6, id_equip, description)[source]¶

Allocate an IP on a network to an equipment. Insert new IP for network and associate to the equipment

Parameters:	id_network_ipv6 – ID for NetworkIPv6. id_equip – ID for Equipment. description – Description for IP.
Returns:	Following dictionary:

{'ip': {'id': < id_ip >,
'id_network_ipv6': < id_network_ipv6 >,
'bloco1': < bloco1 >,
'bloco2': < bloco2 >,
'bloco3': < bloco3 >,
'bloco4': < bloco4 >,
'bloco5': < bloco5 >,
'bloco6': < bloco6 >,
'bloco7': < bloco7 >,
'bloco8': < bloco8 >,
'descricao': < descricao >}}

Raises:

InvalidParameterError – NetworkIPv6 identifier or Equipament identifier is null and invalid, InvalidParameterError – The value of description is invalid. EquipamentoNaoExisteError – Equipment not found. RedeIPv6NaoExisteError – NetworkIPv6 not found. IPNaoDisponivelError – There is no network address is available to create the VLAN. ConfigEnvironmentInvalidError – Invalid Environment Configuration or not registered DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

associar_grupo(id_equipamento, id_grupo_equipamento)[source]¶

Associa um equipamento a um grupo.

Parameters:	id_equipamento – Identificador do equipamento. id_grupo_equipamento – Identificador do grupo de equipamento.
Returns:	Dicionário com a seguinte estrutura: {‘equipamento_grupo’:{‘id’: < id_equip_do_grupo >}}
Raises:	GrupoEquipamentoNaoExisteError – Grupo de equipamento não cadastrado. InvalidParameterError – O identificador do equipamento e/ou do grupo são nulos ou inválidos. EquipamentoNaoExisteError – Equipamento não cadastrado. EquipamentoError – Equipamento já está associado ao grupo. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao ler o XML de requisição ou gerar o XML de resposta.

associar_ip(id_equipamento, id_ip)[source]¶

Associa um IP a um equipamento.

Parameters:	id_equipamento – Identificador do equipamento. id_ip – Identificador do IP.
Returns:	Dicionário com a seguinte estrutura: {‘ip_equipamento’: {‘id’: < id_ip_do_equipamento >}}
Raises:	EquipamentoNaoExisteError – Equipamento não cadastrado. IpNaoExisteError – IP não cadastrado. IpError – IP já está associado ao equipamento. InvalidParameterError – O identificador do equipamento e/ou do IP são nulos ou inválidos. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao gerar o XML de resposta.

associate_ipv6(id_equip, id_ipv6)[source]¶

Associates an IPv6 to a equipament.

Parameters:	id_equip – Identifier of the equipment. Integer value and greater than zero. id_ipv6 – Identifier of the ip. Integer value and greater than zero.
Returns:	Dictionary with the following structure: {‘ip_equipamento’: {‘id’: < id_ip_do_equipamento >}}
Raises:	EquipamentoNaoExisteError – Equipment is not registered. IpNaoExisteError – IP not registered. IpError – IP is already associated with the equipment. InvalidParameterError – Identifier of the equipment and/or IP is null or invalid. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

criar_ip(id_vlan, id_equipamento, descricao)[source]¶

Aloca um IP em uma VLAN para um equipamento.

Insere um novo IP para a VLAN e o associa ao equipamento.

Parameters:	id_vlan – Identificador da vlan. id_equipamento – Identificador do equipamento. descricao – Descriçao do IP.
Returns:	Dicionário com a seguinte estrutura:

{'ip': {'id': < id_ip >,
'id_network_ipv4': < id_network_ipv4 >,
'oct1’: < oct1 >,
'oct2': < oct2 >,
'oct3': < oct3 >,
'oct4': < oct4 >,
'descricao': < descricao >}}

Raises:

InvalidParameterError – O identificador da VLAN e/ou do equipamento são nulos ou inválidos. EquipamentoNaoExisteError – Equipamento não cadastrado. VlanNaoExisteError – VLAN não cadastrada. IPNaoDisponivelError – Não existe IP disponível para a VLAN informada. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao ler o XML de requisição ou gerar o XML de resposta.

edit(id_equip, nome, id_tipo_equipamento, id_modelo, maintenance=None)[source]¶

Change Equipment from by the identifier.

Parameters:	id_equip – Identifier of the Equipment. Integer value and greater than zero. nome – Equipment name. String with a minimum 3 and maximum of 30 characters id_tipo_equipamento – Identifier of the Equipment Type. Integer value and greater than zero. id_modelo – Identifier of the Model. Integer value and greater than zero.
Returns:	None
Raises:	InvalidParameterError – The identifier of Equipment, model, equipment type or name is null and invalid. EquipamentoNaoExisteError – Equipment not registered. TipoEquipamentoNaoExisteError – Equipment Type not registered. ModeloEquipamentoNaoExisteError – Model not registered. GrupoEquipamentoNaoExisteError – Group not registered. EquipamentoError – Equipamento com o nome duplicado ou Equipamento do grupo “Equipamentos Orquestração” somente poderá ser criado com tipo igual a “Servidor Virtual”. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response

find_equips(name, iexact, environment, equip_type, group, ip, pagination)[source]¶

Find vlans by all search parameters

Parameters:	name – Filter by vlan name column iexact – Filter by name will be exact? environment – Filter by environment ID related equip_type – Filter by equipment_type ID related group – Filter by equipment group ID related ip – Filter by each octs in ips related pagination – Class with all data needed to paginate
Returns:	Following dictionary:

{'equipamento': {'id': < id_vlan >,
'nome': < nome_vlan >,
'num_vlan': < num_vlan >,
'id_ambiente': < id_ambiente >,
'descricao': < descricao >,
'acl_file_name': < acl_file_name >,
'acl_valida': < acl_valida >,
'ativada': < ativada >,
'ambiente_name': < divisao_dc-ambiente_logico-grupo_l3 >
'redeipv4': [ { all networkipv4 related  } ],
'redeipv6': [ { all networkipv6 related } ] },
'total': {< total_registros >} }

Raises:	InvalidParameterError – Some parameter was invalid. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

get_all()[source]¶

Return all equipments in database

Returns:	Dictionary with the following structure:

::

{‘equipaments’: {‘name’ :< name_equipament >}, {... demais equipamentos ...} }

Raises:	DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

get_ips_by_equipment_and_environment(equip_nome, id_ambiente)[source]¶

Search Group Equipment from by the identifier.

Parameters:	id_egroup – Identifier of the Group Equipment. Integer value and greater than zero.
Returns:	Dictionary with the following structure:

{'equipaments':
[{'nome': < name_equipament >, 'grupos': < id_group >,
'mark': {'id': < id_mark >, 'nome': < name_mark >},'modelo': < id_model >,
'tipo_equipamento': < id_type >,
'model': {'nome': , 'id': < id_model >, 'marca': < id_mark >},
'type': {id': < id_type >, 'tipo_equipamento': < name_type >},
'id': < id_equipment >}, ... ]}

Raises:	InvalidParameterError – Group Equipment is null and invalid. GrupoEquipamentoNaoExisteError – Group Equipment not registered. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

get_real_related(id_equip)[source]¶

Find reals related with equipment

Parameters:	id_equip – Identifier of equipment
Returns:	Following dictionary:

{'vips': [{'port_real': < port_real >,
'server_pool_member_id': < server_pool_member_id >,
'ip': < ip >,
'port_vip': < port_vip >,
'host_name': < host_name >,
'id_vip': < id_vip >, ...],
'equip_name': < equip_name > }}

Raises:	EquipamentoNaoExisteError – Equipment not registered. InvalidParameterError – Some parameter was invalid. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

inserir(name, id_equipment_type, id_model, id_group, maintenance=False)[source]¶

Inserts a new Equipment and returns its identifier

Além de inserir o equipamento, a networkAPI também associa o equipamento ao grupo informado.

Parameters:	name – Equipment name. String with a minimum 3 and maximum of 30 characters id_equipment_type – Identifier of the Equipment Type. Integer value and greater than zero. id_model – Identifier of the Model. Integer value and greater than zero. id_group – Identifier of the Group. Integer value and greater than zero.
Returns:	Dictionary with the following structure:

{'equipamento': {'id': < id_equipamento >},
'equipamento_grupo': {'id': < id_grupo_equipamento >}}

Raises:

InvalidParameterError – The identifier of Equipment type, model, group or name is null and invalid. TipoEquipamentoNaoExisteError – Equipment Type not registered. ModeloEquipamentoNaoExisteError – Model not registered. GrupoEquipamentoNaoExisteError – Group not registered. EquipamentoError – Equipamento com o nome duplicado ou Equipamento do grupo “Equipamentos Orquestração” somente poderá ser criado com tipo igual a “Servidor Virtual”. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response

list_all()[source]¶

Return all equipments in database

Returns:	Dictionary with the following structure:

{'equipaments': {'name' :< name_equipament >}, {... demais equipamentos ...} }

Raises:	DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

list_by_group(id_egroup)[source]¶

Search Group Equipment from by the identifier.

Parameters:	id_egroup – Identifier of the Group Equipment. Integer value and greater than zero.
Returns:	Dictionary with the following structure:

{'equipaments':
[{'nome': < name_equipament >, 'grupos': < id_group >,
'mark': {'id': < id_mark >, 'nome': < name_mark >},'modelo': < id_model >,
'tipo_equipamento': < id_type >,
'model': {'nome': , 'id': < id_model >, 'marca': < id_mark >},
'type': {id': < id_type >, 'tipo_equipamento': < name_type >},
'id': < id_equipment >}, ... ]}

Raises:	InvalidParameterError – Group Equipment is null and invalid. GrupoEquipamentoNaoExisteError – Group Equipment not registered. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

listar_por_id(id)[source]¶

Obtém um equipamento a partir do seu identificador.

Parameters:	id – ID do equipamento.
Returns:	Dicionário com a seguinte estrutura:

{'equipamento': {'id': < id_equipamento >,
'nome': < nome_equipamento >,
'id_tipo_equipamento': < id_tipo_equipamento >,
'nome_tipo_equipamento': < nome_tipo_equipamento >,
'id_modelo': < id_modelo >,
'nome_modelo': < nome_modelo >,
'id_marca': < id_marca >,
'nome_marca': < nome_marca >}}

Raises:	EquipamentoNaoExisteError – Equipamento com o id informado não cadastrado. InvalidParameterError – O nome do equipamento é nulo ou vazio. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao gerar o XML de resposta.

listar_por_nome(nome)[source]¶

Obtém um equipamento a partir do seu nome.

Parameters:	nome – Nome do equipamento.
Returns:	Dicionário com a seguinte estrutura:

{'equipamento': {'id': < id_equipamento >,
'nome': < nome_equipamento >,
'id_tipo_equipamento': < id_tipo_equipamento >,
'nome_tipo_equipamento': < nome_tipo_equipamento >,
'id_modelo': < id_modelo >,
'nome_modelo': < nome_modelo >,
'id_marca': < id_marca >,
'nome_marca': < nome_marca >}}

Raises:	EquipamentoNaoExisteError – Equipamento com o nome informado não cadastrado. InvalidParameterError – O nome do equipamento é nulo ou vazio. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao gerar o XML de resposta.

listar_por_tipo_ambiente(id_tipo_equipamento, id_ambiente)[source]¶

Lista os equipamentos de um tipo e que estão associados a um ambiente.

Parameters:	id_tipo_equipamento – Identificador do tipo do equipamento. id_ambiente – Identificador do ambiente.
Returns:	Dicionário com a seguinte estrutura:

{'equipamento': [{'id': < id_equipamento >,
'nome': < nome_equipamento >,
'id_tipo_equipamento': < id_tipo_equipamento >,
'nome_tipo_equipamento': < nome_tipo_equipamento >,
'id_modelo': < id_modelo >,
'nome_modelo': < nome_modelo >,
'id_marca': < id_marca >,
'nome_marca': < nome_marca >
}, ... demais equipamentos ...]}

Raises:	InvalidParameterError – O identificador do tipo de equipamento e/ou do ambiente são nulos ou inválidos. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao gerar o XML de resposta.

remove_ipv6(id_equip, id_ipv6)[source]¶

Remove an IPv6 to a equipament.

Parameters:	id_equip – Identifier of the equipment. Integer value and greater than zero. id_ipv6 – Identifier of the ip. Integer value and greater than zero.
Returns:	None
Raises:	EquipamentoNaoExisteError – Equipment is not registered. IpNaoExisteError – IP not registered. IpError – Dont IP is already associated with the equipment. InvalidParameterError – Identifier of the equipment and/or IP is null or invalid. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

remover(id_equipamento)[source]¶

Remove um equipamento a partir do seu identificador.

Além de remover o equipamento, a API também remove:

• O relacionamento do equipamento com os tipos de acessos.
• O relacionamento do equipamento com os roteiros.
• O relacionamento do equipamento com os IPs.
• As interfaces do equipamento.
• O relacionamento do equipamento com os ambientes.
• O relacionamento do equipamento com os grupos.

Parameters:	id_equipamento – Identificador do equipamento.
Returns:	None
Raises:	EquipamentoNaoExisteError – Equipamento não cadastrado. InvalidParameterError – O identificador do equipamento é nulo ou inválido. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao gerar o XML de resposta.

remover_grupo(id_equipamento, id_grupo)[source]¶

Remove a associação de um equipamento com um grupo de equipamento.

Parameters:	id_equipamento – Identificador do equipamento. id_grupo – Identificador do grupo de equipamento.
Returns:	None
Raises:	EquipamentoGrupoNaoExisteError – Associação entre grupo e equipamento não cadastrada. EquipamentoNaoExisteError – Equipamento não cadastrado. EquipmentDontRemoveError – Failure to remove an association between an equipment and a group because the group is related only to a group. InvalidParameterError – O identificador do equipamento e/ou do grupo são nulos ou inválidos. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao gerar o XML de resposta.

remover_ip(id_equipamento, id_ip)[source]¶

Removes association of IP and Equipment. If IP has no other association with equipments, IP is also removed.

Parameters:	id_equipamento – Equipment identifier id_ip – IP identifier.
Returns:	None
Raises:	VipIpError – Ip can’t be removed because there is a created Vip Request. IpEquipCantDissociateFromVip – Equipment is the last balancer for created Vip Request. IpError – IP not associated with equipment. InvalidParameterError – Equipment or IP identifier is none or invalid. EquipamentoNaoExisteError – Equipment doesn’t exist. DataBaseError – Networkapi failed to access database. XMLError – Networkapi failed to build response XML.

networkapiclient.EquipamentoAcesso module¶

class networkapiclient.EquipamentoAcesso.EquipamentoAcesso(networkapi_url, user, password, user_ldap=None)[source]¶

Bases: networkapiclient.GenericClient.GenericClient

edit_by_id(id_equip_acesso, id_tipo_acesso, fqdn, user, password, enable_pass)[source]¶

Edit access type, fqdn, user, password and enable_pass of the relationship of equipment and access type.

Parameters:	id_tipo_acesso – Access type identifier. id_equip_acesso – Equipment identifier. fqdn – Equipment FQDN. user – User. password – Password. enable_pass – Enable access.
Returns:	None
Raises:	InvalidParameterError – The parameters fqdn, user, password or access type id are invalid or none. EquipamentoAcessoNaoExisteError – Equipment access type relationship doesn’t exist. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

get_access(id_access)[source]¶

Get Equipment Access by id.

Returns:	Dictionary with following:

{'equipamento_acesso':
{'id_equipamento': < id_equipamento >,
'fqdn': < fqdn >,
'user': < user >,
'pass': < pass >,
'id_tipo_acesso': < id_tipo_acesso >,
'enable_pass': < enable_pass >}}

inserir(id_equipamento, fqdn, user, password, id_tipo_acesso, enable_pass)[source]¶

Add new relationship between equipment and access type and returns its id.

Parameters:	id_equipamento – Equipment identifier. fqdn – Equipment FQDN. user – User. password – Password. id_tipo_acesso – Access Type identifier. enable_pass – Enable access.
Returns:	Dictionary with the following: {‘equipamento_acesso’: {‘id’: < id >}}
Raises:	EquipamentoNaoExisteError – Equipment doesn’t exist. TipoAcessoNaoExisteError – Access Type doesn’t exist. EquipamentoAcessoError – Equipment and access type already associated. InvalidParameterError – The parameters equipment id, fqdn, user, password or access type id are invalid or none. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

list_by_equip(name)[source]¶

List all equipment access by equipment name

Returns:	Dictionary with the following structure:

{‘equipamento_acesso’:[ {'id': <id_equiptos_access>,
'equipamento': <id_equip>,
'fqdn': <fqdn>,
'user': <user>,
'password': <pass>
'tipo_acesso': <id_tipo_acesso>,
'enable_pass': <enable_pass> }]}

Raises:	InvalidValueError – Invalid parameter. EquipamentoNotFoundError – Equipment name not found in database. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

listar()[source]¶

List Equipment Access relationships.

Return only the relationships from equipments the user have write permissions in one of the equipment groups

Returns:	Dictionary with the following:

{'equipamento_acesso':
[{'id_equipamento': < id_equipamento >,
'fqdn': < fqdn >,
'user': < user >,
'pass': < pass >,
'id_tipo_acesso': < id_tipo_acesso >,
'enable_pass': < enable_pass >,
'protocolo_tipo_acesso': < protocol_tipo_acesso >},
... other equipment_access ....]}

Raises:	DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

remover(id_tipo_acesso, id_equipamento)[source]¶

Removes relationship between equipment and access type.

Parameters:	id_equipamento – Equipment identifier. id_tipo_acesso – Access type identifier.
Returns:	None
Raises:	EquipamentoNaoExisteError – Equipment doesn’t exist. EquipamentoAcessoNaoExisteError – Relationship between equipment and access type doesn’t exist. InvalidParameterError – Equipment and/or access type id is/are invalid. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

networkapiclient.EquipamentoAmbiente module¶

class networkapiclient.EquipamentoAmbiente.EquipamentoAmbiente(networkapi_url, user, password, user_ldap=None)[source]¶

Bases: networkapiclient.GenericClient.GenericClient

inserir(id_equipment, id_environment, is_router=0)[source]¶

Inserts a new Related Equipment with Environment and returns its identifier

Parameters:	id_equipment – Identifier of the Equipment. Integer value and greater than zero. id_environment – Identifier of the Environment. Integer value and greater than zero. is_router – Identifier of the Environment. Boolean value.
Returns:	Dictionary with the following structure:

{'equipamento_ambiente': {'id': < id_equipment_environment >}}

Raises:	InvalidParameterError – The identifier of Equipment or Environment is null and invalid. AmbienteNaoExisteError – Environment not registered. EquipamentoNaoExisteError – Equipment not registered. EquipamentoAmbienteError – Equipment is already associated with the Environment. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

remover(id_equipment, id_environment)[source]¶

Remove Related Equipment with Environment from by the identifier.

Parameters:	id_equipment – Identifier of the Equipment. Integer value and greater than zero. id_environment – Identifier of the Environment. Integer value and greater than zero.
Returns:	None
Raises:	InvalidParameterError – The identifier of Environment, Equipament is null and invalid. EquipamentoNotFoundError – Equipment not registered. EquipamentoAmbienteNaoExisteError – Environment not registered. VipIpError – IP-related equipment is being used for a request VIP. XMLError – Networkapi failed to generate the XML response. DataBaseError – Networkapi failed to access the database.

update(id_equipment, id_environment, is_router)[source]¶

Remove Related Equipment with Environment from by the identifier.

Parameters:	id_equipment – Identifier of the Equipment. Integer value and greater than zero. id_environment – Identifier of the Environment. Integer value and greater than zero. is_router – Identifier of the Environment. Boolean value.
Returns:	None
Raises:	InvalidParameterError – The identifier of Environment, Equipament is null and invalid. EquipamentoNotFoundError – Equipment not registered. EquipamentoAmbienteNaoExisteError – Environment not registered. VipIpError – IP-related equipment is being used for a request VIP. XMLError – Networkapi failed to generate the XML response. DataBaseError – Networkapi failed to access the database.

networkapiclient.EquipamentoRoteiro module¶

class networkapiclient.EquipamentoRoteiro.EquipamentoRoteiro(networkapi_url, user, password, user_ldap=None)[source]¶

Bases: networkapiclient.GenericClient.GenericClient

inserir(id_equipment, id_script)[source]¶

Inserts a new Related Equipment with Script and returns its identifier

Parameters:	id_equipment – Identifier of the Equipment. Integer value and greater than zero. id_script – Identifier of the Script. Integer value and greater than zero.
Returns:	Dictionary with the following structure:

{'equipamento_roteiro': {'id': < id_equipment_script >}}

Raises:	InvalidParameterError – The identifier of Equipment or Script is null and invalid. RoteiroNaoExisteError – Script not registered. EquipamentoNaoExisteError – Equipment not registered. EquipamentoRoteiroError – Equipment is already associated with the script. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response

list_by_equip(name)[source]¶

List all equipment script by equipment name

Returns:	Dictionary with the following structure:

{‘equipamento_roteiro’:[ {'id': <id_equipment_script>,
'roteiro_id': <id_script>,
'roteiro_name': <name_script>,
'roteiro_desc': <desc_script>,
'tipo_roteiro_id': <id_script_type>,
'tipo_roteiro_name': <name_script_type>,
'tipo_roteiro_desc': <desc_script_type>, }],
'equipamento':
{'id': <id_equipment>,
'name': <name_equipment>,}}

Raises:	InvalidParameterError – Name is null and invalid. EquipamentoNotFoundError – Equipment name not found in database. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response

listar()[source]¶

List all Related Equipment with Script.

Somente retorna os relacionamentos dos equipamentos que o usuário autenticado tem permissão de leitura em pelo menos um grupo do equipamento.

Returns:	Dictionary with the following structure:

{'equipamento_roteiro': [{'roteiro': {'nome_tipo_roteiro': < nome_tipo_roteiro >,
'descricao': < descricao >,
'nome': < nome >,
'id': < id >,
'id_tipo_roteiro': < id_tipo_roteiro >,
'descricao_tipo_roteiro': < descrição_tipo_roteiro >},
'equipamento': {'id_modelo': < id_modelo >,
'nome': < nome >,
'nome_marca': < nome_marca >,
'nome_modelo': < nome_modelo >,
'id_marca': < id_marca >,
'nome_tipo_equipamento': < nome_tipo_equipamento >,
'id_tipo_equipamento': < id_tipo_equipamento >,
'id': < id >}},
... demais equipamento_roteiro´s ...]}

Raises:	DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response

remover(id_equipment, id_script)[source]¶

Remove Related Equipment with Script from by the identifier.

Parameters:	id_equipment – Identifier of the Equipment. Integer value and greater than zero. id_script – Identifier of the Script. Integer value and greater than zero.
Returns:	None
Raises:	InvalidParameterError – The identifier of Equipment or Script is null and invalid. RoteiroNaoExisteError – Script not registered. EquipamentoNaoExisteError – Equipment not registered. EquipamentoRoteiroNaoExisteError – Equipment is not associated with the script. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response

networkapiclient.EspecificacaoGrupoVirtual module¶

class networkapiclient.EspecificacaoGrupoVirtual.EspecificacaoGrupoVirtual[source]¶

Bases: object

Classe auxiliar para construção dos parâmetros das chamadas para provisionar ou remover grupo virtual.

add_equipamento(id_tipo_equipamento, id_modelo, prefixo, id_grupo, id_vlan, descricao_vlan)[source]¶

Adiciona um equipamento na lista de equipamentos para operação de inserir/alterar um grupo virtual.

Parameters:	id_tipo_equipamento – Identificador do tipo de equipamento. id_modelo – Identificador do modelo do equipamento. prefixo – Prefixo do nome do equipamento. id_grupo – Identificador do grupo do equipamento. id_vlan – Identificador da VLAN para criar um IP para o equipamento. descricao_vlan – Descrição do IP que será criado.
Returns:	None

add_equipamento_remove(id, id_ip, ids_ips_vips)[source]¶

Adiciona um equipamento na lista de equipamentos para operação de remover um grupo virtual.

Parameters:	id – Identificador do equipamento. id_ip – Identificador do IP do equipamento. ids_ips_vips – Lista com os identificadores de IPs criados para cada VIP e associados ao equipamento.
Returns:	None

add_vip(id, real_name_sufixo, id_vlan, descricao_vlan, id_vlan_real, descricao_vlan_real, balanceadores, id_healthcheck_expect, finalidade, cliente, ambiente, cache, metodo_bal, persistencia, healthcheck_type, healthcheck, timeout, host, maxcon, dsr, bal_ativo, transbordos, portas, real_maps, id_requisicao_vip, areanegocio='Orquestra', nome_servico='Orquestra', l7_filter=None, reals_prioritys=None, reals_weights=None)[source]¶

Adiciona um VIP na lista de VIPs para operação de inserir/alterar um grupo virtual.

Os parâmetros abaixo somente são necessários para a operação de alteração:

• ‘real_maps’: Deverá conter os reals atualmente criados para a requisição de VIP.
• ‘id_requisicao_vip’: O identificador da requisição que deverá ser alterada.

Os parâmetros abaixo somente são necessários para a operação de inserção:

• ‘id_vlan’: Identificador da VLAN para criar o IP do VIP.
• ‘descricao_vlan’: Descrição do IP do VIP.
• balanceadores: Lista com os identificadores dos balanceadores que serão associados ao IP do VIP.

Parameters:

id – Identificador do VIP utilizado pelo sistema de orquestração. real_name_sufixo – Sufixo utilizado para criar os reals_names dos equipamentos na requisição de VIP. id_vlan – Identificador da VLAN para criar um IP para o VIP. descricao_vlan – Descrição do IP que será criado para o VIP. id_vlan_real – Identificador da VLAN para criar os IPs dos equipamentos no VIP. descricao_vlan_real – Descrição dos IPs que serão criados para os equipamentos no VIP. balanceadores – Lista com os identificadores dos balanceadores que serão associados ao IP do VIP. id_healthcheck_expect – Identificador do healthcheck_expect para criar a requisição de VIP. finalidade – Finalidade da requisição de VIP. cliente – Cliente da requisição de VIP. ambiente – Ambiente da requisição de VIP. cache – Cache da requisição de VIP. metodo_bal – Método de balanceamento da requisição de VIP. persistencia – Persistência da requisição de VIP. healthcheck_type – Healthcheck_type da requisição de VIP. healthcheck – Healthcheck da requisição de VIP. timeout – Timeout da requisição de VIP. host – Host da requisição de VIP. maxcon – Máximo número de conexão da requisição de VIP. dsr – DSR da requisição de VIP. bal_ativo – Balanceador ativo da requisição de VIP. transbordos – Lista com os IPs dos transbordos da requisição de VIP. portas – Lista com as portas da requisição de VIP. real_maps – Lista dos mapas com os dados dos reals da requisição de VIP. Cada mapa deverá ter a estrutura: {‘real_name’:< real_name>, ‘real_ip’:< real_ip>} id_requisicao_vip – Identificador da requisição de VIP para operação de alterar um grupo virtual. areanegocio – Área de negócio para a requisição de VIP (é utilizado ‘Orquestra’ caso seja None). nome_servico – Nome do serviço para a requisição de VIP (é utilizado ‘Orquestra’ caso seja None). l7_filter – Filtro L7 para a requisição de VIP. reals_prioritys – Lista dos dados de prioridade dos reals da requisição de VIP (lista de zeros, caso seja None). reals_weights – Lista dos dados de pesos dos reals da requisição de VIP (lista de zeros, caso seja None).

Returns:

None

add_vip_incremento(id)[source]¶

Adiciona um vip à especificação do grupo virtual.

Parameters:	id – Identificador de referencia do VIP.

add_vip_remove(id_ip, id_equipamentos)[source]¶

Adiciona um VIP na lista de VIPs para operação de remover um grupo virtual.

Parameters:	id_ip – Identificador do IP criado para o VIP. id_equipamentos – Lista com os identificadores dos balanceadores associados ao IP do VIP.
Returns:	None

get_equipamentos()[source]¶

Obtem a lista de Equipamentos.

get_equipamentos_remove()[source]¶

Obtem a lista de equipamentos a serem removidos.

get_vips()[source]¶

Obtem a lista de VIPs.

get_vips_remove()[source]¶

Obtem a lista de VIPs a serem removidos.

networkapiclient.EventLog module¶

class networkapiclient.EventLog.EventLog(networkapi_url, user, password, user_ldap=None)[source]¶

Bases: networkapiclient.GenericClient.GenericClient

find_logs(user_name, first_date, start_time, last_date, end_time, action, functionality, parameter, pagination)[source]¶

Search all logs, filtering by the given parameters. :param user_name: Filter by user_name :param first_date: Sets initial date for begin of the filter :param start_time: Sets initial time :param last_date: Sets final date :param end_time: Sets final time and ends the filter. That defines the searching gap :param action: Filter by action (Create, Update or Delete) :param functionality: Filter by class :param parameter: Filter by parameter :param pagination: Class with all data needed to paginate

Returns:	Following dictionary:

{'eventlog': {'id_usuario' : < id_user >,
'hora_evento': < hora_evento >,
'acao': < acao >,
'funcionalidade': < funcionalidade >,
'parametro_anterior': < parametro_anterior >,
'parametro_atual': < parametro_atual > }
'total' : {< total_registros >} }

Raises:	InvalidParameterError – Some parameter was invalid. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

get_choices()[source]¶

Returns a dictionary with the values used to construct the select box of actions, functionalities and users.

Returns:	the following dictionary:

{'choices_map': {'usuario' : [{ 'usuario' : < user_id >
'usuario__nome' : < nome >
'usuario__user' : < user > }]
'acao' : ['action1', 'action2', 'action3' .. 'actionN']
'funcionalidade' : ['functionality1', 'functionality2', .. 'functionalityN'] }}

get_version()[source]¶

Returns the API’s version

Returns:

{'version_api': <version_api> }

networkapiclient.Filter module¶

class networkapiclient.Filter.Filter(networkapi_url, user, password, user_ldap=None)[source]¶

Bases: networkapiclient.GenericClient.GenericClient

add(name, description)[source]¶

Inserts a new Filter and returns its identifier.

Parameters:	name – Name. String with a maximum of 100 characters and respect [a-zA-Z_-] description – Description. String with a maximum of 200 characters and respect [a-zA-Z_-]
Returns:	Following dictionary:

{'filter': {'id': < id >}}

Raises:	InvalidParameterError – The value of name or description is invalid. FilterDuplicateError – A filter named by name already exists. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

alter(id_filter, name, description)[source]¶

Change Filter by the identifier.

Parameters:	id_filter – Identifier of the Filter. Integer value and greater than zero. name – Name. String with a maximum of 50 characters and respect [a-zA-Z_-] description – Description. String with a maximum of 50 characters and respect [a-zA-Z_-]
Returns:	None
Raises:	InvalidParameterError – Filter identifier is null and invalid. InvalidParameterError – The value of name or description is invalid. FilterNotFoundError – Filter not registered. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

associate(et_id, id_filter)[source]¶

Create a relationship between Filter and TipoEquipamento.

Parameters:	et_id – Identifier of TipoEquipamento. Integer value and greater than zero. id_filter – Identifier of Filter. Integer value and greater than zero.
Returns:	Following dictionary:

{'equiptype_filter_xref': {'id': < id_equiptype_filter_xref >} }

Raises:	InvalidParameterError – TipoEquipamento/Filter identifier is null and/or invalid. TipoEquipamentoNaoExisteError – TipoEquipamento not registered. FilterNotFoundError – Filter not registered. FilterEqTypeAssociationError – TipoEquipamento and Filter already associated. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

dissociate(id_filter, id_eq_type)[source]¶

Removes relationship between Filter and TipoEquipamento.

Parameters:	id_filter – Identifier of Filter. Integer value and greater than zero. id_eq_type – Identifier of TipoEquipamento. Integer value, greater than zero.
Returns:	None
Raises:	FilterNotFoundError – Filter not registered. TipoEquipamentoNotFoundError – TipoEquipamento not registered. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

get(id_filter)[source]¶

Get filter by id.

Parameters:	id_filter – Identifier of the Filter. Integer value and greater than zero.
Returns:	Following dictionary:

{‘filter’: {‘id’: < id >,
‘name’: < name >,
‘description’: < description >}}

Raises:	InvalidParameterError – The value of id_filter is invalid. FilterNotFoundError – Filter not registered. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

list_all()[source]¶

List all filters

Returns:	Following dictionary:

{'filter': [{'id': <id>,
'name': <name>,
'description': <description>,
'equip_types': [<TipoEquipamento>,
{...demais TipoEquipamento's...}]}
{... demais filters ...}] }

Raises:	DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

remove(id_filter)[source]¶

Remove Filter by the identifier.

Parameters:	id_filter – Identifier of the Filter. Integer value and greater than zero.
Returns:	None
Raises:	InvalidParameterError – Filter identifier is null and invalid. FilterNotFoundError – Filter not registered. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

networkapiclient.GenericClient module¶

class networkapiclient.GenericClient.GenericClient(networkapi_url, user, password, user_ldap=None)[source]¶

Bases: object

Class inherited by all NetworkAPI-Client classes who implements access methods to networkAPI.

get_error(xml)[source]¶

Obtem do XML de resposta, o código e a descrição do erro.

O XML corresponde ao corpo da resposta HTTP de código 500.

Parameters:	xml – XML contido na resposta da requisição HTTP.
Returns:	Tupla com o código e a descrição do erro contido no XML: (< codigo_erro>, < descricao_erro>)

get_url(postfix)[source]¶

Constroe e retorna a URL completa para acesso à networkAPI.

Parameters:	postfix – Posfixo a ser colocado na URL básica. Ex: /ambiente
Returns:	URL completa.

response(code, xml, force_list=None)[source]¶

Cria um dicionário com os dados de retorno da requisição HTTP ou

lança uma exceção correspondente ao erro ocorrido.

Se a requisição HTTP retornar o código 200 então este método retorna o

dicionário com os dados da resposta.

Se a requisição HTTP retornar um código diferente de 200 então este método

lança uma exceção correspondente ao erro.

Todas as exceções lançadas por este método deverão herdar de NetworkAPIClientError.

Parameters:	code – Código de retorno da requisição HTTP. xml – XML ou descrição (corpo) da resposta HTTP. force_list – Lista com as tags do XML de resposta que deverão ser transformadas obrigatoriamente em uma lista no dicionário de resposta.
Returns:	Dicionário com os dados da resposta HTTP retornada pela networkAPI.

submit(map, method, postfix)[source]¶

Realiza um requisição HTTP para a networkAPI.

Parameters:	map – Dicionário com os dados para gerar o XML enviado no corpo da requisição HTTP. method – Método da requisição HTTP (‘GET’, ‘POST’, ‘PUT’ ou ‘DELETE’). postfix – Posfixo a ser colocado na URL básica de acesso à networkAPI. Ex: /ambiente
Returns:	Tupla com o código e o corpo da resposta HTTP: (< codigo>, < descricao>)
Raises NetworkAPIClientError:
	Erro durante a chamada HTTP para acesso à networkAPI.

networkapiclient.GrupoEquipamento module¶

class networkapiclient.GrupoEquipamento.GrupoEquipamento(networkapi_url, user, password, user_ldap=None)[source]¶

Bases: networkapiclient.GenericClient.GenericClient

alterar(id_egrupo, nome)[source]¶

Altera os dados de um grupo de equipamento a partir do seu identificador.

Parameters:	id_egrupo – Identificador do grupo de equipamento. nome – Nome do grupo de equipamento.
Returns:	None
Raises:	InvalidParameterError – O identificador e/ou o nome do grupo são nulos ou inválidos. GrupoEquipamentoNaoExisteError – Grupo de equipamento não cadastrado. NomeGrupoEquipamentoDuplicadoError – Nome do grupo de equipamento duplicado. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao ler o XML de requisição ou gerar o XML de resposta.

associa_equipamento(id_equip, id_grupo_equipamento)[source]¶

Associa um equipamento a um grupo.

Parameters:	id_equip – Identificador do equipamento. id_grupo_equipamento – Identificador do grupo de equipamento.
Returns:	Dicionário com a seguinte estrutura: {‘equipamento_grupo’:{‘id’: < id_equip_do_grupo >}}
Raises:	GrupoEquipamentoNaoExisteError – Grupo de equipamento não cadastrado. InvalidParameterError – O identificador do equipamento e/ou do grupo são nulos ou inválidos. EquipamentoNaoExisteError – Equipamento não cadastrado. EquipamentoError – Equipamento já está associado ao grupo. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao ler o XML de requisição ou gerar o XML de resposta.

inserir(nome)[source]¶

Insere um novo grupo de equipamento e retorna o seu identificador.

Parameters:	nome – Nome do grupo de equipamento.
Returns:	Dicionário com a seguinte estrutura: {‘grupo’: {‘id’: < id >}}
Raises:	InvalidParameterError – Nome do grupo é nulo ou vazio. NomeGrupoEquipamentoDuplicadoError – Nome do grupo de equipmaneto duplicado. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao ler o XML de requisição ou gerar o XML de resposta.

listar()[source]¶

Lista todos os grupos de equipamentos.

Returns:	Dicionário com a seguinte estrutura:

{'grupo':
[{'id': < id >,
'nome': < nome >},
... demais grupos ...]}

Raises:	DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao gerar o XML de resposta.

listar_por_equip(equip_id)[source]¶

Lista todos os grupos de equipamentos por equipamento especifico.

Returns:	Dicionário com a seguinte estrutura:

{'grupo':  [{'id': < id >,
'nome': < nome >},
... demais grupos ...]}

Raises:	DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao gerar o XML de resposta.

remove(id_equipamento, id_egrupo)[source]¶

Remove a associacao de um grupo de equipamento com um equipamento a partir do seu identificador.

Parameters:	id_egrupo – Identificador do grupo de equipamento. id_equipamento – Identificador do equipamento.
Returns:	None
Raises:	EquipamentoNaoExisteError – Equipamento não cadastrado. GrupoEquipamentoNaoExisteError – Grupo de equipamento não cadastrado. InvalidParameterError – O identificador do grupo é nulo ou inválido. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao gerar o XML de resposta.

remover(id_egrupo)[source]¶

Remove um grupo de equipamento a partir do seu identificador.

Parameters:	id_egrupo – Identificador do grupo de equipamento.
Returns:	None
Raises:	GrupoEquipamentoNaoExisteError – Grupo de equipamento não cadastrado. InvalidParameterError – O identificador do grupo é nulo ou inválido. GroupDontRemoveError – DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao gerar o XML de resposta.

search(id_egroup)[source]¶

Search Group Equipament from by the identifier.

Parameters:	id_egroup – Identifier of the Group Equipament. Integer value and greater than zero.
Returns:	Following dictionary:

{‘group_equipament’:  {‘id’: < id_egrupo >,
‘nome’: < nome >} }

Raises:	InvalidParameterError – Group Equipament identifier is null and invalid. GrupoEquipamentoNaoExisteError – Group Equipament not registered. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

networkapiclient.GrupoL3 module¶

class networkapiclient.GrupoL3.GrupoL3(networkapi_url, user, password, user_ldap=None)[source]¶

Bases: networkapiclient.GenericClient.GenericClient

alterar(id_groupl3, name)[source]¶

Change Group L3 from by the identifier.

Parameters:	id_groupl3 – Identifier of the Group L3. Integer value and greater than zero. name – Group L3 name. String with a minimum 2 and maximum of 80 characters
Returns:	None
Raises:	InvalidParameterError – The identifier of Group L3 or name is null and invalid. NomeGrupoL3DuplicadoError – There is already a registered Group L3 with the value of name. GrupoL3NaoExisteError – Group L3 not registered. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

inserir(name)[source]¶

Inserts a new Group L3 and returns its identifier.

Parameters:	name – Group L3 name. String with a minimum 2 and maximum of 80 characters
Returns:	Dictionary with the following structure:

{'group_l3': {'id': < id_group_l3 >}}

Raises:	InvalidParameterError – Name is null and invalid. NomeGrupoL3DuplicadoError – There is already a registered Group L3 with the value of name. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

listar()[source]¶

List all Group L3.

Returns:	Dictionary with the following structure:

{'group_l3': [{'id': < id >,
'name': < name >},
...more Group L3...]}

Raises:	DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

remover(id_groupl3)[source]¶

Remove Group L3 from by the identifier.

Parameters:	id_groupl3 – Identifier of the Group L3. Integer value and greater than zero.
Returns:	None
Raises:	InvalidParameterError – The identifier of Group L3 is null and invalid. GrupoL3NaoExisteError – Group L3 not registered. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

networkapiclient.GrupoUsuario module¶

class networkapiclient.GrupoUsuario.GrupoUsuario(networkapi_url, user, password, user_ldap=None)[source]¶

Bases: networkapiclient.GenericClient.GenericClient

alterar(id_user_group, name, read, write, edit, remove)[source]¶

Edit user group data from its identifier.

Parameters:	id_user_group – User group id. name – User group name. read – If user group has read permission (‘S’ ou ‘N’). write – If user group has write permission (‘S’ ou ‘N’). edit – If user group has edit permission (‘S’ ou ‘N’). remove – If user group has remove permission (‘S’ ou ‘N’).
Returns:	None
Raises:	NomeGrupoUsuarioDuplicadoError – User group name already exists. ValorIndicacaoPermissaoInvalidoError – Read, write, edit or remove value is invalid. GrupoUsuarioNaoExisteError – User Group not found. InvalidParameterError – At least one of the parameters is invalid or none. DataBaseError – Networkapi failed to access database. XMLError – Networkapi fails generating response XML.

inserir(name, read, write, edit, remove)[source]¶

Insert new user group and returns its identifier.

Parameters:	name – User group’s name. read – If user group has read permission (‘S’ ou ‘N’). write – If user group has write permission (‘S’ ou ‘N’). edit – If user group has edit permission (‘S’ ou ‘N’). remove – If user group has remove permission (‘S’ ou ‘N’).
Returns:	Dictionary with structure: {‘user_group’: {‘id’: < id >}}
Raises:	InvalidParameterError – At least one of the parameters is invalid or none.. NomeGrupoUsuarioDuplicadoError – User group name already exists. ValorIndicacaoPermissaoInvalidoError – Read, write, edit or remove value is invalid. DataBaseError – Networkapi failed to access database. XMLError – Networkapi fails generating response XML.

listar()[source]¶

List all user groups.

Returns:	Dictionary with structure:

{'user_group':  [{'escrita': < escrita >,
'nome': < nome >,
'exclusao': < exclusao >,
'edicao': < edicao >,
'id': < id >,
'leitura': < leitura >},
... other groups ...]}

Raises:	DataBaseError – Networkapi failed to access database. XMLError – Networkapi fails generating response XML.

remover(id_user_group)[source]¶

Removes a user group by its id.

Parameters:	id_user_group – User Group’s identifier. Valid integer greater than zero.
Returns:	None
Raises:	GrupoUsuarioNaoExisteError – User Group not found. InvalidParameterError – User Group id is invalid or none. DataBaseError – Networkapi failed to access database. XMLError – Networkapi fails generating response XML.

search(id_ugroup)[source]¶

Search Group User by its identifier.

Parameters:	id_ugroup – Identifier of the Group User. Integer value and greater than zero.
Returns:	Following dictionary:

{‘user_group’: {'escrita': < escrita >,
'nome': < nome >,
'exclusao': < exclusao >,
'edicao': < edicao >,
'id': < id >,
'leitura': < leitura >}}

Raises:	InvalidParameterError – Group User identifier is none or invalid. GrupoUsuarioNaoExisteError – Group User not registered. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

networkapiclient.GrupoVirtual module¶

Title: Infrastructure NetworkAPI Author: globo.com / TQI Copyright: ( c ) 2009 globo.com todos os direitos reservados.

class networkapiclient.GrupoVirtual.GrupoVirtual(networkapi_url, user, password, user_ldap=None)[source]¶

Bases: networkapiclient.GenericClient.GenericClient

provisionar(equipamentos, vips)[source]¶

Realiza a inserção ou alteração de um grupo virtual para o sistema de Orquestração de VM.

Parameters:	equipamentos – Lista de equipamentos gerada pelo método “add_equipamento” da classe “EspecificacaoGrupoVirtual”. vips – Lista de VIPs gerada pelo método “add_vip” da classe “EspecificacaoGrupoVirtual”.
Returns:	Retorno da operação de inserir ou alterar um grupo virtual:

{'equipamentos': {'equipamento': [{'id': < id>,
'nome': < nome>,
'ip':  {'id': < id>,
'id_vlan': < id_vlan>,
'oct4': < oct4>,
'oct3': < oct3>,
'oct2': < oct2>,
'oct1': < oct1>,
'descricao': < descricao>},
'vips': {'vip': [{'id': < id>,
'ip': {'id': < id>,
'id_vlan': < id_vlan>,
'oct4': < oct4>,
'oct3': < oct3>,
'oct2': < oct2>,
'oct1': < oct1>,
'descricao': < descricao>}}, ... demais vips ...]}}, ... demais equipamentos...]},
'vips': {'vip': [{'id': < id>,
'ip': {'id': < id>,
'id_vlan': < id_vlan>,
'oct4': < oct4>,
'oct3': < oct3>,
'oct2': < oct2>,
'oct1': < oct1>,
'descricao': < descricao>},
'requisicao_vip': {'id': < id>}}, ... demais vips...]}}

{'equipamentos': {'equipamento': [{'id': < id>,
'nome': < nome>,
'ip': {'id': < id>,
'id_vlan': < id_vlan>,
'oct4': < oct4>,
'oct3': < oct3>,
'oct2': < oct2>,
'oct1': < oct1>,
'descricao': < descricao>},
'vips': {'vip': [{'id': < id>,
'ip': {'id': < id>,
'id_vlan': < id_vlan>,
'oct4': < oct4>,
'oct3': < oct3>,
'oct2': < oct2>,
'oct1': < oct1>,
'descricao': < descricao>}}, ... demais vips ...]}}, ... demais equipamentos...]},
'vips': {'vip': [{'id': < id>,
'requisicao_vip': {'id': < id>}}, ... demais vips...]}}

Raises:

InvalidParameterError – Algum dado obrigatório não foi informado nas listas ou possui um valor inválido. XMLError – Falha na networkapi ao ler o XML de requisição ou gerar o XML de resposta. DataBaseError – Falha na networkapi ao acessar o banco de dados. VlanNaoExisteError – VLAN não cadastrada. EquipamentoNaoExisteError – Equipamento não cadastrado. IPNaoDisponivelError – Não existe IP disponível para a VLAN informada. TipoEquipamentoNaoExisteError – Tipo de equipamento não cadastrado. ModeloEquipamentoNaoExisteError – Modelo do equipamento não cadastrado. GrupoEquipamentoNaoExisteError – Grupo de equipamentos não cadastrado. EquipamentoError – Equipamento com o nome duplicado ou Equipamento do grupo “Equipamentos Orquestração” somente poderá ser criado com tipo igual a “Servidor Virtual”. IpNaoExisteError – IP não cadastrado. IpError – IP já está associado ao equipamento. VipNaoExisteError – Requisição de VIP não cadastrada. HealthCheckExpectNaoExisteError – Healthcheck_expect não cadastrado.

remover_provisionamento(equipamentos, vips)[source]¶

Remove o provisionamento de um grupo virtual para o sistema de Orquestração VM.

Parameters:	equipamentos – Lista de equipamentos gerada pelo método “add_equipamento_remove” da classe “EspecificacaoGrupoVirtual”. vips – Lista de VIPs gerada pelo método “add_vip_remove” da classe “EspecificacaoGrupoVirtual”.
Returns:	None
Raises:	InvalidParameterError – Algum dado obrigatório não foi informado nas listas ou possui um valor inválido. IpNaoExisteError – IP não cadastrado. EquipamentoNaoExisteError – Equipamento não cadastrado. IpError – IP não está associado ao equipamento. DataBaseError – Falha na networkapi ao acessar o banco de dados. XMLError – Falha na networkapi ao ler o XML de requisição ou gerar o XML de resposta.

networkapiclient.Interface module¶

class networkapiclient.Interface.Interface(networkapi_url, user, password, user_ldap=None)[source]¶

Bases: networkapiclient.GenericClient.GenericClient

alterar(id_interface, nome, protegida, descricao, id_ligacao_front, id_ligacao_back, tipo=None, vlan=None)[source]¶

Edit an interface by its identifier.

Equipment identifier is not changed.

Parameters:	nome – Interface name. protegida – Indication of protected (‘0’ or ‘1’). descricao – Interface description. id_ligacao_front – Front end link interface identifier. id_ligacao_back – Back end link interface identifier. id_interface – Interface identifier.
Returns:	None
Raises:	InvalidParameterError – The parameters interface id, nome and protegida are none or invalid. NomeInterfaceDuplicadoParaEquipamentoError – There is already an interface with this name for this equipment. InterfaceNaoExisteError – Front link interface and/or back link interface doesn’t exist. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

associar_ambiente(ambiente, interface)[source]¶

delete_channel(channel_name)[source]¶

dissociar(interface)[source]¶

editar_channel(id_channel, nome, lacp, int_type, vlan, envs, ids_interface)[source]¶

get_by_id(id_interface)[source]¶

Get an interface by id.

Parameters:	id_interface – Interface identifier.
Returns:	Following dictionary:

{'interface': {'id': < id >,
'interface': < interface >,
'descricao': < descricao >,
'protegida': < protegida >,
'tipo_equip': < id_tipo_equipamento >,
'equipamento': < id_equipamento >,
'equipamento_nome': < nome_equipamento >
'ligacao_front': < id_ligacao_front >,
'nome_ligacao_front': < interface_name >,
'nome_equip_l_front': < equipment_name >,
'ligacao_back': < id_ligacao_back >,
'nome_ligacao_back': < interface_name >,
'nome_equip_l_back': < equipment_name > }}

Raises:	InvalidParameterError – Interface identifier is invalid or none. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

get_env_by_id(id_interface)[source]¶

get_interface_by_channel(channel_name, equip_name)[source]¶

inserir(nome, protegida, descricao, id_ligacao_front, id_ligacao_back, id_equipamento, tipo=None, vlan=None)[source]¶

Insert new interface for an equipment.

Parameters:	nome – Interface name. protegida – Indication of protected (‘0’ or ‘1’). descricao – Interface description. id_ligacao_front – Front end link interface identifier. id_ligacao_back – Back end link interface identifier. id_equipamento – Equipment identifier.
Returns:	Dictionary with the following: {‘interface’: {‘id’: < id >}}
Raises:	EquipamentoNaoExisteError – Equipment does not exist. InvalidParameterError – The parameters nome, protegida and/or equipment id are none or invalid. NomeInterfaceDuplicadoParaEquipamentoError – There is already an interface with this name for this equipment. InterfaceNaoExisteError – Front link interface and/or back link interface doesn’t exist. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

inserir_channel(interfaces, nome, lacp, int_type, vlan, envs)[source]¶

list_all_by_equip(id_equipamento)[source]¶

List all interfaces of an equipment.

Parameters:	id_equipamento – Equipment identifier.
Returns:	Following dictionary:

{'interfaces': [ {'id': < id >,
'interface': < interface >,
'descricao': < descricao >,
'protegida': < protegida >,
'tipo_equip': < id_tipo_equipamento >,
'equipamento': < id_equipamento >,
'equipamento_nome': < nome_equipamento >
'ligacao_front': < id_ligacao_front >,
'nome_ligacao_front': < interface_name >,
'nome_equip_l_front': < equipment_name >,
'ligacao_back': < id_ligacao_back >,
'nome_ligacao_back': < interface_name >,
'nome_equip_l_back': < equipment_name > }, ... other interfaces ...]}

Raises:	InvalidParameterError – Equipment identifier is invalid or none. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

list_all_interface_types()[source]¶

list_available_interfaces(channel_name, id_equip)[source]¶

list_connections(nome_interface, id_equipamento)[source]¶

List interfaces linked to back and front of specified interface.

Parameters:	nome_interface – Interface name. id_equipamento – Equipment identifier.
Returns:	Dictionary with the following:

{'interfaces':[ {'id': < id >,
'interface': < nome >,
'descricao': < descricao >,
'protegida': < protegida >,
'equipamento': < id_equipamento >,
'tipo_equip': < id_tipo_equipamento >,
'ligacao_front': < id_ligacao_front >,
'nome_ligacao_front': < interface_name >,
'nome_equip_l_front': < equipment_name >,
'ligacao_back': < id_ligacao_back >,
'nome_ligacao_back': < interface_name >,
'nome_equip_l_back': < equipment_name > }, ... other interfaces ...]}

Raises:	InterfaceNaoExisteError – Interface doesn’t exist or is not associated with this equipment. EquipamentoNaoExisteError – Equipment doesn’t exist. InvalidParameterError – Interface name and/or equipment identifier are none or invalid. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

listar_ligacoes(nome_interface, id_equipamento)[source]¶

List interfaces linked to back and front of specified interface.

Parameters:	nome_interface – Interface name. id_equipamento – Equipment identifier.
Returns:	Dictionary with the following:

{'interface': [{'protegida': < protegida >,
'nome': < nome >,
'id_ligacao_front': < id_ligacao_front >,
'id_equipamento': < id_equipamento >,
'id': < id >,
'descricao': < descricao >,
'id_ligacao_back': < id_ligacao_back >}, ... other interfaces ...]}

Raises:	InterfaceNaoExisteError – Interface doesn’t exist or is not associated with this equipment. EquipamentoNaoExisteError – Equipment doesn’t exist. InvalidParameterError – Interface name and/or equipment identifier are none or invalid. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

listar_por_equipamento(id_equipamento)[source]¶

List all interfaces of an equipment.

Parameters:	id_equipamento – Equipment identifier.
Returns:	Dictionary with the following:

{'interface':
[{'protegida': < protegida >,
'nome': < nome >,
'id_ligacao_front': < id_ligacao_front >,
'id_equipamento': < id_equipamento >,
'id': < id >,
'descricao': < descricao >,
'id_ligacao_back': < id_ligacao_back >}, ... other interfaces ...]}

Raises:	InvalidParameterError – Equipment identifier is invalid or none. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

listar_switch_router(id_equipamento)[source]¶

remove_connection(id_interface, back_or_front)[source]¶

Remove a connection between two interfaces

Parameters:	id_interface – One side of relation back_or_front – This side of relation is back(0) or front(1)
Returns:	None
Raises:	InterfaceInvalidBackFrontError – Front or Back of interfaces not match to remove connection InvalidParameterError – Interface id or back or front indicator is none or invalid. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

remover(id_interface)[source]¶

Remove an interface by its identifier.

Parameters:	id_interface – Interface identifier.
Returns:	None
Raises:	InterfaceNaoExisteError – Interface doesn’t exist. InterfaceError – Interface is linked to another interface. InvalidParameterError – The interface identifier is invalid or none. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

networkapiclient.Ip module¶

class networkapiclient.Ip.Ip(networkapi_url, user, password, user_ldap=None)[source]¶

Bases: networkapiclient.GenericClient.GenericClient

assoc_ipv4(id_ip, id_equip, id_net)[source]¶

Associate an IP4 with equipment.

Parameters:	id_ip – IPv4 identifier. id_equip – Equipment identifier. Integer value and greater than zero. id_net – Network identifier. Integer value and greater than zero.
Returns:	None
Raises:	InvalidParameterError – IPv4, Equipment or Network identifier is none or invalid. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

assoc_ipv6(id_ip, id_equip, id_net)[source]¶

Associate an IP6 with equipment.

Parameters:	id_ip – IPv6 identifier. id_equip – Equipment identifier. Integer value and greater than zero. id_net – Network identifier. Integer value and greater than zero.
Returns:	None
Raises:	InvalidParameterError – IPv6, Equipment or Network identifier is none or invalid. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

buscar_por_ip_ambiente(ip, id_environment)[source]¶

Get IP with an associated environment.

Parameters:	ip – IP address in the format x1.x2.x3.x4. id_environment – Identifier of the environment. Integer value and greater than zero.
Returns:	Dictionary with the following structure:

{'ip': {'id': < id >,
'id_vlan': < id_vlan >,
'oct4': < oct4 >,
'oct3': < oct3 >,
'oct2': < oct2 >,
'oct1': < oct1 >,
'descricao': < descricao > }}

Raises:	IpNaoExisteError – IP is not registered or not associated with environment. InvalidParameterError – The environment identifier and/or IP is/are null or invalid. DataBaseError – Networkapi failed to access the database.

check_vip_ip(ip, id_evip)[source]¶

Get a Ipv4 or Ipv6 for Vip request

Parameters:	ip – IPv4 or Ipv6. ‘xxx.xxx.xxx.xxx or xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx’
Returns:	Dictionary with the following structure:

{'ip': {'ip': < ip - octs for ipv4, blocks for ipv6 - >,
'id': <id>,
'network4 or network6'}}.

Raises:

IpNaoExisteError – Ipv4 or Ipv6 not found. EnvironemntVipNotFoundError – Vip environment not found. IPNaoDisponivelError – Ip not available for Vip Environment. UserNotAuthorizedError – User dont have permission to perform operation. InvalidParameterError – Ip string or vip environment is none or invalid. XMLError – Networkapi failed to generate the XML response. DataBaseError – Networkapi failed to access the database.

delete_ip4(id_ip)[source]¶

Delete an IP4

Parameters:	id_ip – Ipv4 identifier. Integer value and greater than zero.
Returns:	None
Raises:	IpNotFoundError – IP is not registered. DataBaseError – Networkapi failed to access the database.

delete_ip6(id_ip)[source]¶

Delete an IP6

Parameters:	id_ip – Ipv6 identifier. Integer value and greater than zero.
Returns:	None
Raises:	IpNotFoundError – IP is not registered. DataBaseError – Networkapi failed to access the database.

edit_ipv4(ip4, descricao, id_ip)[source]¶

Edit a IP4

Parameters:	ip4 – An IP4 available to save in format x.x.x.x. id_ip – IP identifier. Integer value and greater than zero. descricao – IP description.
Returns:	None

edit_ipv6(ip6, descricao, id_ip)[source]¶

Edit a IP6

Parameters:	ip6 – An IP6 available to save in format xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx. descricao – IP description. id_ip – Ipv6 identifier. Integer value and greater than zero.
Returns:	None

find_ip4_by_id(id_ip)[source]¶

Get an IP by ID

Parameters:	id_ip – IP identifier. Integer value and greater than zero.
Returns:	Dictionary with the following structure:

{ ips { id: <id_ip4>,
oct1: <oct1>,
oct2: <oct2>,
oct3: <oct3>,
oct4: <oct4>,
equipamento: [ {all equipamentos related} ] ,
descricao: <descricao>} }

Raises:	IpNotAvailableError – Network dont have available IP. NetworkIPv4NotFoundError – Network was not found. UserNotAuthorizedError – User dont have permission to perform operation. InvalidParameterError – Ip identifier is none or invalid. XMLError – Networkapi failed to generate the XML response. DataBaseError – Networkapi failed to access the database.

find_ip4_by_network(id_network)[source]¶

List IPv4 from network.

Parameters:	id_network – Networkv ipv4 identifier. Integer value and greater than zero.
Returns:	Dictionary with the following structure:

{'ip': {'id': < id >,
'id_vlan': < id_vlan >,
'oct4': < oct4 >,
'oct3': < oct3 >,
'oct2': < oct2 >,
'oct1': < oct1 >,
'descricao': < descricao >
'equipamento': [ { all name equipamentos related } ], }}

Raises:	IpNaoExisteError – Network does not have any ips. InvalidParameterError – Network identifier is none or invalid. DataBaseError – Networkapi failed to access the database.

find_ip6_by_id(id_ip)[source]¶

Get an IP6 by ID

Parameters:	id_ip – IP6 identifier. Integer value and greater than zero.
Returns:	Dictionary with the following structure:

{'ip': {'id': < id >,
'block1': <block1>,
'block2': <block2>,
'block3': <block3>,
'block4': <block4>,
'block5': <block5>,
'block6': <block6>,
'block7': <block7>,
'block8': <block8>,
'descricao': < description >,
'equipamento': [ { all name equipamentos related} ], }}

Raises:	IpNotAvailableError – Network dont have available IPv6. NetworkIPv4NotFoundError – Network was not found. UserNotAuthorizedError – User dont have permission to perform operation. InvalidParameterError – IPv6 identifier is none or invalid. XMLError – Networkapi failed to generate the XML response. DataBaseError – Networkapi failed to access the database.

find_ip6_by_network(id_network)[source]¶

List IPv6 from network.

Parameters:	id_network – Network ipv6 identifier. Integer value and greater than zero.
Returns:	Dictionary with the following structure:

{'ip': {'id': < id >,
'id_vlan': < id_vlan >,
'block1': <block1>,
'block2': <block2>,
'block3': <block3>,
'block4': <block4>,
'block5': <block5>,
'block6': <block6>,
'block7': <block7>,
'block8': <block8>,
'descricao': < description >
'equipamento': [ { all name equipamentos related } ], }}

Raises:	IpNaoExisteError – Network does not have any ips. InvalidParameterError – Network identifier is none or invalid. DataBaseError – Networkapi failed to access the database.

find_ips_by_equip(id_equip)[source]¶

Get Ips related to equipment by its identifier

Parameters:	id_equip – Equipment identifier. Integer value and greater than zero.
Returns:	Dictionary with the following structure: { ips: { ipv4:[ id: <id_ip4>, oct1: <oct1>, oct2: <oct2>, oct3: <oct3>, oct4: <oct4>, descricao: <descricao> ] ipv6:[ id: <id_ip6>, block1: <block1>, block2: <block2>, block3: <block3>, block4: <block4>, block5: <block5>, block6: <block6>, block7: <block7>, block8: <block8>, descricao: <descricao> ] } }
Raises:	UserNotAuthorizedError – User dont have permission to list ips. InvalidParameterError – Equipment identifier is none or invalid. XMLError – Networkapi failed to generate the XML response. DataBaseError – Networkapi failed to access the database.

get_available_ip4(id_network)[source]¶

Get a available IP in the network ipv4

Parameters:	id_network – Network identifier. Integer value and greater than zero.
Returns:	Dictionary with the following structure:

{'ip': {'ip': < available_ip >}}

Raises:	IpNotAvailableError – Network dont have available IP for insert a new IP NetworkIPv4NotFoundError – Network is not found UserNotAuthorizedError – User dont have permission to get a available IP InvalidParameterError – Network identifier is null or invalid. XMLError – Networkapi failed to generate the XML response. DataBaseError – Networkapi failed to access the database.

get_available_ip4_for_vip(id_evip, name)[source]¶

Get and save a available IP in the network ipv6 for vip request

Parameters:	id_evip – Vip environment identifier. Integer value and greater than zero. name – Ip description
Returns:	Dictionary with the following structure:

{'ip': {'oct1': < oct1 >,
'oct2': < oct2 >,
'oct3': < oct3 >,
'oct4': < oct4 >,
'networkipv4': <networkipv4>,
'id': <id>,
'descricao': <descricao>}}

Raises:	IpNotAvailableError – Network dont have available IP for vip environment. EnvironmentVipNotFoundError – Vip environment not registered. UserNotAuthorizedError – User dont have permission to perform operation. InvalidParameterError – Vip environment identifier is none or invalid. XMLError – Networkapi failed to generate the XML response. DataBaseError – Networkapi failed to access the database.

get_available_ip6(id_network6)[source]¶

Get a available IP in Network ipv6

Parameters:	id_network6 – Network ipv6 identifier. Integer value and greater than zero.
Returns:	Dictionary with the following structure:

{'ip6': {'ip6': < available_ip6 >}}

Raises:	IpNotAvailableError – Network dont have available IP. NetworkIPv4NotFoundError – Network was not found. UserNotAuthorizedError – User dont have permission to get a available IP. InvalidParameterError – Network ipv6 identifier is none or invalid. XMLError – Networkapi failed to generate the XML response. DataBaseError – Networkapi failed to access the database.

get_available_ip6_for_vip(id_evip, name)[source]¶

Get and save a available IP in the network ipv6 for vip request

Parameters:	id_evip – Vip environment identifier. Integer value and greater than zero. name – Ip description
Returns:	Dictionary with the following structure:

{'ip': {'bloco1':<bloco1>,
'bloco2':<bloco2>,
'bloco3':<bloco3>,
'bloco4':<bloco4>,
'bloco5':<bloco5>,
'bloco6':<bloco6>,
'bloco7':<bloco7>,
'bloco8':<bloco8>,
'id':<id>,
'networkipv6':<networkipv6>,
'description':<description>}}

Raises:	IpNotAvailableError – Network dont have available IP for vip environment. EnvironmentVipNotFoundError – Vip environment not registered. UserNotAuthorizedError – User dont have permission to perform operation. InvalidParameterError – Vip environment identifier is none or invalid. XMLError – Networkapi failed to generate the XML response. DataBaseError – Networkapi failed to access the database.

get_ip_by_equip_and_vip(equip_name, id_evip)[source]¶

Get a available IP in the Equipment related Environment VIP

Parameters:	equip_name – Equipment Name. id_evip – Vip environment identifier. Integer value and greater than zero.
Returns:	Dictionary with the following structure:

{ 'ipv4': [ {'id': < id >, 'ip': < ip >, 'network': { 'id': < id >, 'network': < network >, 'mask': < mask >, }} ... ],
'ipv6': [ {'id': < id >, 'ip': < ip >, 'network': { 'id': < id >, 'network': < network >, 'mask': < mask >, }} ... ] }

Raises:	InvalidParameterError – Vip environment identifier or equipment name is none or invalid. EquipamentoNotFoundError – Equipment not registered. EnvironmentVipNotFoundError – Vip environment not registered. UserNotAuthorizedError – User dont have permission to perform operation. XMLError – Networkapi failed to generate the XML response. DataBaseError – Networkapi failed to access the database.

get_ipv4(id_ip)[source]¶

Get IPv4 by id.

Parameters:	id_ip – ID of IPv4.
Returns:	Dictionary with the following structure:

{'ip': {'id': < id >,
'networkipv4': < networkipv4 >,
'oct4': < oct4 >,
'oct3': < oct3 >,
'oct2': < oct2 >,
'oct1': < oct1 >,
'descricao': < descricao >,
'equipamentos': [ { all name of equipments related } ] , }}

Raises:	IpNaoExisteError – IP is not registered. InvalidParameterError – IP identifier is null or invalid. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

get_ipv4_or_ipv6(ip)[source]¶

Get a Ipv4 or Ipv6 by IP

Parameters:	ip – IPv4 or Ipv6. ‘xxx.xxx.xxx.xxx or xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx’
Returns:	Dictionary with the following structure:

{'ips': [{'oct4': < oct4 >, 'oct2': < oct2 >, 'oct3': < oct3 >,
'oct1': < oct1 >, 'version': < version >,
'networkipv4': < networkipv4 >, 'id': < id >, 'descricao': < descricao >}, ... ] }.
or
{'ips': [ {'block1': < block1 >, 'block2': < block2 >, 'block3': < block3 >, 'block4': < block4 >, 'block5': < block5 >, 'block6': < block6 >, 'block7': < block7 >, 'block8': < block8 >,
'version': < version >, 'networkipv6': < networkipv6 >, 'id': < id >, 'descricao': < descricao >}, ... ] }.

Raises:	IpNaoExisteError – Ipv4 or Ipv6 not found. UserNotAuthorizedError – User dont have permission to perform operation. InvalidParameterError – Ip string is none or invalid. XMLError – Networkapi failed to generate the XML response. DataBaseError – Networkapi failed to access the database.

get_ipv6(id_ip)[source]¶

Get IPv6 by id.

Parameters:	id_ip – ID of IPv6.
Returns:	Dictionary with the following structure:

{'ip': {'id': < id >,
'networkipv6': < networkipv6 >,
'block1': < block1 >,
'block2': < block2 >,
'block3': < block3 >,
'block4': < block4 >,
'block5': < block5 >,
'block6': < block6 >,
'block7': < block7 >,
'block8': < block8 >,
'description': < description >,
'equipamentos': [ { all name of equipments related } ] , }}

Raises:	IpNaoExisteError – IP is not registered. InvalidParameterError – IP identifier is null or invalid. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.

save_ipv4(ip4, id_equip, descricao, id_net)[source]¶

Save a IP4 and associate with equipment

Parameters:	ip4 – An IP4 available to save in format x.x.x.x. id_equip – Equipment identifier. Integer value and greater than zero. descricao – IP description. id_net – Network identifier. Integer value and greater than zero.
Returns:	Dictionary with the following structure:

{ ip: { id: <id_ip4>,
oct1: <oct1>,
oct2: <oct2>,
oct3: <oct3>,
oct4: <oct4>,
equipamento: [ { all equipamentos related } ] ,
descricao: <descricao> } }

save_ipv6(ip6, id_equip, descricao, id_net)[source]¶

Save an IP6 and associate with equipment

Parameters:	ip6 – An IP6 available to save in format xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx. id_equip – Equipment identifier. Integer value and greater than zero. descricao – IPv6 description. id_net – Network identifier. Integer value and greater than zero.
Returns:	Dictionary with the following structure:

{'ipv6': {'id': < id >,
'block1': <block1>,
'block2': <block2>,
'block3': <block3>,
'block4': <block4>,
'block5': <block5>,
'block6': <block6>,
'block7': <block7>,
'block8': <block8>,
'descricao': < description >,
'equipamento': [ { all name equipamentos related } ], }}

search_ipv6_environment(ipv6, id_environment)[source]¶

Get IPv6 with an associated environment.

Parameters:	ipv6 – IPv6 address in the format x1:x2:x3:x4:x5:x6:x7:x8. id_environment – Environment identifier. Integer value and greater than zero.
Returns:	Dictionary with the following structure:

{'ipv6': {'id': < id >,
'id_vlan': < id_vlan >,
'bloco1': < bloco1 >,
'bloco2': < bloco2 >,
'bloco3': < bloco3 >,
'bloco4': < bloco4 >,
'bloco5': < bloco5 >,
'bloco6': < bloco6 >,
'bloco7': < bloco7 >,
'bloco8': < bloco8 >,
'descricao': < descricao > }}

Raises:	IpNaoExisteError – IPv6 is not registered or is not associated to the environment. AmbienteNaoExisteError – Environment not found. InvalidParameterError – Environment identifier and/or IPv6 string is/are none or invalid. DataBaseError – Networkapi failed to access the database. XMLError – Networkapi failed to generate the XML response.