User Tools

Site Tools


extensions:teemip-dhcp-mgmt

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
extensions:teemip-dhcp-mgmt [2020/05/14 10:46] – [Data entry] cnaudextensions:teemip-dhcp-mgmt [2024/03/22 14:07] (current) – [Revision History] cnaud
Line 1: Line 1:
 +{{ picto_dhcpmanagement.png}} 
 ====== DHCP Management ====== ====== DHCP Management ======
 ---- dataentry summary ---- ---- dataentry summary ----
Line 5: Line 6:
 index_hidden        : yes index_hidden        : yes
 level_hidden        : 1 level_hidden        : 1
-version             : 0.1.1 +collector_hidden    : no 
-release_dt          : 2018-11-30 +version             : 3.1.1 
-TeemIp              : 2.3+release_dt          : 2023-12-11 
 +TeemIp              : 3.1+ 
 +iTop                : 3.x
 code                : teemip-dhcp-mgmt code                : teemip-dhcp-mgmt
-state               : pilot+localization        : English, French, German 
 +state               : stable
 diffusion_hidden    : TeemIp wiki diffusion_hidden    : TeemIp wiki
-product_hidden      : included (standalone)+product_hidden      : Included
 module-lists_hidden :  module-lists_hidden : 
 keyword_tags        : dhcp keyword_tags        : dhcp
