networkapi.api_network.facade.v3 package¶

Submodules¶

networkapi.api_network.facade.v3.networkv4 module¶

networkapi.api_network.facade.v3.networkv4.create_networkipv4(networkv4, user, force=False)[source]¶: Creates a NetworkIPv4.

networkapi.api_network.facade.v3.networkv4.delete_networkipv4(network_ids, user, force=False)[source]¶: Deletes a list of NetworkIPv4.

networkapi.api_network.facade.v3.networkv4.deploy_networkipv4(network_id, user)[source]¶

Loads template for creating Network IPv4 equipment configuration, creates file and apply config.

Parameters:	network_id – NetworkIPv4 Id

Returns: List with status of equipments output

networkapi.api_network.facade.v3.networkv4.get_dict_v4_to_use_in_configuration_deploy(user, networkipv4, equipment_list)[source]¶

Generate dictionary with vlan an IP information to be used to generate template dict for equipment configuration

Args: networkipv4 NetworkIPv4 object equipment_list: Equipamento objects list

Returns: 2-dimension dictionary with equipments information for template: rendering

networkapi.api_network.facade.v3.networkv4.get_networkipv4_by_id(network_id)[source]¶: Get NetworkIPv4.

networkapi.api_network.facade.v3.networkv4.get_networkipv4_by_ids(network_ids)[source]¶: Get Many NetworkIPv4.

networkapi.api_network.facade.v3.networkv4.get_networkipv4_by_search(search={})[source]¶: Get List of NetworkIPv4 by Search.

networkapi.api_network.facade.v3.networkv4.undeploy_networkipv4(network_id, user, force=False)[source]¶

Loads template for removing Network IPv4 equipment configuration, creates file and apply config.

Parameters:	network_id – NetworkIPv4 Id

Returns: List with status of equipments output

networkapi.api_network.facade.v3.networkv4.update_networkipv4(networkv4, user, force=False)[source]¶: Updates a NetworkIPv4.

networkapi.api_network.facade.v3.networkv6 module¶

networkapi.api_network.facade.v3.networkv6.create_networkipv6(networkv6, user, force=False)[source]¶: Creates a NetworkIPv6.

networkapi.api_network.facade.v3.networkv6.delete_networkipv6(network_ids, user, force=False)[source]¶: Deletes a list of NetworkIPv6.

networkapi.api_network.facade.v3.networkv6.deploy_networkipv6(network_id, user)[source]¶

Loads template for creating Network IPv6 equipment configuration, creates file and apply config.

Args: NetworkIPv6 object Equipamento objects list

Returns: List with status of equipments output

networkapi.api_network.facade.v3.networkv6.get_dict_v6_to_use_in_configuration_deploy(user, networkipv6, equipment_list)[source]¶

Generate dictionary with vlan an IP information to be used to generate template dict for equipment configuration

Args: networkipv4 NetworkIPv4 object equipment_list: Equipamento objects list

Returns: 2-dimension dictionary with equipments information for template: rendering

networkapi.api_network.facade.v3.networkv6.get_networkipv6_by_id(network_id)[source]¶: Get NetworkIPv6.

networkapi.api_network.facade.v3.networkv6.get_networkipv6_by_ids(network_ids)[source]¶: Get Many NetworkIPv6.

networkapi.api_network.facade.v3.networkv6.get_networkipv6_by_search(search={})[source]¶: Get List of NetworkIPv6 by Search.

networkapi.api_network.facade.v3.networkv6.undeploy_networkipv6(network_id, user)[source]¶

Loads template for removing Network IPv6 equipment configuration, creates file and apply config.

Args: NetworkIPv6 object Equipamento objects list

Returns: List with status of equipments output

networkapi.api_network.facade.v3.networkv6.update_networkipv6(networkv6, user, force=False)[source]¶: Updates a NetworkIPv6.

networkapi.api_network.facade.v3.utils module¶

networkapi.api_network.facade.v3.utils.generate_config_file(dict_ips, equipment, template_type)[source]¶

