Differences

This shows you the differences between two versions of the page.

--- 2_x:datamodel:subnet-blocks [2018/11/02 15:01] – [Find Space] cnaud
+++ 2_x:datamodel:subnet-blocks [2019/12/05 12:05] – [Delegate] cnaud
@@ Line 1: / Line 1: @@
+====== Subnet Blocks ======
+{{classicon_ipv4subnetblock.png  }}
+{{classicon_ipv6subnetblock.png  }}
+Subnet blocks are hierarchical containers which main purpose is to model the IPv4 and IPv6 plans of a company or organization. They represent big chunks of IP space allocated to a geographical entity (region, country…) or reserved for given usage (WAN, Data Centre LAN, Office space…). They can hold subnet blocks or subnets.
+==== Subnet Block Properties ====
+^  Name  ^  Type  ^  Mandatory?  ^
+| **General Information** |||
+| Organization | Foreign key to a(n) Organization | Yes |
+| Delegated from | Foreign key to a(n) Organization | No |
+| Parent | Foreign key to a(n) Subnet Block | No |
+| Name | Alphanumeric string  | Yes |
+| Type | Alphanumeric string  | No |
+| Note | Multiline character string  | No |
+| Requestor | Foreign key to a(n) Person | No |
+| Allocation date | Date (year-month-day) | No |
+| **IP Information** |||
+| First IP | IPv4 or IPv6 Address | Yes |
+| Last IP | IPv4 or IPv6 Address | Yes |
+==== Tabs ====
+^  Tab  ^  Description  ^
+| Locations | All the Locations for this IP Object |
+| Contacts | All the contacts for this IP Object |
+| Documents | All the documents linked to this IP Object |
+| Child Blocks | Subnet blocks strictly contained within the block |
+| Subnets | Subnets belonging to the subnet block |
+| History | History of all changes made to the subnet block |
+==== Listing Subnet Blocks ====
+The Subnet Blocks shortcuts of the IP Management module on the explorer menu display all the IPv4 or IPv6 subnet blocks of the selected organization or all IPv4 or IPv6 subnet blocks if no organization is selected.
+{{ classlist_ipv4subnetblock.png }}
+{{ classlist_ipv6subnetblock.png }}
+The "Space Used" column gives the percentage of the subnet block that is already consumed by all the subnet blocks and the subnets attached to that block.
+<note tip>
+The Search tab will shorten the list according to the filtering elements you'll define in it.
+</note>
+==== Displaying Tree ====
+Display can be switch from the listing view to tree view through the "Display Tree" action in the tool menu.
+{{ details-popup-menu-blockdisplaytree.png }}
+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_ipv4subnetblock.png }}
+Display can be switched back to the listing view through the "Display List" action available in the tool menu.
+{{ details-popup-menu-blockdisplaylist.png }}
+==== Creating a new Subnet Block ====
+From the listing or tree view, click on the "New..." menu to display the creation form.
+{{ classcreate_ipv4subnetblock.png }}
+An implicit but intuitive set of rules must be followed when a subnet block is created:
+  * A subnet block belongs to a unique organization
+  * A subnet block can be fully contained within another subnet block. We talk, then, about child block or parent block.
+  * Two blocks cannot share the same name
+  * Two blocks cannot share common IP space unless one is fully contained within the other.
+  * Minimum size of a subnet block is defined by the global parameter "Minimum size of IPv4 / IPv6 Subnet Blocks"
+  * According to the global parameter “Align IPv4 / IPv6 Subnet Blocks to CIDR”, a subnet block needs to be CIDR aligned or not.
+At creation time, global settings “Minimum size of IPv4 / IPv6 Subnet Blocks” and “Align IPv4 / IPv6 Subnet Blocks to CIDR” 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 parameters. If it is required to change them globally, these can be changed through the [[2_x:datamodel:ip-settings|Global IP Settings]] menu of the Data Administration module.
+<note>
+Global IP Settings being unique for each organization, the "Global Settings" tab will appear only if an organization has been selected at the top of the explorer menu.
+</note>
+<note tip>
+For IPv6 blocks, a simple autocompletion mechanism is used to help typing the Last IP: its first 64 bits are copied from the first IP and its last 64 bits are set to 1... which can, of course, be manually changed by the user.
+</note>
+==== Modifying a Subnet Block ====
+From the detailed view of a subnet block, click on the "Modify" button.
+Only a few parameters can be changed here: Name, Type, Note, Requestor, Allocation date, Locations, Contacts and Documents.
+==== Other Actions ====
+Next to standard actions, a set of specific actions can be applied to subnet blocks. These can be found in the "Other Actions" menu available from the details page.
+{{ details-popup-menu-blockotheractions.png }}
+These specific actions are described in below chapters.
+==== Delegate ====
+A block belonging to an organization can be delegated to another organization. This can only be done if the block already exists. Delegation is not available at creation time anymore. Conditions to delegate a subnet block are:
+  * The block doesn't contain any child block nor subnet
+  * The block doesn't collide with any other subnet block already created in the target organization
+By default, a block can only be delegated to a child organization. However, this restriction can be lifted through the [[2_x:datamodel:ip-settings|Global IP Settings]].
+In order to delegate a subnet block, click on the "Delegate" action of the "Other Actions" menu. The following display appears:
+{{ classdelegate_subnetblock.png }}
+If all delegation conditions are met, subnet block is effectively delegated once the "Apply" button is pressed.
+==== Un-Delegate ====
+A delegated block can be returned to its original owner organization with the "Un-delegate" action. Condition to remove a delegation on a subnet block is that the block doesn't contain any child block nor subnet.
+In order to un-delegate a subnet block, just click on the “Un-delegate” action of the “Other Actions” menu. If above condition is met, delegation will be removed straight away.
+==== Shrink ====
+The "Shrink" action available from the "Other Actions" menu allows you to reduce the size of a subnet block. When selected, the following page is displayed:
+{{ classshrink_ipv4subnetblock.png }}
+The 3 first lines recall the main characteristics of the subnet block. Other lines list the attributes that can be changed:
+^  Name  ^  Type  ^  Mandatory?  ^
+| Requestor | Foreign key to a(n) Person | No |
+| New First IP of Block | IPv4 or IPv6 Address | Yes |
+| New Last IP of Block	| IPv4 or IPv6 Address | Yes |
+The rules used at creation time apply here as well. On top of them, the shrink action follows its own set of rules:
+  * New subnet block must be strictly contained within the border of the current subnet block.
+  * One or several child subnet blocks can be dropped during the operation. In that case, the child blocks will be attached to the parent block or to no parent block if none exists.
+  * One or several subnets can be dropped during the operation. However, this may happen only if they can be attached to an existing parent block.
+  * The change won’t be applied if a child subnet block or a subnet contained within the block sits across the new borders of the subnet block.
+  * A delegated block cannot be shrunk.
+"Global Settings" tab allows global setting related to subnet blocks to be changed for the operation and for that operation only.
+==== Split ====
+The "Split" action available from the "Other Actions" menu allows you to split a subnet block into 2 blocks. When selected, the following page is displayed:
+{{ classsplit_ipv4subnetblock.png }}
+The 3 first lines recall the main characteristics of the subnet block. Other lines list the attributes that can be changed:
+^  Name  ^  Type  ^  Mandatory?  ^
+| Requestor | Foreign key to a(n) Person | No |
+| First IP of new Subnet Block | IPv4 or IPv6 Address | Yes |
+| Name of new Subnet Block | Alphanumeric string | Yes |
+The rules used at creation time apply here as well. On top of them, the split action follows its own set of rules:
+  * The change won’t be applied if a child subnet block or a subnet contained within the block sits across the new borders of the two subnet blocks.
+  * A delegated block cannot be split.
+"Global settings" tab allows global setting related to subnet blocks to be changed for the operation and for that operation only.
+==== Expand ====
+The "Expand" action available from the "Other Actions" menu allows you to increase the size of a subnet block. When selected, the following page is displayed:
+{{ classexpand_ipv6subnetblock.png }}
+The 3 first lines recall the main characteristics of the subnet block. Other lines list the attributes that can be changed:
+^  Name  ^  Type  ^  Mandatory?  ^
+| Requestor | Foreign key to a(n) Person | No |
+| New First IP of Block | IPv4 or IPv6 Address | Yes |
+| New Last IP of Block	| IPv4 or IPv6 Address | Yes |
+The rules used at creation time apply here as well. On top of them, the expand action follows its own set of rules:
+  * New first IP must be smaller than current first IP of subnet block
+  * New last IP must be higher than current last IP of subnet block
+  * All subnet blocks contained within the expanded block will be absorbed by it.
+  * The change won’t be applied if an existing subnet block or a subnet has conflicting borders with the new expanded block (i.e. is not fully contained or fully outside new expanded block).
+  * A delegated block cannot be expanded.
+Global settings tab allows global setting related to subnet blocks to be changed for the operation and for that operation only.
+==== List Space ====
+The "List Space" action available from the "Other Actions" menu will simply list, in numerical order, the child subnet blocks and subnets contained within the subnet block. It will list as well the free spaces contained between the child objects with information on their size.
+{{ classlistspace_ipv4subnetblock.png }}
+<note>
+Details of child objects (subnet blocks or subnets) can be displayed by simply clicking on their name.
+</note>
+==== Find Space ====
+This "Find Space" action available from the "Other Actions" menu helps IP administrator to find free space of a given size within a subnet block and to allocate it if required. When selected, the following page is displayed:
+{{ classfindspace1_ipv4subnetblock.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 only CIDR aligned space can be searched within a subnet block.
+Once parameters are chosen, hitting the "Apply" button will trigger the search action. The result is then displayed in a list format:
+{{ classfindspace2_ipv4subnetblock.png }}
+All ranges offered can be transformed into a subnet block or a subnet. By clicking the appropriate "+", 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.
+<note>
+No block will be offered for creation if the size requested is smaller than the minimum block sized defined in the configuration parameters. Similarly, no subnet will be offered for creation if the size requested is larger than the maximum subnet size (/16 for IPv4 subnets and /64 for IPv6 ones).
+</note>

Documentation

User Tools

Site Tools

Differences

Page Tools