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
2_x:datamodel:ip-settings [2023/04/13 15:45] – [Global IP Settings Properties] cnaud2_x:datamodel:ip-settings [2024/07/24 16:06] (current) – [Global IP Settings Properties] 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's generic behaviour and enables the default value of Global IP Settings parameters to be overwritten.   * The general configuration file defines parameters that drive TeemIp's generic behaviour and enables the default value of Global IP Settings parameters to be overwritten.
- 
- 
- 
- 
  
 ===== Global IP Setting ===== ===== Global IP Setting =====
Line 19: Line 15:
  
 ^  Name  ^  Type  ^  Allowed values  ^  Default value  ^  Extension  ^ ^  Name  ^  Type  ^  Allowed values  ^  Default value  ^  Extension  ^
-| **Default Settings for IP Requests** |||| IP Request Management | +| **Default Settings for IP Requests** |||| [[extensions:teemip-request-mgmt|IP Request Management]] | 
-| Offset for the creation of IPs within IPv4 subnets | Number | Any | 0 | IP Request Management | +| Offset for the creation of IPs within IPv4 subnets | Number | Any | 0 | [[extensions:teemip-request-mgmt|IP Request Management]] | 
-| Offset for the creation of IPs within IPv6 subnets | Number | Any | 0 | IP Request Management |+| Offset for the creation of IPs within IPv6 subnets | Number | Any | 0 | [[extensions:teemip-request-mgmt|IP Request Management]] |
 | **Default Settings for Subnet Blocks** ||||| | **Default Settings for Subnet Blocks** |||||
 | Minimum size of IPv4 Subnet Blocks | Number | > 1 | 256 | | | Minimum size of IPv4 Subnet Blocks | Number | > 1 | 256 | |
Line 39: Line 35:
 | IP Range High Water Mark (%) | Percentage | 0 - 100 | 80 | | | IP Range High Water Mark (%) | Percentage | 0 - 100 | 80 | |
 | **Default Settings for IPs** ||||| | **Default Settings for IPs** |||||
-| Allow Duplicate Names | Boolean | Yes / No | No | |+| Allow Duplicate Names | Boolean | Yes / Dual stack / No | No | |
 | Ping IP before assigning it ? | Boolean | Yes / No | No  || | Ping IP before assigning it ? | Boolean | Yes / No | No  ||
 | Symetrical IP NAT | Boolean | Yes / No | No | | | Symetrical IP NAT | Boolean | Yes / No | No | |
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 | Yse / No | No | DNS Zone Management | +| Automatically update DNS records | Boolean | Yes / No | No | [[extensions:teemip-zone-mgmt|DNS Zone Management]] | 
-| Remove DNS records from obsolete IPs | Boolean | Yes / No | No | DNS Zone Management | +| Remove DNS records from obsolete IPs | Boolean | Yes / No | No | [[extensions:teemip-zone-mgmt|DNS Zone Management]] | 
-| **Other information**|||||+| Serial update method | Enum | Increment by one / \\ Date, in ISO 8601 basic format, followed by a two-digit counter / \\ Date expressed as the number of seconds since the UNIX epoch | Increment by one | [[extensions:teemip-zone-mgmt|DNS Zone Management]] | 
 +| **Other Settings**||||| 
 +| Allow attachment of already allocated IPs to CIs | Boolean | Yes / No | No | | 
 +| Detach released IPs from CIs | Boolean | Yes / No | Yes | |
 | MAC Address Output Format | Enum | Colons / Hyphens / Dots | Colons | | | MAC Address Output Format | Enum | Colons / Hyphens / Dots | Colons | |
  
Line 70: Line 69:
  
 ==== Creating a new Global IP Settings ==== ==== Creating a new Global IP Settings ====
-From the listing view, click on the “New…” menu to display the creation form. +From the listing view, click on the {{plus-button.png?nolink|Edit icon}} to display the creation form. 
  
-{{ classcreate_globalipsettings3x.png }} 
  
 ==== Modifying Global IP Settings ==== ==== Modifying Global IP Settings ====
