Documentation

User Tools

Site Tools

Trace:
2_x:datamodel:ip-addresses

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
2_x:datamodel:ip-addresses [2023/10/03 11:54] – [Links between IP Addresses and CIs] cnaud2_x:datamodel:ip-addresses [2024/07/26 11:23] (current) – [Automation] cnaud
Line 39: Line 39:
   * **Reserved**: IP is not in use yet but will be allocated (activated) at a point in time. It can be allocated from the IP detail menu but is invisible from the CI edition menu.   * **Reserved**: IP is not in use yet but will be allocated (activated) at a point in time. It can be allocated from the IP detail menu but is invisible from the CI edition menu.
   * **Unassigned**: IP exists in TeemIp without any clear status and can be allocated or reserved.   * **Unassigned**: IP exists in TeemIp without any clear status and can be allocated or reserved.
 +
 +If [[extensions:teemip-ip-discovery|IP Discovery Datamodel extension]] is installed, versions 3.2.0 and above bring the additional status **Discovered** to the IPObject class and therefore to the IP Addresses. This value may be set by the [[collectors:teemip-ip-discovery-collector|IP Discovery Data collector]] to newly discovered IPs and changed afterwards by the Hostmaster.
 </note> </note>
  
Line 79: Line 81:
 By definition, FQDNs are absolute domain names. They specify the exact location of domain names in the tree hierarchy of the Domain Name System (DNS). This is why they end up with a dot.\\ By definition, FQDNs are absolute domain names. They specify the exact location of domain names in the tree hierarchy of the Domain Name System (DNS). This is why they end up with a dot.\\
 \\ \\
 +According to configuration parameter **Allow Duplicate Names**, unicity of the FQDN is checked:
 +  * Duplicates may exist in different organizations,
 +  * Within an organization, duplicates may exist in different [[extensions:teemip-zone-mgmt#views|DNS views]],
 +  * If parameter is set to:
 +    * **No**, all other cases of duplicates are rejected, 
 +    * **Dual stack**, duplicates may exist between IPv4 and IPv6 spaces,
 +    * **Yes**, unicity of FQDN is not verified.
 +
 According to configuration parameter **Compute FQDN when short name is empty**, the FQDN may be computed regardless the content of the Short Name and DNS Domain. According to configuration parameter **Compute FQDN when short name is empty**, the FQDN may be computed regardless the content of the Short Name and DNS Domain.
 </note> </note>
Line 91: Line 101:
 For v6 IPs, a simple autocompletion mechanism is used to help typing the IP: its first 64 bits are copied from the subnet IP… which can, of course, be manually changed by the user.  For v6 IPs, a simple autocompletion mechanism is used to help typing the IP: its first 64 bits are copied from the subnet IP… which can, of course, be manually changed by the user. 
 </note> </note>
-==== Modify an IP Address ====+==== Modifying an IP Address ====
 From the detailed view of an IP Address, click on the {{pen-icon.png?nolink|Edit icon}} button. From the detailed view of an IP Address, click on the {{pen-icon.png?nolink|Edit icon}} button.
  
Line 97: Line 107:
  
 ==== Navigating between adjacent IPs ==== ==== Navigating between adjacent IPs ====
-FIXME+TeemIp provides an easy and efficient way to navigate between adjacent IPs. If the action is enabled, the left and rights arrows of the object menu {{navigate-icon.png?nolink|Navigate icon}} will bring you to the previous or next registered IP in TeemIp. This action is driven by default parameters that can be overwritten in the configuration file. 
 + 
 +<code> 
 + 'teemip-ip-mgmt' => array ( 
 + ... 
 + 'ip_navigation' => array ( 
 +   'enabled' => true, 
 +   'within_subnet_only' => false, 
 + ), 
 +                ... 
 +        ), 
 + 
 +</code> 
 + 
 +^  Parameter  ^  Description  ^ 
 +| enabled| Enable or disable the function | 
 +| within_subnet_only| Limit the navigation to the subnet that the IP belongs to or not |
 ==== Other Actions ==== ==== Other Actions ====
 Next to standard actions, a set of specific actions can be applied to IP Addresses. These can be found in the **Other Actions** menu available from the details page. Next to standard actions, a set of specific actions can be applied to IP Addresses. These can be found in the **Other Actions** menu available from the details page.
Line 152: Line 178:
 This action will just delete all resource records linked to the IP. This action will just delete all resource records linked to the IP.
  
-===== Links between IP Addresses and CIs =====+====== Links between IP Addresses and CIs ======
 TeemIp has been designed to provide a comprehensive modelization and documentation of the link(s) that a CI and an IP address may share together.  TeemIp has been designed to provide a comprehensive modelization and documentation of the link(s) that a CI and an IP address may share together. 
  
Line 198: Line 224:
  
 ==== Releasing IPs ==== ==== Releasing IPs ====
-When an IP is set to the status "Released", it is automatically removed from all CIs and all interfaces.+When an IP is set to the status "Released", it is removed from all CIs and all interfaces if IP Setting **Detach released IPs from CIs** is set to Yes (which is the default setting). 
 + 
 +==== Automation ==== 
 +When linking an IP together with a CI, one must insure that both the CI's and the IP's status are consistent. TeemIp may automatically and periodically check the status of IPs and their coherency with the CIs they are attached to, if any. This behaviour is driven by a set of parameters defined in [[2_x:datamodel:ip-settings|Global IP Settings]]. For any given organization, should the configuration parameter... : 
 + 
 +   * **Allocate IPs attached to production CIs** (*) be set to **Yes**, TeemIp will make sure that IPs attached to CIs are "Allocated". 
 +   * **Release IPs from CIs that become obsolete** (*) be set to **Yes**, TeemIp will release all IPs that are still allocated to obsolete CIs, 
 +   * **Un-allocate IPs that are not attached to a CI** (*) be set to **Yes**, TeemIp will unassign the IPs that are no longer attached to a CI, 
 +   * **Release IPs from subnets that are released** be set to **Yes**, TeemIp will release all IPs that belong to released subnets, 
 +   * **Allow attachment of already allocated IPs to CIs** be set to **Yes**, TeemIp will allow, from the CI details screen, the attachment of an allocated IP to a CI. 
 +   * **Detach released IPs from CIs** be set to **Yes**, TeemIp will detach IPs which status moves to "Released" from all CIs. This does not include interfaces for which released IPs are always detached.   
 + 
 +The 3 first actions (*) are handled by background tasks which default parameters can be overwritten in the configuration file.  
 + 
 +<code> 
 + 'teemip-ip-mgmt' => array ( 
 + ... 
 + 'ip_allocate_on_ci_status' => array ( 
 +   'enabled' => true, 
 +   'debug' => true, 
 +   'periodicity' => 3600, 
 +   'status_list' => array ( 
 +     0 => 'implementation', 
 +     1 => 'production', 
 +   ), 
 + ), 
 + 'ip_release_on_ci_status' => array ( 
 +   'enabled' => true, 
 +   'debug' => true, 
 +   'periodicity' => 3600, 
 +   'status_list' => array ( 
 +     0 => 'obsolete', 
 +   ), 
 + ), 
 + 'ip_unassign_on_no_ci' => array ( 
 +   'enabled' => true, 
 +   'debug' => true, 
 +   'periodicity' => 3600, 
 +   'target_status' => 'unassigned', 
 + ), 
 +                ... 
 + ), 
 + 
 +</code>
  
-==== Continuous IP status coherency check ==== +^  Parameter  ^  Description  ^ 
-TeemIp may automatically and periodically check the status of IPs and their coherency with the CIs they are attached to, if any. This behaviour is driven by a set of parameters defined in [[2_x:datamodel:ip-settings|Global IP Settings]]. For any given organization, should the configuration parameter... : +| enabled| Enable or disable the function | 
-   * **Allocate IPs attached to production CIs** be set, TeemIp will make sure that IPs attached to CIs are "Allocated". +| debug | Add verbosity to the process | 
-   * **Release IPs from CIs that become obsolete** be set, TeemIp will release all IPs that are still allocated to obsolete CIs, +| periodicity | Periodicity of the background task | 
-   * **Release IPs from subnets that are released** be set, TeemIp will release all IPs that belong to released subnets.+| status_list | List of status that trigger the action | 
 +| target_status | Status of the IP once the action is done |
  
 +Please, refer to the [[2_x:datamodel:configuration|Configuration File]] chapter for further details.
2_x/datamodel/ip-addresses.1696326851.txt.gz · Last modified: 2023/10/03 11:54 by cnaud

Page Tools