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:subnets [2019/12/05 12:13] – [Tabs] cnaud | 2_x:datamodel:subnets [2023/09/13 17:41] – [Find space] cnaud | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Subnets ====== | ====== Subnets ====== | ||
- | {{classicon_ipv4subnet.png }} | + | {{icons8-subnet-48.png }} |
- | {{classicon_ipv6subnet.png }} | + | {{icons8-subnetv6-48.png }} |
- | Subnet objects in TeemIp represent standard | + | Subnets define |
Line 18: | Line 18: | ||
| Allocation date | Date (year-month-day) | No | | | Allocation date | Date (year-month-day) | No | | ||
| Release date | Date (year-month-day) | No | | | Release date | Date (year-month-day) | No | | ||
+ | | **Automation** ||| | ||
+ | | Allow automatic IP creation | Possible values: yes, no \\ Brought by the [[extensions: | ||
| **IP Information** ||| | | **IP Information** ||| | ||
| Subnet Block | Foreign key to a(n) Subnet Block | Yes | | | Subnet Block | Foreign key to a(n) Subnet Block | Yes | | ||
| Subnet IP | IPv4 or IPv6 Address | Yes | | | Subnet IP | IPv4 or IPv6 Address | Yes | | ||
- | | Mask (for IPv4) | Possible values : from /16 down to /32 | Yes | | + | | Mask | Possible values:\\ - from /16 down to /32 for IPv4 \\ - from /64 down to /128 for IPv6 | Yes | |
- | | Mask (for IPv6) | Possible values : from /64 down to /128 | Yes | | + | |
| Gateway IP | IPv4 or IPv6 Address | No | | | Gateway IP | IPv4 or IPv6 Address | No | | ||
- | | Broadcast IP | IPv4 or IPv6 Address | No | | + | | Broadcast IP (for IPv4 only) | IPv4 Address | No | |
< | < | ||
- | * "Broadcast IP" | + | * IPv4 **Broadcast IP** is automatically calculated as the Subnet IP - 1 |
- | * "Gateway IP" | + | * **Gateway IP** is set in alignment with the default settings for subnets defined in the [[2_x: |
</ | </ | ||
<note tip> | <note tip> | ||
- | The attribute | + | The attribute |
* allocated: subnet is in use | * allocated: subnet is in use | ||
- | * released: subnet is not in use anymore and can be re-allocated if required | + | * released: subnet is not in use anymore and can be re-allocated if required. IPs of released subnets may be automatically released as well according to the [[2_x: |
* reserved: subnet is not in use yet but will be allocated (activated) at a point in time | * reserved: subnet is not in use yet but will be allocated (activated) at a point in time | ||
* unassigned: subnet exists in TeemIp without any clear status | * unassigned: subnet exists in TeemIp without any clear status | ||
Line 40: | Line 41: | ||
==== Tabs ==== | ==== Tabs ==== | ||
^ Tab ^ Description | ^ Tab ^ Description | ||
- | | Locations | All the Locations for this IP Object | + | | Global Settings | Settings defined for the subnet' |
- | | Contacts | All the contacts for this IP Object | + | | 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 | ||
+ | | Contacts | All the known contacts for the subnet | ||
| Documents | All the documents linked to this IP Object | | | Documents | All the documents linked to this IP Object | | ||
+ | | NAT Subnets | All other Subnets linked to this Subnet in a NAT relationship | | ||
| VLANs | VLANs hosting the subnet | | | VLANs | VLANs hosting the subnet | | ||
| VRFs | VRFs hosting the subnet | | | VRFs | VRFs hosting the subnet | | ||
+ | | Notifications | List of related notifications - Present if a notification trigger exists for that class | | ||
| 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 | | ||
- | | History | + | | IP Requests | IP requests related to the subnet. Brought by the [[extensions: |
+ | | Activity panel | History of all changes made to the subnet block | | ||
==== Listing Subnets ==== | ==== Listing Subnets ==== | ||
- | The Subnets shortcuts | + | The Subnets shortcuts |
+ | |||
+ | {{ classlist_ipv4subnet-3x.png }} | ||
- | {{ classlist_ipv4subnet.png }} | + | {{ classlist_ipv6subnet-3x.png }} |
- | {{ classlist_ipv6subnet.png }} | + | |
- | The "Registered IPs" | + | The **Registered IPs** column gives the percentage of the subnet that is already consumed by all the IP Ranges and IPs within the subnet. This information is not provided for IPv6 subnets due to their very large size. |
<note tip> | <note tip> | ||
- | The Search tab will shorten the list according to the filtering elements you'll define in it. | + | The Search tab will, of course, |
</ | </ | ||
==== Displaying Tree ==== | ==== Displaying Tree ==== | ||
Display can be switch from the listing view to tree view through the " | Display can be switch from the listing view to tree view through the " | ||
- | {{ details-popup-menu-subnetdisplaytree.png }} | + | {{ details-popup-menu-subnetdisplaytree-3x.png }} |
The tree view displays all subnets as well as all subnet blocks. When no default organization is selected, a tree per existing organization is displayed. Otherwise, only the tree that corresponds to the selected organization is displayed. | The tree view displays all subnets as well as all subnet blocks. When no default organization is selected, a tree per existing organization is displayed. Otherwise, only the tree that corresponds to the selected organization is displayed. | ||
- | {{ classtree_ipv4subnet.png }} | + | {{ classtree_ipv4subnet-3x.png }} |
Display can be switched back to the listing view through the " | Display can be switched back to the listing view through the " | ||
- | {{ details-popup-menu-subnetdisplaylist.png }} | + | {{ details-popup-menu-subnetdisplaylist-3x.png }} |
==== 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" | + | A subnet calculator tool is available from the tool menu of subnet lists and subnet trees as well as from the "Other Actions" |
- | {{ calculator_ipv4subnet.png }} | + | {{ calculator_ipv4subnet-3x.png }} |
{{ calculator_ipv6subnet.png }} | {{ calculator_ipv6subnet.png }} | ||
Line 93: | 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 106: | 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: | ||
+ | * the one that corresponds to the computed subnet, | ||
+ | * the one that corresponds to the previous subnet, | ||
+ | * the one that corresponds to the next subnet. | ||
==== 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? |
- | {{ 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: | ||
- | * A subnet must be CIDR aligned. | + | * A subnet must be CIDR aligned, |
- | * A subnet cannot share any space with another subnet. In particular, it cannot contain any other subnet and cannot be contained in a subnet. | + | * A subnet cannot share any space with another subnet. In particular, it cannot contain any other subnet and cannot be contained in a subnet, |
- | * Mask for IPv4 subnets must be contained within /16 - /32 | + | * Mask for IPv4 subnets must be contained within /16 - /32, |
- | * Mask for IPv6 subnets must be contained within /64 - /128 | + | * Mask for IPv6 subnets must be contained within /64 - /128, |
+ | * If not set, “Subnet Block” is automatically computed when “Subnet IP” and “Mask” are defined, | ||
+ | * According to the " | ||
- | 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: | + | At creation time, global settings “Reserve Subnet, Gateway |
- | + | ||
- | < | + | |
- | " | + | |
- | </ | + | |
==== Modifying a Subnet ==== | ==== Modifying a Subnet ==== | ||
- | From the detailed view of a subnet, click on the “Modify” | + | From the detailed view of a subnet, click on the {{pen-icon.png? |
- | 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> | ||
Line 135: | Line 145: | ||
Next to standard actions, a set of specific actions can be applied to subnets. These can be found in the "Other Actions" | Next to standard actions, a set of specific actions can be applied to subnets. These can be found in the "Other Actions" | ||
- | {{ details-popup-menu-subnetotheractions.png }} | + | {{ details-popup-menu-subnetotheractions-3x.png }} |
<note important> | <note important> | ||
Line 146: | Line 156: | ||
==== 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 160: | Line 170: | ||
* 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 | + | When clicking the **Apply** button, the shrink action is launched |
- | + | ||
- | {{ 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 180: | Line 188: | ||
* 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" | + | 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> | <note warning> | ||
Line 209: | Line 217: | ||
- | When clicking the "Apply" | + | When clicking the **Apply** button, the expand action is launched |
- | {{ 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. |
< | < | ||
Line 220: | Line 227: | ||
</ | </ | ||
- | {{ classlistips1_ipv6subnet.png }} | + | {{ classlistips1_ipv6subnet-3x.png }} |
- | Clicking on "Apply" | + | 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 " | + | 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}}, | All ranges offered can be transformed as IP ranges. By clicking the appropriate {{ipmini-add-xs.png}}, |