Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Network ======
The Network Management module is a mandatory module of TeemIP. It groups the CIs that are closely linked to network: existing ones that are inherited from iTop (Network interfaces and VLANs) and new ones available in TeemIP only (WAN links, DNS domains, AS numbers...).

Overview of all CIs that belong to the module are displayed under from the **Network** submenu of the standard **CMDB overview** menu.

{{ overview_group_network3x.png }}


===== Network Interface =====
{{icons8-globe-cable.png  }} 
Five types of network interfaces can be defined: **fiber channels**, **physical** or **logical** interfaces, **virtual interfaces** for network devices and **aggregate links**


=== Creating a new Network Interface ===
In the Overview menu of the Configuration Management module, find the Network group and click on "Create a new Network Interface". Then select the interface type in the form below:

{{ classcreate_networkinterface3x.png }}


==== Fiber Channel Interface ====
{{icons8-globe-fiber.png  }} 
A Fiber Channel Interface, is a network interface to a high-speed network technology primarily used for connecting shared storage devices (Storage Systems in TeemIP).

=== Fiber Channel Interface Properties ===
^  Name  ^  Type  ^  Mandatory?  ^
| **General Information** |||
| Name | Alphanumeric string | Yes |
| Status | Possible values: Active, Inactive | No |
| Device | Foreign key to a(n) Datacenter Device | Yes |
| **More Information** |||
| Speed | Decimal value (could be negative) | No |
| Topology | Alphanumeric string | No |
| WWN | Alphanumeric string | No |

=== Creating a new Fiber Channel Interface ===
Once Fiber Channel interface is selected in the interface type selection box, click apply to display the creation form:

{{ classcreate_fiberchannelinterface3x.png }}


==== Logical Interface ====
{{icons8-globe-cable.png  }}
A network interface for a Virtual Machine.

=== Logical Interface Properties ===
^  Name  ^  Type  ^  Mandatory?  ^
| **General Information** |||
| Name | Alphanumeric string | Yes |
| Status | Possible values: Active, Inactive | No |
| Virtual machine | Foreign key to a(n) Virtual Machine | Yes |
| Comment | Multiline character string | No |
| **More Information** |||
| MAC address | Formated alphanumeric string | No |
| Speed | Foreign key to a(n) Interface Speed \\ Brought by the [[extensions:teemip-network-mgmt-extended|Network Management Extended]] extension  | No |
| Protocol | Foreign key to a(n) Layer 2 Protocol \\ Brought by the [[extensions:teemip-network-mgmt-extended|Network Management Extended]] extension  | No |

<note tip>
MAC address can be entered following 01:23:45:67:89:ab or 01-23-45-67-89-ab or 0123.4567.89ab format but is displayed according to choice made in Global IP Settings for the organization.
</note>

<note> 
TeemIp replaces the IP Address field that appears in iTop data model by a list of IPs that may contain several pointers to IPs defined in TeemIP data model. The list appears in the following tab.
</note>

<note important>
IPs can be attached to an interface regardless their status, even already allocated. This is to reflect the situation where, for instance, an IP address is set on different router interfaces.
</note>

=== Tabs ===
^  Tab  ^  Description  ^
| VLANs | VLANs that the interface is connected to |
| VRFs | VRFs that the interface is connected to |
| IP Addresses | IP Addresses (v4 or v6) that are hosted on the interface |

There is no limitation in the number of IPv4s and / or IPv6s that a logical interface can host.

=== Displaying a Logical Interface ===
In a list of logical interfaces, select the one you are interested in:

{{ classdetails_virtualinterface3x.png }}


==== Physical Interface ====
{{icons8-globe-wire.png  }}
A physical network interface on a physical server, as opposed to virtual interfaces that are defined at the software level either in operating systems or virtual machines.

=== Physical Interface Properties ===
^  Name  ^  Type  ^  Mandatory?  ^
| **General Information** |||
| Name | Alphanumeric string | Yes |
| Status | Possible values: Active, Inactive, Obsolete, Stock | No |
| Device | Foreign key to a(n) Connectable CI | Yes |
| Comment | Multiline character string | No |
| **Wiring Information** |||
| Please, refer to the [[extensions:teemip-cable-mgmt|Cable Management]] extension |||
| **More Information** |||
| MAC address | Formated alphanumeric string | No |
| Speed | Foreign key to a(n) Interface Speed \\ Brought by the [[extensions:teemip-network-mgmt-extended|Network Management Extended]] extension | No |
| Protocol | Foreign key to a(n) Layer 2 Protocol \\ Brought by the [[extensions:teemip-network-mgmt-extended|Network Management Extended]] extension | No |


<note tip>
MAC address can be entered following 01:23:45:67:89:ab or 01-23-45-67-89-ab or 0123.4567.89ab format but is displayed according to choice made in Global IP Settings for the organization.
</note>

<note>
TeemIP replaces the IP Address field that appears in iTop data model by a list of IPs that may contain several pointers to IPs defined in TeemIP data model. The list appears in the following tab.
</note>

<note important>
IPs can be attached to an interface regardless their status, even if already allocated. This is to reflect the situation where, for instance, an IP address is set on different router interfaces.
</note>

=== Tabs ===
^  Tab  ^  Description  ^
| VLANs | VLANs to which this interface is connected |
| VRFs | VRFs to which this interface is connected |
| IP Addresses | IP Addresses (v4 or v6) that are hosted on the interface |
| Cable | Cable connected to the interface \\ Brought by the [[extensions:teemip-cable-mgmt|Cable Management]] extension |

There is no limitation in the number of IPv4s and / or IPv6s that a logical interface can host.

=== Creating a new Physical Interface ===
Once Physical interface is selected in the interface type selection box, click apply to display the creation form:

{{ classcreate_physicalinterface3x.png }}

==== Network Device Virtual Interface ====
{{icons8-globe-ndvi.png  }}
A virtual interface on a (physical) network devices. This type of interface coexists with physical interfaces on such devices.

=== Physical Interface Properties ===
^  Name  ^  Type  ^  Mandatory?  ^
| **General Information** |||
| Name | Alphanumeric string | Yes |
| Status | Possible values: Active, Inactive, Obsolete, Stock | No |
| Network Device | Foreign key to a(n) Network Device | Yes |
| Comment | Multiline character string | No |
| **More Information** |||
| MAC address | Formated alphanumeric string | No |
| Speed | Foreign key to a(n) Interface Speed \\ Brought by the [[extensions:teemip-network-mgmt-extended|Network Management Extended]] extension | No |
| Protocol | Foreign key to a(n) Layer 2 Protocol \\ Brought by the [[extensions:teemip-network-mgmt-extended|Network Management Extended]] extension | No |

<note tip>
MAC address can be entered following 01:23:45:67:89:ab or 01-23-45-67-89-ab or 0123.4567.89ab format but is displayed according to choice made in Global IP Settings for the organization.
</note>

<note important>
IPs can be attached to an interface regardless their status, even if already allocated. This is to reflect the situation where, for instance, an IP address is set on different router interfaces.
</note>

=== Tabs ===
^  Tab  ^  Description  ^
| VLANs | VLANs to which this interface is connected |
| VRFs | VRFs to which this interface is connected |
| IP Addresses | IP Addresses (v4 or v6) that are hosted on the interface |

There is no limitation in the number of IPv4s and / or IPv6s that a network device virtual interface can host.

=== Displaying a Network Device Virtual Interface ===
In a list of Network Device Virtual Interface, select the one yo are interested in.

{{ classcreate_networkdevicevirtualinterface3x.png }}



===== VLAN =====
{{icons8-hierarchy.png  }} 
A Virtual LAN is used to group together in a logical way networks Subnets and Physical Interfaces that participate in the same VLAN.

=== VLAN Properties ===
^  Name  ^  Type  ^  Mandatory?  ^
| Tag | Integer | Yes |
| Name | Alphanumeric string | No |
| Organization | Foreign key to a(n) Organization | Yes |
| Status | Possible values: Reserved, Unused, Used | Yes |
| Type | Possible values: MAC address based, Network based, Port based, Protocol based | Yes |
| Description | Multiline character string | No |

