Internal Errigal Collaboration Wiki

User Tools

Site Tools

Trace:
Writing /app/www/public/data/meta/onboarding/snmpmanager/network_element_fields_-_the_basics.meta failed
onboarding:snmpmanager:network_element_fields_-_the_basics

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
onboarding:snmpmanager:network_element_fields_-_the_basics [2017/05/26 15:56] – mmcconboarding:snmpmanager:network_element_fields_-_the_basics [2021/06/25 10:09] (current) – external edit 127.0.0.1
Line 1: Line 1:
 +====== Network Element Fields ======
 +
 +Author: Cathal O'Keeffe & Michelle McCausland
 +
 +===== Introduction =====
 +
 +The network element table is used to store all of the nodes, hubs and carriers available.
 +
 +The table has over 60 columns, but we have identified the more important tables in the following sections.
 +
 +----
 +
 +===== ID =====
 +
 +This field contains the unique identifier of the network element e.g. 14253.
 +
 +It can be used to quickly identify a network element from the database:
 +
 +<code>SELECT * FROM snmp_manager.network_element WHERE id = 12345;</code>
 +
 +These values are auto-populated by the database and should not be changed by the user.
 +
 +----
 +
 +===== Network Identifier =====
 + 
 +The network identifier field is used to group network elements together based on some identifying feature. 
 +
 +The name is usually formed by the Region initials + State initials + Area Description + Carrier. 
 +
 +e.g. Network Identifier NE-NY-BRKLNCTR-VZW refers to North East Region,  New York, Brooklyn and Carrier Verizon Wireless
 +
 +<code>SELECT DISTINCT(network_identifier) from network_element;</code>
 +
 +----
 +
 +===== Name =====
 + 
 +This field contains the name of the network element. This field is used in a variety of places to easily identify a network element for example: in reports, in the node monitor / EMS.
 +
 +----
 +===== Name in Trap =====
 + 
 +
 +----
 +===== Discovered Name =====
 +
 +This field is used by the alarm sync to determine which alarm on the controller belongs to which network element in the database.
 +
 +It is important to ensure this value matches that of the name field in the network element table.
 +
 +Currently (June 17) the discovered_name field can only be updated via the database. 
 +
 +----
 +
 +===== NE Type =====
 +
 +
 +The network element type table contains the list of network element types. 
 +
 +See [[onboarding:snmpmanager:network_element_topology_overview_and_types|Network Element topology overview and types]] for more detail on the network element topology structure.
 +
 +{{ :onboarding:snmpmanager:netype.png?nolink | }}
 +
 +**Fields to note:**
 +    * network_element_type - This field refers to the name of the network element type.
 +    * is_das_hub - This field contains a boolean value denoting if the network element type is hub level.
 +    * is_das_node - This field contains a boolean value denoting if the network element type is node level.
 +    * exportable - This field contains a boolean value denoting if this network element type is included on an exported load sheet. As you can see from the screenshot above, all items are exportable. However, in some configurations modem / router types are set to exportable = false.
 +
 +
 +<code>SELECT DISTINCT(ne_type) from network_element</code>
 +
 +----
 +
 +===== Class =====
 +
 +Similar to the ne_type field, the class field defines the type of network element.
 +
 +This value refers to the domain class in the codebase.
 +
 +Values for class can be:
 +
 +  * **com.errigal.snmpmanager.knowledge.DasNode**   
 +Network elements of type 'Node', 'Extension Unit', 'mNET', 'Small Cell', 'UPS', 'WIFI',  and  'n/a'   have this class.
 +
 +  * **com.errigal.snmpmanager.knowledge.DasHub**   
 +Network elements of type 'Controller'(Often called Hubs) have this class
 +
 +  * **com.errigal.snmpmanager.NetworkElement** 
 +Network elements that werent defined either as DasHub or DasNode have this class. Network Elements of type 'CUSTOMER-NETWORK' or hosts have this class.
 +  
 +
 +----
 +
 +===== Carrier =====
 +
 +----
 +
 +===== Parent ID =====
 +
 +This field contains the id of the parent element to this network element.
 +
 +It refers to Network Element table itself. 
 +
 +If the element is a Node, its parent will be a Hub. 
 +
 +If a the element is a Hub, its parent will be a carrier. 
 +
 +If the Element is a Carrier, the parent will be "Root"(ID 1)
 +
 +----
 +
 +===== IP address  =====
 +
 +This field contains the IP address of the network element. 
 +
 +This value is unique and is the field used to determine from which network element a trap comes from. 
 +
 +You can use the ip address to manually log into the controller equipment.
 +
 +Usually only Hub elements will have an IP address. 
 +
 +It is important not to place any port numbers or “https:” information in this field as it is not required.
 +
 +----
 +
 +===== Network =====
 +
 +This field contains the name of the carrier associated with the network element.
 +
 +----
 +  
 +===== Technology =====
 +
 +This field contains the technology name associated with the network element.
 +
 +**Note**: for a more accurate representation of the technology please use the assigned_technology_id which links to the technology table.
 +
 +It is important this value is entered correctly to ensure correct functioning of alarm sync and other sync functionality in the EMS application.
 +
 +----
 +
 +===== On Air =====
 +
 +This boolean value denotes if a network element is on air or off air.
 +
 +Off-air elements do not generate alarms/tickets.
 +
 +<code>SELECT COUNT(*) FROM snmp_manager.network_element WHERE on_air=1;</code>
 +
 +----
 +
 +===== Show In monitor =====
 +
 +This boolean value denotes whether or not the element should be shown in the node monitor.
 +
 +Items that are show_in_monitor = 0 (false) do not appear in the node monitor or in the Noc Portal.
 +
 +It is usually a good idea to filter show_in_monitor = 0 elements out of your reports (i.e. do not include them) unless specified by the customer.
 +
 +<code>SELECT COUNT(*) FROM snmp_manager.network_element WHERE show_in_monitor=0;</code>
 +
 +----
 +
 +===== Map Details ID =====
 +
 +This id value is a foreign key linked to the map_details table.
 +
 +The Map Details table contains the network element's geographic location ( Latitude and Longitude ).
 +
 +<code>SELECT * FROM map_details WHERE id = 1234;</code>
 +
 +----
 +
 +
 +===== Address Details ID =====
 +
 +This id value is a foreign key linked to the address_details table.
 +
 +The Address Details table contains the network element's address information ( Street Address and Jurisdiction).
 +
 +<code>SELECT * FROM address_details WHERE id = 1234;</code>
 +
 +----
 +
 +===== System Type ID =====
 +
 +This id value is a foreign key linked to the system_type table.
 +
 +The system type identifies each network_element as being Indoor, Outdoor, IP Only, etc
 +
 +On ATC Production, the system_type_id is used for billing purposes, so please do not alter system_type_id or edit/delete system types without approval
 +
 +----
 +
 +===== Access Info and Additional Info =====
 +
 +This value usually contains information regarding how to access the equipment on site. 
 +
 +e.g. //"To access the area, use password 123 at the gate and then ask for John Connor"//
 +
  

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki