Documentation

User Tools

Site Tools

Trace:
2_x:datamodel:subnets

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:subnets [2023/09/12 21:00] – [Displaying Tree] cnaud2_x:datamodel:subnets [2024/01/26 17:29] (current) – [Modifying a Subnet] cnaud
Line 19: Line 19:
 | Release date | Date (year-month-day) | No | | Release date | Date (year-month-day) | No |
 | **Automation** ||| | **Automation** |||
 +| Allow automatic IP creation | Possible values: yes, no \\ Brought by the [[extensions:teemip-request-mgmt|IP Request Management]] extension | No |
 | **IP Information** ||| | **IP Information** |||
 | Subnet Block | Foreign key to a(n) Subnet Block | Yes | | Subnet Block | Foreign key to a(n) Subnet Block | Yes |
Line 41: Line 42:
 ^  Tab  ^  Description  ^ ^  Tab  ^  Description  ^
 | Global Settings | Settings defined for the subnet's organization and values used at creation time | | Global Settings | Settings defined for the subnet's organization and values used at creation time |
-| Summary * | Editable dashboard * | +| Summary | Editable dashboard \\ Provides, by default, statistics on the registered IPs. This dashlet may be changed on a per user basis, like any other daslhet. | 
 | Locations | All the Locations for the subnet | | Locations | All the Locations for the subnet |
 | Contacts | All the known contacts for the subnet | | Contacts | All the known contacts for the subnet |
Line 51: Line 52:
 | Registered IPs | IP addresses belonging to the subnet | | Registered IPs | IP addresses belonging to the subnet |
 | IP Ranges | IP Ranges containted within the subnet | | IP Ranges | IP Ranges containted within the subnet |
-| IP Requests | IP requests related to the subnet. Requires the [[extensions:teemip-request-mgmt|IP Request Management]] extension |+| IP Requests | IP requests related to the subnet. Brought by the [[extensions:teemip-request-mgmt|IP Request Management]] extension |
 | Activity panel | History of all changes made to the subnet block | | Activity panel | History of all changes made to the subnet block |
- 
-*  Provides, by default, statistics on the registered IPs. This dashlet may be changed on a per user basis, like any other daslhet. 
  
 ==== Listing Subnets ==== ==== Listing Subnets ====
Line 83: Line 82:
  
 ==== Subnet Calculator ==== ==== Subnet Calculator ====
-A subnet calculator tool is available from the tool menu of subnet lists and subnet trees as well as from the "Other Actions" menu of the subnet details display. This utility greatly helps network computations using IP address, subnet mask or mask bits for IPv4 subnets and IP address and mask bits for IPv6 subnets. Note that you can access the calculator directly from the IP Management menu, under the "Tools" shortcut.+A subnet calculator tool is available from the tool menu of subnet lists and subnet trees as well as from the **Other Actions** menu of the subnet details display. This utility greatly helps network computations using IP address, subnet mask or mask bits for IPv4 subnets and IP address and mask bits for IPv6 subnets. Note that you can as well access the calculator directly from the IP Management menu, under the "Tools" shortcut.
  
-{{ calculator_ipv4subnet.png }} +{{ calculator_ipv4subnet-3x.png }} 
-{{ calculator_ipv6subnet.png }}+{{ calculator_ipv6subnet-3x.png }}
  
 Once required information is entered, IPv4 calculation provides : Once required information is entered, IPv4 calculation provides :
Line 100: Line 99:
   * Next Subnet IP   * Next Subnet IP
  
-{{ calculator_output_ipv4subnet.png }}+{{ calculator_output_ipv4subnet-3x.png }}
  
 And IPv6 calculation provides:  And IPv6 calculation provides: 
Line 113: Line 112:
   * Next Subnet IP   * Next Subnet IP
    
-{{ calculator_output_ipv6subnet.png }}+{{ calculator_output_ipv6subnet-3x.png }}
  
 In both cases, the tool will offer the possibility to create 3 subnet blocks and / or 3 subnets: In both cases, the tool will offer the possibility to create 3 subnet blocks and / or 3 subnets:
Line 122: Line 121:
  
 ==== Creating a new Subnet ==== ==== Creating a new Subnet ====
-From the listing or tree view, click on the “New…” menu to display the creation form.+From the listing or tree view or from any create action of a subnet badge, click on the {{plus-button.png?nolink|Edit icon}} to display the creation form.
  
-{{ classcreate_ipv6subnet.png }}+{{ classcreate_ipv6subnet-3x.png }}
    
 An implicit but intuitive set of rules must be followed when a subnet is created: An implicit but intuitive set of rules must be followed when a subnet is created:
