Documentation

User Tools

Site Tools

Trace:
2_x:datamodel:ip-settings

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
Next revisionBoth sides next revision
2_x:datamodel:ip-settings [2022/12/12 17:14] – [Automatic IP Allocation] cnaud2_x:datamodel:ip-settings [2023/09/15 15:36] – [Automatic IP Release] cnaud
Line 50: Line 50:
 | **Domain Information** ||||| | **Domain Information** |||||
 | Delegate domains to children organizations only | Boolean | Yes / No | No | | | Delegate domains to children organizations only | Boolean | Yes / No | No | |
-| Automatically update DNS records | Boolean | Yes / No | No | DNS Zone Management |+| Automatically update DNS records | Boolean | Yse / No | No | DNS Zone Management | 
 +| Remove DNS records from obsolete IPs | Boolean | Yes / No | No | DNS Zone Management |
 | **Other information**||||| | **Other information**|||||
 | MAC Address Output Format | Enum | Colons / Hyphens / Dots | Colons | | | MAC Address Output Format | Enum | Colons / Hyphens / Dots | Colons | |
Line 142: Line 143:
  
 ==== Automatic IP Release ==== ==== Automatic IP Release ====
-TeemIp may periodically look for IPs that are attached to obsolete CIs and make sure they are in the "released" status. The behaviour of that feature is defined in a specific configuration block and is driven by the following parameters:+TeemIp may periodically look for IPs that are attached to obsolete CIs and make sure they are in the "released" status. The behaviour of that feature is defined in the specific 'ip_release_on_ci_status' configuration block and is driven by the following parameters:
  
 ^  Name  ^  Type  ^  Allowed values  ^ Description ^ ^  Name  ^  Type  ^  Allowed values  ^ Description ^
Line 148: Line 149:
 | debug | Boolean | true, false | Activate verbosity within the process |  | debug | Boolean | true, false | Activate verbosity within the process | 
 | periodicity | Number | Any integer | Defines the periodicity of the task | | periodicity | Number | Any integer | Defines the periodicity of the task |
-| status_list | List of CI statuses | List of valid statuses for the CIs | Defines the CI statuses under which the CI should be considered as obsolete |+| status_list | Array | List of valid statuses for the CIs | Defines the CI statuses under which the IP should be considered as released |
  
  
Line 163: Line 164:
 </code> </code>
  
 +<note important>
 +By default, the process is disabled both **globally** and at the **Global IP settings** level !
 +</note>
  
 ==== Automatic IP Allocation ==== ==== Automatic IP Allocation ====
-TeemIp may periodically look for IPs that are attached to implementation or production CIs and make sure they are in the "allocated" status. The behaviour of that feature is defined in a specific configuration block and is driven by the following parameters:+TeemIp may periodically look for IPs that are attached to implementation or production CIs and make sure they are in the "allocated" status. The behaviour of that feature is defined in the specific 'ip_allocate_on_ci_status' configuration block and is driven by the following parameters:
  
 ^  Name  ^  Type  ^  Allowed values  ^ Description ^ ^  Name  ^  Type  ^  Allowed values  ^ Description ^
Line 171: Line 175:
 | debug | Boolean | true, false | Activate verbosity within the process |  | debug | Boolean | true, false | Activate verbosity within the process | 
 | periodicity | Number | Any integer | Defines the periodicity of the task | | periodicity | Number | Any integer | Defines the periodicity of the task |
-| status_list | List of CI statuses | List of valid statuses for the CIs | Defines the CI statuses under which the IP should be considered as allocated |+| status_list | Array | List of valid statuses for the CIs | Defines the CI statuses under which the IP should be considered as allocated |
  
 <code> <code>
Line 186: Line 190:
 </code> </code>
 ==== Automatic IP Un-assignment ==== ==== Automatic IP Un-assignment ====
-FIXME+TeemIp may periodically look for IPs that are **not** attached to any CIs and make sure they are in the "unassigned" status. The behaviour of that feature is defined in the specific 'ip_unassign_on_no_ci' configuration block and is driven by the following parameters:
  
 +^  Name  ^  Type  ^  Allowed values  ^ Description ^
 +| enabled | Boolean | true, false | Enable the process |
 +| debug | Boolean | true, false | Activate verbosity within the process | 
 +| periodicity | Number | Any integer | Defines the periodicity of the task |
 +| target_status | Array | Any IP address status | Defines the status that an IP must have when not attached to a CI |
 +
 +<code>
 + 'ip_unassign_on_no_ci' => array (
 +   'enabled' => false,
 +   'debug' => false,
 +   'periodicity' => 3600,
 +   'target_status' => 'unassigned',
 + ),
 +</code>
 ==== IP Watermarks ==== ==== IP Watermarks ====
-FIXME+Capacity planning in TeemIp is done on the fly i.e. when an IP address is added or removed to or from an IP Range or subnet. It can be done as well through a background task which behaviour is defined in the specific 'handle_ip_watermarks' configuration block and is driven by the following parameters: 
 + 
 +^  Name  ^  Type  ^  Allowed values  ^ Description ^ 
 +| enabled | Boolean | true, false | Enable the process | 
 +| debug | Boolean | true, false | Activate verbosity within the process |  
 +| periodicity | Number | Any integer | Defines the periodicity of the task | 
 +| target_classes | Array | List of IP classes | Defines the list of IP classes which the capacity planning applies to | 
 +  
 +<code> 
 + 'handle_ip_watermarks' => array ( 
 +   'enabled' => false, 
 +   'debug' => false, 
 +   'periodicity' => 86400, 
 +   'target_classes' =>  
 +   array ( 
 +     0 => 'IPv4Subnet', 
 +     1 => 'IPv4Range', 
 +   ), 
 + ), 
 +</code>
2_x/datamodel/ip-settings.txt · Last modified: 2024/06/25 14:19 by cnaud

Page Tools