Differences

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

--- 2_x:datamodel:ip-addresses [2023/10/03 12:38] – [Navigating between adjacent IPs] cnaud
+++ 2_x:datamodel:ip-addresses [2026/01/21 15:51] (current) – [Automation] cnaud
@@ Line 35: / Line 35: @@
 <note important>
 The attribute "Status" is more than informative. It does have an impact on what can and cannot be done with an IP. Meanings of different values are:
-  * **Allocated**: IP is in use and potentially allocated to a CI. It cannot be allocated to another CI without being released or unassigned first unless the IP Setting **Allow attachement of already allocated IPs to CIs** is set to **Yes**.
+  * **Allocated**: IP is in use and potentially attached to a CI or an interface. It cannot be attached to another CI without being released or unassigned first unless the IP Setting **Allow attachement of already allocated IPs to CIs** is set to **Yes**.
-  * **Released**: IP is not in use anymore and can be re-allocated if required
+  * **Released**: IP is not in use anymore and doesn't ping. It and can be re-allocated or reserved if required
   * **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 and pings but it is not attached to a CI or an interface. It 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>
@@ 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.\\
 \\
+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.
 </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.
 </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.
@@ Line 176: / Line 186: @@
   * IPs that are in state Allocated cannot be set as IP attribute unless IP setting **Allow attachment of already allocated IPs to CIs** is set to **Yes**,
   * Reserved IPs are... reserved,
-  * Once a CI is created or updated, the status of its attached IP is automatically changed to Allocated,
+  * Once a CI is created or updated, the status of its attached IP is automatically changed to **Allocated**,
-  * If a Management IP is removed from the CI, its status becomes Unassigned unless it is still linked to another CI.
+  * If a Management IP is removed from the CI, its status becomes **Released** unless it is still linked to another CI.
 Some others CIs, like IP interfaces attached to routers, may host several IP addresses. For them:
   * One or more IPs (with no limitation of quantity) can be attached to them,
   * An IP can be attached to them, regardless their status,
-  * Once an interface is created or updated, the status of its attached IPs is automatically changed to Allocated,
+  * Once an interface is created or updated, the status of its attached IPs is automatically changed to **Allocated**,
-  * If a link with an IP address is removed, status of IP moves back to Unassigned unless it is still linked to another CI.
+  * If a link with an IP address is removed, status of IP moves back to **Released** unless it is still linked to another CI.
 <note important>
@@ Line 214: / Line 224: @@
 ==== 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".
+   * **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,
+   * **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 not 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 (
+=> 'implementation',
+=> 'production',
+		  ),
+		),
+		'ip_release_on_ci_status' => array (
+		  'enabled' => true,
+		  'debug' => true,
+		  'periodicity' => 3600,
+		  'status_list' => array (
+=> 'obsolete',
+		  ),
+		),
+		'ip_unassign_on_no_ci' => array (
+		  'enabled' => true,
+		  'debug' => true,
+		  'periodicity' => 3600,
+		  'target_status' => 'unassigned',
+		),
+                ...
+	),
+</code>
+^  Parameter  ^  Description  ^
+| enabled| Enable or disable the function |
+| debug | Add verbosity to the process |
+| periodicity | Periodicity of the background task |
+| 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.

Documentation

User Tools

Site Tools

Differences

Page Tools