Documentation

User Tools

Site Tools

Trace:
extensions:teemip-macaddress-lookup

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-macaddress-lookup [2020/10/31 14:36] – [Features] cnaudextensions:teemip-macaddress-lookup [2023/12/11 14:53] (current) – [MAC Address Lookup] cnaud
Line 1: Line 1:
- ====== MAC Address Lookup ======+{{ picto_macaddresslookup.png}} 
 +====== MAC Address Lookup ======
 ---- dataentry summary ---- ---- dataentry summary ----
 name                : MAC address lookup name                : MAC address lookup
-description_wiki    : Provides information on MAC address vendors +description_wiki    : Provides information on MAC address vendors
 index_hidden        : yes index_hidden        : yes
 level_hidden        : 1 level_hidden        : 1
-version             : 1.0.0 +collector_hidden    : no 
-release_dt          : 2020-10-04 +version             : 3.1.1 
-TeemIp              : 2.6+release_dt          : 2023-12-11 
 +TeemIp              : 3.x 
 +iTop                : 3.x
 code                : teemip-macaddress-lookup code                : teemip-macaddress-lookup
 +localization        : English, French
 state               : stable 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        : IP address, CMDB+keyword_tags        : IP address, CMDB, Network
 dependencies_s      : teemip-ip-mgmt dependencies_s      : teemip-ip-mgmt