Line 134: Line 133:
   * According to the "Symetrical Subnet NAT" parameter defined in [[2_x:datamodel:ip-settings|Global IP Settings]], symetrical NAT relations may be automatically created when subnets are added to the NAT tab.   * According to the "Symetrical Subnet NAT" parameter defined in [[2_x:datamodel:ip-settings|Global IP Settings]], symetrical NAT relations may be automatically created when subnets are added to the NAT tab.
  
-At creation time, global settings “Reserve Subnet and Broadcast IPs at Subnet Creation” can be overwritten. Note that a change on this parameter, if any, only applies to the current creation and don’t affect the value of the global parameter. If it is required to change them globally, this can be done through the [[2_x:datamodel:ip-settings|Global IP Settings]] menu.+At creation time, global settings “Reserve Subnet, Gateway and Broadcast IPs at Subnet Creation” and "Gateway IP" can be overwritten. Note that a change on these parameters, if any, only applies to the current creation and don’t affect the value of the global parameter. If it is required to change them globally, this can be done through the [[2_x:datamodel:ip-settings|Global IP Settings]] menu.
 ==== Modifying a Subnet ==== ==== Modifying a Subnet ====
-From the detailed view of a subnet, click on the “Modify” button.+From the detailed view of a subnet, click on the {{pen-icon.png?nolink|Edit icon}} button.
  
-The parameters that can be changed here are: Name, Status, Type, Note, Requestor, Release date as well as the lists of Locations, Contacts and Documents, VLANs and VRFs attached to the subnet.+The parameters that can be changed here are: Name, Status, Type, Note, Requestor, Allocation date, Release date as well as the lists of Locations, Contacts and Documents, VLANs and VRFs attached to the subnet.
  
 <note warning> <note warning>
 Subnet IP and size can only be changed on IPv4 subnets through the specific menus described below. Subnet IP and size can only be changed on IPv4 subnets through the specific menus described below.
 </note> </note>
 +
 +==== Navigating between adjacent Subnets ====
 +TeemIp provides an easy and efficient way to navigate between adjacent subnets. 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 subnet in TeemIp. This action is driven by default parameters that can be overwritten in the configuration file.
 +
 +<code>
 + 'teemip-ip-mgmt' => array (
 + ...
 + 'subnet_navigation' => array (
 +   'enabled' => true,
 +   'within_block_only' => false,
 + ),
 +                ...
 +        ),
 +
 +</code>
 +
 +^  Parameter  ^  Description  ^
 +| enabled| Enable or disable the function |
 +| within_block_only| Limit the navigation to the block that the subnet belongs to or not |
 ==== Other Actions ==== ==== Other Actions ====
 Next to standard actions, a set of specific actions can be applied to subnets. 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 subnets. These can be found in the "Other Actions" menu available from the details page.
  
-{{ details-popup-menu-subnetotheractions.png }}+{{ details-popup-menu-subnetotheractions-3x.png }}
  
 <note important> <note important>
Line 157: Line 175:
  
 ==== Shrink ==== ==== Shrink ====
-The “Shrink” action applies only to IPv4 subnets. It is available from the “Other Actions” menu and allows you to reduce the size of a subnet by 2, 4, 8 or 16. When selected, the following page is displayed:+The **Shrink** action applies only to IPv4 subnets. It is available from the **Other Actions** menu and allows you to reduce the size of a subnet by 2, 4, 8 or 16. When selected, the following page is displayed:
  
-{{ classshrink_ipv4subnet.png }}+{{ classshrink_ipv4subnet-3x.png }}
  
 The 3 first lines recall the main characteristics of the subnet. Other lines list the attributes that can be changed:  The 3 first lines recall the main characteristics of the subnet. Other lines list the attributes that can be changed: 
Line 171: Line 189:
   * All IP ranges included in the subnet must remain within the borders of the new subnet.   * All IP ranges included in the subnet must remain within the borders of the new subnet.
  
-When clicking the “Apply” button, the shrink action is launched. Result is displayed as follows: +When clicking the **Apply** button, the shrink action is launched and details on the resulting subnet is displayed.
- +
-{{ classshrink_result_ipv4subnet.png }}+
  
  
 ==== Split ==== ==== Split ====
-The “Split” action applies only to IPv4 subnets. It is available from the “Other Actions” menu and allows you to split a subnet in 2, 4, 8 or 16 subnets. When selected, the following page is displayed:+The **Split** action applies only to IPv4 subnets. It is available from the **Other Actions** menu and allows you to split a subnet in 2, 4, 8 or 16 subnets. When selected, the following page is displayed:
  
-{{ classsplit_ipv4subnet.png }}+{{ classsplit_ipv4subnet-3x.png }}
  
 The 3 first lines recall the main characteristics of the subnet. Other lines list the attributes that can be changed:  The 3 first lines recall the main characteristics of the subnet. Other lines list the attributes that can be changed: 
