This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
2_x:datamodel:ip-settings [2022/12/12 17:35] – [IP Watermarks] cnaud | 2_x:datamodel:ip-settings [2023/09/15 21:32] – cnaud | ||
---|---|---|---|
Line 3: | Line 3: | ||
* Global IP Settings host the parameters that are specific to an organization, | * Global IP Settings host the parameters that are specific to an organization, | ||
* The general configuration file defines parameters that drive TeemIp' | * The general configuration file defines parameters that drive TeemIp' | ||
- | |||
- | |||
- | |||
- | |||
===== Global IP Setting ===== | ===== Global IP Setting ===== | ||
Line 50: | Line 46: | ||
| **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 |
+ | | 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 80: | Line 77: | ||
When the Global IP Setting is automatically created, parameters are set with the default values defined in TeemIp' | When the Global IP Setting is automatically created, parameters are set with the default values defined in TeemIp' | ||
- | ===== Configuration File ===== | ||
- | The standard General Configuration file that can be reached under the Configuration menu may host parameters for TeemIp. If any, these will be grouped within the " | ||
- | |||
- | < | ||
- | ' | ||
- | ' | ||
- | ... | ||
- | ), | ||
- | ... | ||
- | ' | ||
- | ... | ||
- | ), | ||
- | ), | ||
- | </ | ||
- | |||
- | The following chapters describe the different features available. | ||
- | |||
- | ==== Default Global IP Settings ==== | ||
- | This block is used to overwrite the default TeemIp parameters defined in the data model. It contains sub-blocks of parameters dedicated to the different TeemIp extensions and a general attribute to enable or disable the whole block. All the parameters defined [[2_x: | ||
- | |||
- | The structure of the block is as follows: | ||
- | |||
- | |||
- | ^ Name ^ Type ^ Allowed values | ||
- | | enabled | Boolean | true, false | | ||
- | | **core_parameters** ||| | ||
- | | ... | All attributes that do not belong to a Teemip extension ||| | ||
- | | **ip_request_parameters** ||| | ||
- | | ... | All attributes defined in [[extensions: | ||
- | | **zone_parameters** ||| | ||
- | | ... | All attributes defined in [[extensions: | ||
- | |||
- | In the following example, only parameter ' | ||
- | |||
- | < | ||
- | ' | ||
- | ' | ||
- | ' | ||
- | array ( | ||
- | ' | ||
- | ), | ||
- | ), | ||
- | |||
- | </ | ||
- | |||
- | ==== IP Address Navigation ==== | ||
- | This block defines how one can navigate between adjacent IPs, a feature described in the [[2_x: | ||
- | |||
- | ^ Name ^ Type ^ Allowed values | ||
- | | enabled | Boolean | true, false | Enable the block | | ||
- | | within_subnet_only | Boolean | true, false | Limit the navigation within the subnet the IP belongs to | | ||
- | |||
- | Example: | ||
- | |||
- | < | ||
- | ' | ||
- | ' | ||
- | ' | ||
- | ), | ||
- | </ | ||
- | |||
- | ==== Automatic IP Release ==== | ||
- | TeemIp may periodically look for IPs that are attached to obsolete CIs and make sure they are in the " | ||
- | |||
- | ^ Name ^ Type ^ Allowed values | ||
- | | 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 | | ||
- | | 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 released | | ||
- | |||
- | |||
- | < | ||
- | ' | ||
- | ' | ||
- | ' | ||
- | ' | ||
- | ' | ||
- | array ( | ||
- | 0 => ' | ||
- | ), | ||
- | ), | ||
- | </ | ||
- | |||
- | |||
- | ==== Automatic IP Allocation ==== | ||
- | TeemIp may periodically look for IPs that are attached to implementation or production CIs and make sure they are in the " | ||
- | |||
- | ^ Name ^ Type ^ Allowed values | ||
- | | 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 | | ||
- | | 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 | | ||
- | |||
- | < | ||
- | ' | ||
- | ' | ||
- | ' | ||
- | ' | ||
- | ' | ||
- | array ( | ||
- | 0 => ' | ||
- | 1 => ' | ||
- | ), | ||
- | ), | ||
- | </ | ||
- | ==== Automatic IP Un-assignment ==== | ||
- | TeemIp may periodically look for IPs that are **not** attached to any CIs and make sure they are in the " | ||
- | |||
- | ^ Name ^ Type ^ Allowed values | ||
- | | 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 | IP Address status | Any IP address status | Defines the status that an IP must have when not attached to a CI | | ||
- | |||
- | < | ||
- | ' | ||
- | ' | ||
- | ' | ||
- | ' | ||
- | ' | ||
- | ), | ||
- | </ | ||
- | ==== IP Watermarks ==== | ||
- | 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 ' | ||
- | ^ Name ^ Type ^ Allowed values | ||
- | | 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 | | ||
- | |||
- | < | ||
- | ' | ||
- | ' | ||
- | ' | ||
- | ' | ||
- | ' | ||
- | array ( | ||
- | 0 => ' | ||
- | 1 => ' | ||
- | ), | ||
- | ), | ||
- | </ |