=== Tabs ===
^  Tab  ^  Description  ^
| Subnets | Subnets (v4 or v6) which are part of this VLAN |
| Physical network interfaces | Physical interfaces which are part of this VLAN |
| Logical network interfaces | Logical interfaces which are part of this VLAN |
| Network device virtual interfaces | Network device virtual interfaces which are part of this VLAN |
| Interfaces' IPs | IPs of all logical and physical interfaces attached to the VLAN |

=== Displaying a VLAN ===
In the **Networking** overview of the **Configuration Management** module, list the VLANs from the dedicated badge and select the item that you are interested in.

{{ classdetails_vlan-3x.png }}



===== WAN Link =====
{{icons8-line-48.png  }} 
Wide Area Network links are used to connect remote locations together. 

=== WAN Link Properties ===
^  Name  ^  Type  ^  Mandatory?  ^
| **General Information** |||
| Name | Alphanumeric string | Yes |
| Organization | Foreign key to a(n) Organization | Yes | 
| Status| Possible values: implementation, obsolete, production, stock  | No |
| Description | Multiline character string  | No |
| **Administrative Information** |||
| Carrier | Foreign key to a(n) Organization | No |
| Carrier Reference| Alphanumeric string | No |
| Internal Reference| Alphanumeric string | No |
| **Locations** |||
| Location #1 | Foreign key to a(n) Location  | No|
| Location #2 | Foreign key to a(n) Location  | No |
| **Network Information** |||
| Type | Foreign key to a(n) WAN Type | No|
| Rate | Alphanumeric string | No |
| Burst Rate | Alphanumeric string | No |
| Underlying Rate | Alphanumeric string | No |
| Network interface #1 | Foreign key to a(n) Network Interface | No |
| Network interface #2 | Foreign key to a(n) Network Interface  | No |
| **Date Information** |||
| Order date | Date (year-month-day) | No |
| Move to production date | Date (year-month-day) | No |
| Renewal date | Date (year-month-day) | No |
| Decommissioning date | Date (year-month-day) | No |

=== Tabs ===
^  Tab  ^  Description  ^
| Contacts | All the contacts for this configuration item |
| Documents | All the documents linked to this configuration item |
| Application solutions |All the application solutions for this configuration item |
| Active Tickets | All the tickets for this configuration item  |

=== Displaying a WAN Link ===
In the **Networking** overview of the **Configuration Management** module, list the WAN links from the dedicated badge and select the item that you are interested in
{{ classdisplay_wanlink-3x.png }}


===== Domain =====
{{icons8-active-directory-48.png  }} 
This class modelizes the well known domains from the Domain Name Service. 

=== Domain Properties ===
^  Name  ^  Type  ^  Mandatory?  ^
| **General Information** |||
| Organization | Foreign key to a(n) Organization | Yes |
| Delegated from | Foreign key to a(n) Organization | No |
| Parent | Foreign key to a(n) Domain| No |
| Name | Alphanumeric string | Yes |
| Description | Alphanumeric string  | No |
| Requestor | Foreign key to a(n) Person | No |
| Release date | Date (year-month-day) | No |
| **Administrative Information** |||
| Internet Registrar | Foreign key to a(n) Organization | No |
| Start date | Date (year-month-day) | No |
| End date | Date (year-month-day) | No |
| Renewal | Possible values: automatic, manual, non applicable | No |

=== Tabs ===
^  Tab  ^  Description  ^
| Hosts | Hosts that belong to the domain (see detail below) |
| Child domains | All sub domains directly below in the domain tree |
| Related Zones | All the zones related to the domain |

=== Listing Domains ===
The Domain badge available in the **Networking** overview or the shortcut under the **DNS Management** menu display all the domains of the selected organization or all domains registered in the application if no organization is selected.

{{ classlist_domain-3x.png }}

<note tip>
The Search tab will shorten the list according to the filtering elements you'll define in it.
</note>

=== Displaying Tree ===
Display can be switched from the listing view to tree view through the **Display Tree** action in the **Other Actions** menu.