-download_wiki       :  +download_wiki       : [[https://sourceforge.net/projects/teemip/files/teemip%20-%20extensions/MAC%20Address%20Lookup/3.1.1/teemip-macaddress-lookup-3.1.1-105.zip/download|teemip-macaddress-lookup-3.1.1-105.zip]] 
-git hub_wiki        : [[https://github.com/TeemIp/teemip-macaddress-lookup|teemip-macaddress-lookup]]+github_wiki         : [[https://github.com/TeemIp/teemip-macaddress-lookup|teemip-macaddress-lookup]] 
 +php-max             : 8.1
 ---- ----
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
 TeemIp's MAC Address Lookup extension allows you to lookup information on a specific MAC address or on the MAC addresses configured on CIs. TeemIp's MAC Address Lookup extension allows you to lookup information on a specific MAC address or on the MAC addresses configured on CIs.
Line 26: Line 40:
  
 ===== Revision History ===== ===== Revision History =====
-^  Version  ^  Release Date  ^  Comments  ^ +^  Version  ^  Release Date  ^  Status  ^  iTop \\ Min  ^  IPAM for iTop \\ Min  ^  Comments  ^ 
-|  1.0.0  |  2020-10-04  | Initial revision |+|  **3.1.1**  |  2023-12-11  |  Supported  |  3.0.0  |  3.0.0  | Add Chinese (simplified) translation | 
 +|  3.1.0  |  2023-04-01  |  Supported  |  3.0.0  |  3.0.0  | Add German translation | 
 +|  3.0.0  |  2022-01-05  |  Obsolete  |  3.0.0  |  3.0.0  | TeemIp / iTop 3.x compatible version - Not compatible with older versions | 
 +|  1.0.1  |  2021-04-01  |  Obsolete  |  2.7.0  |  2.7.0  | Align extension structure with new guidelines | 
 +|  1.0.0  |  2020-10-04  |  Obsolete  |  2.7.0  |  2.7.0  | Initial revision |
  
 ===== Features ===== ===== Features =====
Line 36: Line 54:
   * Company name, address and country   * Company name, address and country
   * Last update   * Last update
 +
 +===== Licensing =====
 +The TeemIp MAC Address Lookup 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 MAC Address Lookup under certain conditions. Read the ’license.txt’ file in the TeemIp distribution. TeemIp MAC Address Lookup is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
 +
 +The extension relies on [[https://maclookup.app/| MACLookup site]] and therfore complies with all related [[https://maclookup.app/terms-and-conditions|Terms and conditions]].
  
 ===== Limitations ===== ===== Limitations =====
 The extension relies on the public web site https://api.maclookup.app/. Therefore, it requires an access to the public Internet from the server hosting TeemIp. The extension relies on the public web site https://api.maclookup.app/. Therefore, it requires an access to the public Internet from the server hosting TeemIp.
 +The 3.0.0 version is not compatible with TeemIp's versions older than the 3.0.0.
 +
 ===== Requirements ===== ===== Requirements =====
 Beside the capability for TeemIp to reach the public Internet (see above), there is no specific requirement with that extension. TeemIp MAC Address Lookup is embedded in TeemIp standalone starting with TeemIp 2.7. Beside the capability for TeemIp to reach the public Internet (see above), there is no specific requirement with that extension. TeemIp MAC Address Lookup is embedded in TeemIp standalone starting with TeemIp 2.7.
Line 55: Line 80:
 ===== MAC Lookup menu ===== ===== MAC Lookup menu =====
  
-Once installed, the extension will alter the IP Management menu by adding a sub menu group under the Tools section. +Once installed, the extension will alter the IP Management menu by adding the sub menu "MAC Lookup" to the Tools section.  
 + 
 +{{ details_menu_maclookup3x.png }} 
 + 
 +Clicking on this menu will open the following form where either a MAC address or a MAC address prefix can be entered. 
 + 
 +{{ maclookup-form3x.png }} 
 + 
 +When the form is applied, a lookup request is sent to the [[https://maclookup.app/| MACLookup site]] through its standard API. Answer is then processed and displayed within TeemIp's main interface. 
 + 
 +{{ maclookup-output-from-form3x.png }} 
 + 
 +==== Output parameters ==== 
 +All parameters contained in MACLookup answer are described in [[https://maclookup.app/api-v2/documentation| MACLookup documentation page]]. Main ones are: 
 +  
 +^  Parameter  ^  Description  ^  Comment  ^ 
 +| Prefix | Prefix of the MAC addres | | 
 +| Block start | Start MAC range | | 
 +| Block end | End MAC range | | 
 +| Block size | Number of possible unique MAC for this prefix  | | 
 +| Block type | Assignment Type \\ * MA-L: MAC Address Block Large (previously named OUI). Number of address 2exp24 (~16 Million) \\ * MA-M: MAC Address Block Medium. Number of address 2exp20 (~1 Million) \\ * MA-S: MAC Address Block Small (previously named OUI-36, encompasses IAB Assignments). Number of address 2exp12 (4096) \\ * CID: Company Identifier. This prefix will not be used for globally unique applications. Number of address 2exp24 (~16 Million) | | 
 +| Company | Company name  | | 
 +| Address | Company address  | | 
 +| Country | Company country  | | 
 +| Random | This MAC can be transmitted when a device is not associated with an access point. In this case, it can be considered randomized | Optional | 
 +| Private | The company prevents their name and address from showing up in the public listing | Optional | 
 + 
 + 
 +===== MAC Lookup from CIs ===== 
 +When the details of a CI are displayed, an analysis is done to check if the CI has at least one MAC address attribute (of class "AttributeMacAddress") and if, at least, one of these CI's MAC addresses are set. If this is the case, then the "MAC Address Lookup" menu is displayed in the "Other Actions" menu group.  
 + 
 + 
 +{{ details_otheractions_maclookup3x.png }} 
 + 
 +If MAC Address Lookup is triggered, then, here as well, a lookup request is sent to the [[https://maclookup.app/| MACLookup site]] through its standard API and answer is displayed within the CI's context. 
  
-{{ details_menu_maclookup.png }} 
  
--- FIXME -- +{{ maclookup-output-from-ci3x.png }}
-Documentation to be completed.+
extensions/teemip-macaddress-lookup.1604151374.txt.gz · Last modified: 2020/10/31 14:36 by cnaud

Page Tools