-dependencies_s      : teemip-ip-mgmt, teemip-ipv6-mgmt, teemip-network-mgmt +dependencies_s      : teemip-framework, teemip-ip-mgmt, teemip-ipv6-mgmt 
-download_wiki       : [[https://sourceforge.net/projects/teemip/files/teemip%20-%20extensions/DHCP%20Management/0.1.1/teemip-dhcp-mgmt-0.1.1-427.zip/download|teemip-dhcp-mgmt-0.1.1-427.zip]]+download_wiki       : [[https://sourceforge.net/projects/teemip/files/teemip%20-%20extensions/DHCP%20Management/3.1.1/teemip-dhcp-mgmt-3.1.1-604.zip/download|teemip-dhcp-mgmt-3.1.1-604.zip]] 
 +github_wiki         : [[https://github.com/TeemIp/teemip-dhcp-mgmt|teemip-dhcp-mgmt]] 
 +php-max             : 8.1
 ---- ----
 +
 +
  
  
Line 27: Line 35:
 </note> </note>
 ===== Revision History ===== ===== Revision History =====
-^  Version  ^  Release Date  ^  Comments +^  Version  ^  Release Date   Status  ^  iTop \\ Min  ^  IPAM for iTop \\ Min   Comments  ^ 
-|  0.1.1  |  2019-01-29  | Corrects presentation issue | +|  **3.1.1**  |  2023-12-11  |  Supported  |  3.0.0  |  3.1.0  | Add Chinese (simplified) translation | 
-|  0.1.0  |  2018-11-30  | Initial revision |+|  3.1.0  |  2023-06-21  |  Supported  |  3.0.0  |  3.1.0  | XML structure has moved to 3x | 
 +|  3.0.1  |  2022-09-09  |  Obsolete  |  2.7.0  |  3.0.1  | Adopt 3.x icon style \\ Enhance overview menu \\ Add DHCP options tab to linked CIs | 
 +|  3.0.0  |  2022-01-05  |  Obsolete  |  2.7.0  |  3.0.0  |Adapt to 3.0 and review the menu structure | 
 +|  0.2.1  |  2021-04-01  |  Obsolete  |  2.7.0  |  2.7.1  | Align extension structure to new guidelines | 
 +|  0.2.0  |  2020-11-08  |  Obsolete  |  2.7.0  |  2.7.0  | Add DHCP options tab on DHCP pools | 
 +|  0.1.1  |  2019-01-29   Obsolete  |  2.7.0  |  2.6.0  | Corrects presentation issue | 
 +|  0.1.0  |  2018-11-30   Obsolete  |  2.7.0  |  2.6.0  | Initial revision |
  
 ===== Features ===== ===== Features =====
Line 45: Line 59:
 | Host | PhysicalDevice | No | | Host | PhysicalDevice | No |
  
-Once registered in the application, these options can be retrieved through the REST/JSON API in order to build the configuration file of an ISC DHCP server.+Once registered in the application, these options can be retrieved through the REST/JSON API in order to build the dhcpd.conf configuration file of an ISC DHCP server. 
 + 
 +===== Licensing ===== 
 +The TeemIp DHCP Management extension is licensed under the terms of the GNU Affero General Public License Version 3 as published by the Free Software Foundation. This gives you legal permission to copy, distribute and/or modify TeemIp DHCP Management under certain conditions. Read the ’license.txt’ file in the TeemIp distribution. TeemIp DHCP Management is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE. 
 + 
 ===== Limitations ===== ===== Limitations =====
 The extension just allows DHCP Managers to store DHCP Options within TeemIp. It doesn't handle scope or server configuration. The extension just allows DHCP Managers to store DHCP Options within TeemIp. It doesn't handle scope or server configuration.
Line 51: Line 70:
 There is no specific requirements with TeemIp standalone. TeemIp DHCP Management is anyway already embedded in it starting with TeemIp 2.4. There is no specific requirements with TeemIp standalone. TeemIp DHCP Management is anyway already embedded in it starting with TeemIp 2.4.
  
-When installed on an iTop application, make sure that 'IPAM for iTopis installed as well.+When installed on an iTop application, make sure that [[extensions:teemip-core-ip-mgmt|IPAM for iTop]] is installed as well.
  
 ===== Installation ===== ===== Installation =====
 Installation on a TeemIp standalone is done with the application itself, through the setup. Installation on a TeemIp standalone is done with the application itself, through the setup.
  
-When adding the module on an iTop application, the process will depends on the iTop version: +When adding the module on an iTop application, use the [[https://wiki.openitop.org/doku.php?id=extensions:installation|Standard installation process]] for extensions
-  * For iTop 2.4.0 and higher, use the new [[https://wiki.openitop.org/doku.php?id=extensions:installation|Standard installation process]]. +
-  * For iTop versions older than 2.3.x, use the [[https://wiki.openitop.org/doku.php?id=extensions:installation#itop_before_240|Special installation process]].+
 ===== Configuration ===== ===== Configuration =====
 No specific configuration is required for this extension. No specific configuration is required for this extension.
 ===== DHCP Management Menu ===== ===== DHCP Management Menu =====
-Once installed, the module will add a menu group called DHCP Management where DHCP Options will be managed from.+Once installed, the extension will add a menu group called DHCP Management where DHCP Options will be managed from.
  
-{{ details_menu_dhcpmgmt.png }}+{{ details_menu_dhcpmgmt3x.png}} 
 + 
 +<note warning> 
 +The DHCP management menu is hidden to the users that don't have the **administrator** profile, the **DHCP manager** profile or r/w privileges on the DHCP Options. 
 +</note> 
 + 
 +The DHCP Space menu provides some information on the DHCP infrastucture and summarizes the different registered options under 7 badges: 
 + 
 +{{ dashboard_dhcpmgmt3x.PNG?869x593 }} 
 + 
 + 
 +===== Infrastructure ===== 
 +The infrastructure dashlets list: 
 +  * the servers that act as DHCP servers, 
 +  * the IP pools flaged as DHCP ranges.
  
-The DHCP Space menu summarizes the different registered options under 7 badges: 
-  * Global DHCP Option 
-  * Shared Network DHCP Option 
-  * Subnet DHCP Option 
-  * Pool DHCP Option 
-  * Class DHCP Option 
-  * SubClass DHCP Option 
-  * Host DHCP Option 
-  
-{{ dashboard_dhcpmgmt.PNG }} 
  
 ===== DHCP options ===== ===== DHCP options =====
Line 92: Line 114:
    
 ==== Global Options ==== ==== Global Options ====
-{{classicon_globaloption.png  }} +{{icons8-city-buildings-48.png  }} 
 This object is used to document the Global DHCP Options. It has no other attributes than the ones listed above. This object is used to document the Global DHCP Options. It has no other attributes than the ones listed above.
  
Line 98: Line 120:
 Details of a DHCP Global Option can be accessed from the specific "Global Options" shortcut menu of the DHCP Management module. Details of a DHCP Global Option can be accessed from the specific "Global Options" shortcut menu of the DHCP Management module.
  
-{{ classdetails_globaloption.png }}+{{ classdetails_globaloption3x.png?930*378 }}
  
 ==== Shared Network Options ==== ==== Shared Network Options ====
-{{classicon_sharednetworkoption.png  }} +{{icons8-hierarchy.png  }} 
 This object is used to document the Shared Network DHCP Options. Shared networks in TeemIp are implemented through the VLAN object. This object is used to document the Shared Network DHCP Options. Shared networks in TeemIp are implemented through the VLAN object.
  
Line 112: Line 134:
 A new DHCP Shared Network Option may be created from the specific “Shared Network Options” shortcut menu of the DHCP Management module. It refers to an organization and to a VLAN within that organization. A new DHCP Shared Network Option may be created from the specific “Shared Network Options” shortcut menu of the DHCP Management module. It refers to an organization and to a VLAN within that organization.
  
-{{ classcreate_sharednetworkoption.png }}+{{ classcreate_sharednetworkoption3x.png?920*378 }}
  
 ==== Subnet Options ==== ==== Subnet Options ====
-{{classicon_subnetoption.png  }} +{{icons8-subnet-48.png  }} 
 This object is used to document the Subnet DHCP Options. The Subnet scope in TeemIp is implemented through the IP Subnet object. This object is used to document the Subnet DHCP Options. The Subnet scope in TeemIp is implemented through the IP Subnet object.
  
Line 126: Line 148:
 Details of a DHCP Subnet Option can be accessed from the specific “Subnet Options” shortcut menu of the DHCP Management module. It refers to an organization and to an IP Subnet within that organization. Details of a DHCP Subnet Option can be accessed from the specific “Subnet Options” shortcut menu of the DHCP Management module. It refers to an organization and to an IP Subnet within that organization.
  
-{{ classdetails_subnetoption.png }}+{{ classdetails_subnetoption3x.png?917*356 }}
  
 ==== Pool Options ==== ==== Pool Options ====
-{{classicon_pooloption.png  }} +{{icons8-slice-48.png  }} 
 This object is used to document the Pool DHCP Options. The Pool scope in TeemIp is implemented through the IP Range object. This object is used to document the Pool DHCP Options. The Pool scope in TeemIp is implemented through the IP Range object.
  
Line 135: Line 157:
 Next to all common attributes listed above: Next to all common attributes listed above:
 ^  Name  ^  Type  ^  Mandatory?  ^ ^  Name  ^  Type  ^  Mandatory?  ^
-Subnet| Foreign key to a(n) IP Range | Yes |+IP Range | Foreign key to a(n) IP Range | Yes |
  
 === Details === === Details ===
 Details of a DHCP Pool Option can be accessed from the specific “Pool Options” shortcut menu of the DHCP Management module. It refers to an organization and to an IP Range within that organization. Details of a DHCP Pool Option can be accessed from the specific “Pool Options” shortcut menu of the DHCP Management module. It refers to an organization and to an IP Range within that organization.
  
-{{ classdetails_pooloption.png }}+{{ classdetails_pooloption3x.png?921*352 }}
  
 ==== Class Options ==== ==== Class Options ====
-{{classicon_classoption.png  }} +{{icons8-folder-48.png  }} 
 This object is used to document the Class DHCP Options. It refers to a new typological TeemIp object that models DHCP classes. This object is used to document the Class DHCP Options. It refers to a new typological TeemIp object that models DHCP classes.
  
 === DHCP Class object === === DHCP Class object ===
 This is a typological object defined through the Typology configuration menu in the Data administration chapter. This is a typological object defined through the Typology configuration menu in the Data administration chapter.
-{{ classdetails_class.png }}+ 
 +{{ classdetails_class3x.png?917*147 }}
  
 === Properties === === Properties ===
 Next to all common attributes listed above: Next to all common attributes listed above:
 ^  Name  ^  Type  ^  Mandatory?  ^ ^  Name  ^  Type  ^  Mandatory?  ^
-Subnet| Foreign key to a(n) DHCP Class | Yes |+Class | Foreign key to a(n) DHCP Class | Yes |
  
 === Details === === Details ===
 A new DHCP Class Option may be created from the specific “Class Options” shortcut menu of the DHCP Management module. It refers to an organization and to a DHCP Class. A new DHCP Class Option may be created from the specific “Class Options” shortcut menu of the DHCP Management module. It refers to an organization and to a DHCP Class.
  
-{{ classcreate_classoption.png }}+{{ classcreate_classoption3x.png?923*514 }}
  
 ==== Sub Class Options ==== ==== Sub Class Options ====
-{{classicon_subclassoption.png  }} +{{icons8-file-submodule-48.png  }} 
 This object is used to document the SubClass DHCP Options. It refers to a new typological TeemIp object that models DHCP sub-classes. This object is used to document the SubClass DHCP Options. It refers to a new typological TeemIp object that models DHCP sub-classes.
  
 === DHCP SubClass object === === DHCP SubClass object ===
 This is another typological object defined through the Typology configuration menu of the Data administration chapter. This is another typological object defined through the Typology configuration menu of the Data administration chapter.
-{{ classdetails_subclass.png }}+ 
 +{{ classdetails_subclass3x.png?917*147 }}
  
 === Properties === === Properties ===
 Next to all common attributes listed above: Next to all common attributes listed above:
 ^  Name  ^  Type  ^  Mandatory?  ^ ^  Name  ^  Type  ^  Mandatory?  ^
-Subnet| Foreign key to a(n) DHCP SubClass | Yes |+Class | Foreign key to a(n) DHCP Class | Yes | 
 +| SubClass | Foreign key to a(n) DHCP SubClass | Yes |
  
 === Details === === Details ===
 Details of a DHCP SubClass Option can be accessed from the specific “SubClass Options” shortcut menu of the DHCP Management module. It refers to an organization and to a DHCP SubClass. Details of a DHCP SubClass Option can be accessed from the specific “SubClass Options” shortcut menu of the DHCP Management module. It refers to an organization and to a DHCP SubClass.
  
-{{ classdetails_subclassoption.png }}+{{ classdetails_subclassoption3x.png?924*358 }}
  
 ==== Host Options ==== ==== Host Options ====
-{{classicon_hostoption.png  }} +{{classicon_server.png  }} 
 This object is used to document the Host DHCP Options. The Host scope in TeemIp is implemented through the Physical Device object.  This object is used to document the Host DHCP Options. The Host scope in TeemIp is implemented through the Physical Device object. 
  
Line 185: Line 210:
 Next to all common attributes listed above: Next to all common attributes listed above:
 ^  Name  ^  Type  ^  Mandatory?  ^ ^  Name  ^  Type  ^  Mandatory?  ^
-Subnet| Foreign key to a(n) Physical Device | Yes |+Host | Foreign key to a(n) Physical Device | Yes |
  
 === Details === === Details ===
 Details of a DHCP Hosts Option can be accessed from the specific “Host Options” shortcut menu of the DHCP Management module. It refers to an organization and to a Physical Device within that organization. Details of a DHCP Hosts Option can be accessed from the specific “Host Options” shortcut menu of the DHCP Management module. It refers to an organization and to a Physical Device within that organization.
  
-{{ classdetails_hostoption.png }}+{{ classdetails_hostoption3x.png?919*356 }} 
 + 
 +===== DHCP Options tabs on CIs ===== 
 +A "DHCP Options" tab has been added to IP Ranges, IP Subnets and VLANs in order to list the options that are directly attached to them. 
 +The same tab has been added to the Physical devices that have an IP but for them, the tab is visible **only** with **Administrator** and **DHCP Manager** profiles. Aim of this restriction is to not pollute the display to profiles that don't need such information,
 + 
 +{{classdetails_dhcpvlan3x.png?800*320 }}{{ classdetails_dhcpipsubnet3x.png?800*320}} 
 + 
 + 
 +{{classdetails_dhcpiprange3x.png?800*320 }}{{ classdetails_dhcpphysicaldevice3x.png?800*320}} 
  
 ===== User Profiles ===== ===== User Profiles =====
 The TeemIp DHCP Management extension brings a new profile dedicated to the management of DHCP objects: "DHCP Manager", a "Person handling the DHCP space". It has all rights on the DHCP related objects.  The TeemIp DHCP Management extension brings a new profile dedicated to the management of DHCP objects: "DHCP Manager", a "Person handling the DHCP space". It has all rights on the DHCP related objects. 
  
-{{ classdetails_DHCPprofile.png }}+{{ classdetails_DHCPprofile3x.png?923*48 }}
  
-This profile extends capabilities and must be used together with other profiles like ConfigurationManager.+This profile extends capabilities and must be used together with other profiles like Configuration Manager.
  
-<note warning> +===== Questions & Answers =====
-The DHCP management menu is hidden to the users that don't have the administrator or the DHCP manager profile. +
-</note>+
  
 +**Question: How can I document static leases in a DHCP pool?** \\
 +Answer: Best practice is to create an IP with the "Reserved" status for each static lease that needs to be registered.
  
  
  
extensions/teemip-dhcp-mgmt.1589446006.txt.gz · Last modified: 2020/05/14 10:46 by cnaud