When no default organization is selected, a tree per existing organization is displayed. Otherwise, only the tree that corresponds to the selected organization is displayed.

{{ classtree_domain-3x.png }}

Display can be switched back to the listing view through the **Display List** action available in the **Other Actions** menu.

{{ details-popup-menu-subnetdisplaylist-3x.png }}

=== Displaying a Domain ===
From the list or the tree view, just click on the item that you are interested in:

{{ classdetails_domain-3x.png }}

The **Hosts** tab displays the hosts that are directly or indirectly attached to the domain. Three filters can be applied to that list. Display may contain:
  * the hosts that belong to the domain and its children,
  * the hosts attached to child domains only,
  * the hosts directly attached to the domain only
These filters are selected directly in the Hosts tab:

{{ classdetails_domain_hosts_tab-3x.png }}

=== Delegate ===
A domain belonging to an organization can be delegated to another organization. This can only be done if the domain already exists. Delegation is not available at creation time. Conditions to delegate a domain are:
  * The domain doesn't contain any host nor sub-domain,
  * The domain is not associated to a DNS zone.

By default, a domain can only be delegated to a child organization. However, this restriction can be lifted by the **Delegate domains to children organizations only** parameter defined in the [[2_x:datamodel:ip-settings|Global IP Settings]].


In order to delegate a domain, click on the **Delegate** action of the **Other Actions** menu. The following display appears:

{{ classdelegate_domain-3x.png }}

If all delegation conditions are met, domain is effectively delegated once the **Apply** button is pressed.


=== Un-Delegate ===
A delegated domain can be returned to its original owner organization with the **Un-delegate** action. Condition to remove a delegation on a domain is that the domain has **no** host, **no** sub-domain and **no** zone associated zone. If these conditions are met, delegation is removed straight away.

===== AS Number =====
{{icons8-connect-48.png  }} 
Autonomous System (AS) Number used by various routing protocols.

=== AS Number Properties ===
^  Name  ^  Type  ^  Mandatory?  ^
| **General Information** |||
| Name | Alphanumeric string | Yes |
| Number | Alphanumeric string  | No |
| Organization | Foreign key to a(n) Organization | Yes | 
| Description | Multiline character string  | No |
| **Adlinistrative Information** |||
| Registrar | Foreign key to a(n) Organization | No |
| Whois | Absolute or relative URL as a text string | No|
| Registration date | Date (year-month-day)  | No |
| End date | Date (year-month-day)  | No |
| Renewal date | Date (year-month-day)  | No |

=== Tabs ===
^  Tab  ^  Description  ^
| Contacts | All the contacts for this configuration item |
| Documents | All the documents linked to this configuration item |
| Active Tickets | All the tickets for this configuration item  |

=== Creating a new AS Number ===
In the **Networking overview** of the **Configuration Management** module, click on the {{plus-button.png?nolink|Edit icon}} of the **AS Number** badge to display the creation form. 

{{ classcreate_asnumber-3x.png }}


===== VRF =====
{{icons8-router-48.png  }} 
These items modelize VRF (Virtual Routing and Forwarding) objects used within routing protocols.

=== VRF Properties ===
^  Name  ^  Type  ^  Mandatory?  ^
| **General Information** |||
| Organization | Foreign key to a(n) Organization | Yes | 
| Name | Alphanumeric string | Yes |
| Description | Multiline character string  | No |
| Route Distinguisher| Alphanumeric string  | No |
| Route Target| Alphanumeric string | No|

=== Tabs ===
^  Tab  ^  Description  ^
| Subnets | All the subnets attached to this configuration item |
| Physical network interfaces | Physical network interfaces attached to the VRF |
| Logical network interfaces | Logical interfaces attached to the VRF | 
| Interfaces' IPs | IPs of all logical and physical interfaces attached to the VRF |
| Active Tickets | All the tickets for this VRF  |

=== Creating a new VRF ===
In the **Networking** overview of the **Configuration Management** module, list the VRFs from the dedicated badge and select the item that you are interested in.

{{ classdisplay_vrf-3x.png }}
Documentation

User Tools

Site Tools

Page Tools