-From the detailed view of a Global IP Setting, click on the “Modify” button. Basically, all parameters can be changed here but, of course, the organization.+From the detailed view of a Global IP Setting, click on the {{pen-icon.png?nolink|Edit icon}} button. Basically, all parameters can be changed here but, of course, the organization.
  
 ==== Automatic creation ==== ==== Automatic creation ====
Line 81: Line 80:
  
 When the Global IP Setting is automatically created, parameters are set with the default values defined in TeemIp's data model. It is however possible to overload these default values through the general Configuration file, as described below. When the Global IP Setting is automatically created, parameters are set with the default values defined in TeemIp's data model. It is however possible to overload these default values through the general Configuration file, as described below.
-===== 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 "Modules specific settings" part, under the **teemip-ip-mgmt** block. This block hosts different set of parameters dedicated to different TeemIps features. 
- 
-<code> 
- 'teemip-ip-mgmt' => array ( 
- 'feature_1' => array ( 
-   ... 
- ), 
- ... 
- 'feature_n' => array ( 
-   ... 
- ), 
- ), 
-</code> 
- 
-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:datamodel:ip-settings#global_ip_settings_properties|here above]] can be reset but only the ones that need to be overwritten should sit here. 
- 
-The structure of the block is as follows: 
- 
- 
-^  Name  ^  Type  ^  Allowed values  ^  Description  ^ 
-| enabled | Boolean | true, false | 
-| **core_parameters** ||| 
-| ... | All attributes that do not belong to a Teemip extension ||| 
-| **ip_request_parameters** ||| 
-| ... | All attributes defined in [[extensions:teemip-request-mgmt|TeemIp Request Management]] ||| 
-| **zone_parameters** ||| 
-| ... | All attributes defined in [[extensions:teemip-zone-mgmt|DNS Zone Management]] ||| 
- 
-In the following example, only parameter 'request_creation_ipv4_offset' will be changed to 5 where its defaults value is 0. 
- 
-<code> 
- 'default_global_ip_settings' => array ( 
-   'enabled' => true, 
-   'ip_request_parameters' =>  
-   array ( 
-     'request_creation_ipv4_offset' => 5, 
-   ), 
- ), 
- 
-</code> 
- 
-==== IP Address Navigation ==== 
-This block defines how one can navigate between adjacent IPs, a feature described in the [[2_x:datamodel:ip-addresses#navigating_between_adjacent_ips|IP Address]] chapter. It holds the following parameter: 
- 
-^  Name  ^  Type  ^  Allowed values  ^ Description ^ 
-| enabled | Boolean | true, false | Enable the block | 
-| within_subnet_only | Boolean | true, false | Limit the navigation within the subnet the IP belongs to | 
- 
-Example: 
- 
-<code> 
- 'ip_navigation' => array ( 
-   'enabled' => true, 
-   'within_subnet_only' => true, 
- ), 
-</code> 
- 
-==== 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 the specific 'ip_release_on_ci_status' 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 | 
-| status_list | Array | List of valid statuses for the CIs | Defines the CI statuses under which the IP should be considered as released | 
- 
- 
-<code> 
- 'ip_release_on_ci_status' => array ( 
-   'enabled' => false, 
-   'debug' => false, 
-   'periodicity' => 3600, 
-   'status_list' =>  
-   array ( 
-     0 => 'obsolete', 
-   ), 
- ), 
-</code> 
- 
- 
-==== 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 the specific 'ip_allocate_on_ci_status' 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 | 
-| status_list | Array | List of valid statuses for the CIs | Defines the CI statuses under which the IP should be considered as allocated | 
- 
-<code> 
- 'ip_allocate_on_ci_status' => array ( 
-   'enabled' => false, 
-   'debug' => false, 
-   'periodicity' => 3600, 
-   'status_list' =>  
-   array ( 
-     0 => 'implementation', 
-     1 => 'production', 
-   ), 
- ), 
-</code> 
-==== Automatic IP Un-assignment ==== 
-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 ==== 
-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.1681393507.txt.gz · Last modified: 2023/04/13 15:45 by cnaud

Page Tools