Line 191: Line 207:
   * All IP ranges included in the subnet must remain within the borders of the new subnets. None of them can sit across new subnets borders.   * All IP ranges included in the subnet must remain within the borders of the new subnets. None of them can sit across new subnets borders.
  
-When clicking the "Apply" button, the split action is launched. Result is displayed as follows:+When clicking the **Apply** button, the split action is launched. Result is displayed as follows:
  
-{{ classsplit_result_ipv4subnet.png }}+{{ classsplit_result_ipv4subnet-3x.png }}
  
  
 ==== Expand ==== ==== Expand ====
-The “Expand” action applies only to IPv4 subnets. It is available from the “Other Actions” menu and allows you to increase the size of a subnet. When selected, the following page is displayed:+The **Expand** action applies only to IPv4 subnets. It is available from the **Other Actions** menu and allows you to increase the size of a subnet. When selected, the following page is displayed:
  
-{{ classexpand_ipv4subnet.png }}+{{ classexpand_ipv4subnet-3x.png }}
  
 <note warning>This action may change the IP of the subnet: <note warning>This action may change the IP of the subnet:
Line 220: Line 236:
  
  
-When clicking the "Apply" button, the expand action is launched. Result is displayed as follows:+When clicking the **Apply** button, the expand action is launched and details on the resulting subnet is displayed.
  
-{{ classexpand_result_ipv4subnet.png }} 
  
 ==== List & Pick IPs ==== ==== List & Pick IPs ====
-The List & Pick IPs action simply lists, in numerical order, all the IP ranges and IP addresses hosted within a subnet. It lists as well the free IP addresses and provides the possibility to directly register one of them.+The **List & Pick IPs** action simply lists, in numerical order, all the IP ranges and IP addresses hosted within a subnet. It lists as well the free IP addresses and provides the possibility to directly register one of them.
  
 <note> <note>
Line 231: Line 246:
 </note>  </note> 
  
-{{ classlistips1_ipv6subnet.png }}+{{ classlistips1_ipv6subnet-3x.png }}
  
-Clicking on "Apply" will generate the list.+Clicking on **Apply** will generate the list.
  
-{{ classlistips2_ipv6subnet.png }}+{{ classlistips2_ipv6subnet-3x.png }}
  
 All free IPs can be created by clicking the appropriate {{ipmini-add-xs.png}} button. This will open a popup window where all IP details can be registered. If you don’t wish to proceed, the top right menus will lead you to your next page. All free IPs can be created by clicking the appropriate {{ipmini-add-xs.png}} button. This will open a popup window where all IP details can be registered. If you don’t wish to proceed, the top right menus will lead you to your next page.
  
 ==== Find space ==== ==== Find space ====
-This action helps IP administrator to find free space of a given size within an IPv4 or IPv6 subnet and to allocate it if required. When selected, the following page is displayed:+This action helps IP administrator to **find free space** of a given size within an IPv4 or IPv6 subnet and to allocate it if required. When selected, the following page is displayed:
  
-{{ classfindspace1_ipv4subnet.png }}+{{ classfindspace1_ipv4subnet-3x.png }}
  
 This screen allows you to select the size of the free space that you are looking for and the maximum number of offers that you want to receive. Note that offered space will not necessarily be CIDR aligned. First available space that matches will be offered. This screen allows you to select the size of the free space that you are looking for and the maximum number of offers that you want to receive. Note that offered space will not necessarily be CIDR aligned. First available space that matches will be offered.
    
-Once parameters are chosen, hitting the "apply"  button will trigger the search action. The result is then displayed in a list format:+Once parameters are chosen, hitting the **Apply ** button will trigger the search action. The result is then displayed in a list format:
  
-{{ classfindspace2_ipv4subnet.png }}+{{ classfindspace2_ipv4subnet-3x.png }}
  
 All ranges offered can be transformed as IP ranges. By clicking the appropriate {{ipmini-add-xs.png}}, you’ll open a window where you’ll be able to create the requested object. If you don’t wish to proceed, the top right menus will lead you to your next page. All ranges offered can be transformed as IP ranges. By clicking the appropriate {{ipmini-add-xs.png}}, you’ll open a window where you’ll be able to create the requested object. If you don’t wish to proceed, the top right menus will lead you to your next page.
Line 260: Line 275:
 </note>  </note> 
  
-{{ classcsvips1_ipv4subnet.png }}+{{ classcsvips1_ipv4subnet-3x.png }}
  
 Next to the attributes of an IP address, additional information fields are exported with each IP address: Next to the attributes of an IP address, additional information fields are exported with each IP address:
2_x/datamodel/subnets.1694545227.txt.gz · Last modified: 2023/09/12 21:00 by cnaud

Page Tools