Load a template and write a file with the rended output.

Args: 2-dimension dictionary with equipments information for template: rendering equipment to render template to template type to load.

Returns: filename with relative path to settings.TFTPBOOT_FILES_PATH

networkapi.api_network.facade.v3.utils.generate_template_dict(dict_ips, equipment)[source]¶

Creates a 1-dimension dictionary from a 2 dimension with equipment information.

Args: dict_ips dictionary for template rendering equipment to create dictionary to

Returns: 1-dimension dictionary to use in template rendering for equipment

networkapi.api_network.facade.v3.utils.has_active_network_in_vlan(vlan)[source]¶

Check if there are any other active network in the vlan this is used because some equipments remove all the L3 config when applying some commands, so they can only be applyed at the first time or to remove interface vlan configuration

Parameters:	vlan – vlan object
Returns:	True of False

networkapi.api_network.facade.v3.utils.load_template_file(equipment, template_type)[source]¶

Load template file with specific type related to equipment.

Args: equipment: Equipamento object template_type: Type of template to be loaded

Returns: template string

networkapi.api_network.facade.v3.utils.remove_svi(equipment, vlan_num)[source]¶: Call function “remove_svi” of Plugin for model of equipment.

Module contents¶

networkapi.api_network.facade.v3.get_networkipv4_by_id(network_id)[source]¶: Get NetworkIPv4.

networkapi.api_network.facade.v3.get_networkipv4_by_ids(network_ids)[source]¶: Get Many NetworkIPv4.

networkapi.api_network.facade.v3.get_networkipv4_by_search(search={})[source]¶: Get List of NetworkIPv4 by Search.

networkapi.api_network.facade.v3.create_networkipv4(networkv4, user, force=False)[source]¶: Creates a NetworkIPv4.

networkapi.api_network.facade.v3.update_networkipv4(networkv4, user, force=False)[source]¶: Updates a NetworkIPv4.

networkapi.api_network.facade.v3.delete_networkipv4(network_ids, user, force=False)[source]¶: Deletes a list of NetworkIPv4.

networkapi.api_network.facade.v3.undeploy_networkipv4(network_id, user, force=False)[source]¶

Loads template for removing Network IPv4 equipment configuration, creates file and apply config.

Parameters:	network_id – NetworkIPv4 Id

Returns: List with status of equipments output

networkapi.api_network.facade.v3.deploy_networkipv4(network_id, user)[source]¶

Loads template for creating Network IPv4 equipment configuration, creates file and apply config.

Parameters:	network_id – NetworkIPv4 Id

Returns: List with status of equipments output

networkapi.api_network.facade.v3.get_networkipv6_by_id(network_id)[source]¶: Get NetworkIPv6.

networkapi.api_network.facade.v3.get_networkipv6_by_ids(network_ids)[source]¶: Get Many NetworkIPv6.

networkapi.api_network.facade.v3.get_networkipv6_by_search(search={})[source]¶: Get List of NetworkIPv6 by Search.

networkapi.api_network.facade.v3.create_networkipv6(networkv6, user, force=False)[source]¶: Creates a NetworkIPv6.

networkapi.api_network.facade.v3.update_networkipv6(networkv6, user, force=False)[source]¶: Updates a NetworkIPv6.

networkapi.api_network.facade.v3.delete_networkipv6(network_ids, user, force=False)[source]¶: Deletes a list of NetworkIPv6.

networkapi.api_network.facade.v3.undeploy_networkipv6(network_id, user)[source]¶

Loads template for removing Network IPv6 equipment configuration, creates file and apply config.

Args: NetworkIPv6 object Equipamento objects list

Returns: List with status of equipments output

networkapi.api_network.facade.v3.deploy_networkipv6(network_id, user)[source]¶

Loads template for creating Network IPv6 equipment configuration, creates file and apply config.

Args: NetworkIPv6 object Equipamento objects list

Returns: List with status of equipments output